Amazon Audit Manager Frameworks API

openapi: 3.1.0
info:
  title: AWS Audit Manager Frameworks API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Audit Manager. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://auditmanager.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /assessmentFrameworks:
    post:
      operationId: CreateAssessmentFramework
      summary: Create Assessment Framework
      description: Creates a custom framework in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssessmentFrameworkResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAssessmentFrameworkRequest'
      tags:
      - Frameworks
    get:
      operationId: ListAssessmentFrameworks
      summary: List Assessment Frameworks
      description: Returns a list of the frameworks that are available in the Audit Manager framework library.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssessmentFrameworksResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssessmentFrameworksRequest'
      tags:
      - Frameworks
  /assessmentFrameworks/{frameworkId}:
    delete:
      operationId: DeleteAssessmentFramework
      summary: Delete Assessment Framework
      description: Deletes a custom framework in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssessmentFrameworkResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAssessmentFrameworkRequest'
      tags:
      - Frameworks
    get:
      operationId: GetAssessmentFramework
      summary: Get Assessment Framework
      description: Gets information about a specified framework.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAssessmentFrameworkResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAssessmentFrameworkRequest'
      tags:
      - Frameworks
    put:
      operationId: UpdateAssessmentFramework
      summary: Update Assessment Framework
      description: Updates a custom framework in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAssessmentFrameworkResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAssessmentFrameworkRequest'
      tags:
      - Frameworks
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: auditmanager
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AssessmentFrameworkMetadata:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the framework.
        id:
          type: string
          description: The unique identifier for the framework.
        type:
          type: string
          enum:
          - Standard
          - Custom
          description: The framework type, such as a standard framework or a custom framework.
        name:
          type: string
          description: The name of the framework.
        description:
          type: string
          description: The description of the framework.
        logo:
          type: string
          description: The logo that's associated with the framework.
        complianceType:
          type: string
          description: The compliance type that the new custom framework supports, such as CIS or HIPAA.
        controlsCount:
          type: integer
          description: The number of controls that are associated with the framework.
        controlSetsCount:
          type: integer
          description: The number of control sets that are associated with the framework.
        createdAt:
          type: string
          format: date-time
          description: The time when the framework was created.
        lastUpdatedAt:
          type: string
          format: date-time
          description: The time when the framework was most recently updated.
    Control:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the control.
        id:
          type: string
          description: The unique identifier for the control.
        type:
          type: string
          enum:
          - Standard
          - Custom
          - Core
          description: Specifies whether the control is a standard control or a custom control.
        name:
          type: string
          description: The name of the control.
        description:
          type: string
          description: The description of the control.
        testingInformation:
          type: string
          description: The steps that you should follow to determine if the control has been satisfied.
        actionPlanTitle:
          type: string
          description: The title of the action plan for remediating the control.
        actionPlanInstructions:
          type: string
          description: The recommended actions to carry out if the control isn't fulfilled.
        controlSources:
          type: string
          description: The data source types that determine where Audit Manager collects evidence from for the control.
        controlMappingSources:
          type: array
          items:
            $ref: '#/components/schemas/ControlMappingSource'
          description: The data mapping sources for the control.
        createdAt:
          type: string
          format: date-time
          description: The time when the control was created.
        lastUpdatedAt:
          type: string
          format: date-time
          description: The time when the control was most recently updated.
        createdBy:
          type: string
          description: The user or role that created the control.
        lastUpdatedBy:
          type: string
          description: The user or role that most recently updated the control.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags associated with the control.
        state:
          type: string
          enum:
          - ACTIVE
          - END_OF_SUPPORT
          description: The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state
            indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating
            or maintaining that control.
    ControlMappingSource:
      type: object
      properties:
        sourceId:
          type: string
          description: The unique identifier for the source.
        sourceName:
          type: string
          description: The name of the source.
        sourceDescription:
          type: string
          description: The description of the source.
        sourceSetUpOption:
          type: string
          enum:
          - System_Controls_Mapping
          - Procedural_Controls_Mapping
          description: The setup option for the data source. This option reflects if the evidence collection method is automated
            or manual. If you don’t provide a value for sourceSetUpOption, Audit Manager automatically infers and populates
            the correct value based on the sourceType that you specify.
        sourceType:
          type: string
          enum:
          - AWS_Cloudtrail
          - AWS_Config
          - AWS_Security_Hub
          - AWS_API_Call
          - MANUAL
          - Common_Control
          - Core_Control
          description: Specifies which type of data source is used to collect evidence. The source can be an individual data
            source type, such as AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, or MANUAL. The source can also
            be a managed grouping of data sources, such as a Core_Control or a Common_Control.
        sourceKeyword:
          $ref: '#/components/schemas/SourceKeyword'
        sourceFrequency:
          type: string
          enum:
          - DAILY
          - WEEKLY
          - MONTHLY
          description: Specifies how often evidence is collected from the control mapping source.
        troubleshootingText:
          type: string
          description: The instructions for troubleshooting the control.
    ControlSet:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the control set in the assessment. This is the control set name in a plain string
            format.
        name:
          type: string
          description: The name of the control set.
        controls:
          type: array
          items:
            $ref: '#/components/schemas/Control'
          description: The list of controls within the control set.
    CreateAssessmentFrameworkControl:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the control.
      required:
      - id
    CreateAssessmentFrameworkControlSet:
      type: object
      properties:
        name:
          type: string
          description: The name of the control set.
        controls:
          type: array
          items:
            $ref: '#/components/schemas/CreateAssessmentFrameworkControl'
          description: The list of controls within the control set. This doesn't contain the control set ID.
      required:
      - name
    CreateAssessmentFrameworkRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the new custom framework.
        description:
          type: string
          description: An optional description for the new custom framework.
        complianceType:
          type: string
          description: The compliance type that the new custom framework supports, such as CIS or HIPAA.
        controlSets:
          type: array
          items:
            $ref: '#/components/schemas/CreateAssessmentFrameworkControlSet'
          description: The control sets that are associated with the framework. The Controls object returns a partial response
            when called through Framework APIs. For a complete Controls object, use GetControl.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that are associated with the framework.
      required:
      - name
      - controlSets
    CreateAssessmentFrameworkResponse:
      type: object
      properties:
        framework:
          $ref: '#/components/schemas/Framework'
    DeleteAssessmentFrameworkRequest:
      type: object
      properties:
        frameworkId:
          type: string
          description: The identifier for the custom framework.
      required:
      - frameworkId
    DeleteAssessmentFrameworkResponse:
      type: object
      properties: {}
    Framework:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the framework.
        id:
          type: string
          description: The unique identifier for the framework.
        name:
          type: string
          description: The name of the framework.
        type:
          type: string
          enum:
          - Standard
          - Custom
          description: Specifies whether the framework is a standard framework or a custom framework.
        complianceType:
          type: string
          description: The compliance type that the framework supports, such as CIS or HIPAA.
        description:
          type: string
          description: The description of the framework.
        logo:
          type: string
          description: The logo that's associated with the framework.
        controlSources:
          type: string
          description: The control data sources where Audit Manager collects evidence from. This API parameter is no longer
            supported.
        controlSets:
          type: array
          items:
            $ref: '#/components/schemas/ControlSet'
          description: The control sets that are associated with the framework. The Controls object returns a partial response
            when called through Framework APIs. For a complete Controls object, use GetControl.
        createdAt:
          type: string
          format: date-time
          description: The time when the framework was created.
        lastUpdatedAt:
          type: string
          format: date-time
          description: The time when the framework was most recently updated.
        createdBy:
          type: string
          description: The user or role that created the framework.
        lastUpdatedBy:
          type: string
          description: The user or role that most recently updated the framework.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that are associated with the framework.
    GetAssessmentFrameworkRequest:
      type: object
      properties:
        frameworkId:
          type: string
          description: The identifier for the framework.
      required:
      - frameworkId
    GetAssessmentFrameworkResponse:
      type: object
      properties:
        framework:
          $ref: '#/components/schemas/Framework'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListAssessmentFrameworksRequest:
      type: object
      properties:
        frameworkType:
          type: string
          enum:
          - Standard
          - Custom
          description: The type of framework, such as a standard framework or a custom framework.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
        maxResults:
          type: integer
          description: Represents the maximum number of results on a page or for an API request call.
      required:
      - frameworkType
    ListAssessmentFrameworksResponse:
      type: object
      properties:
        frameworkMetadataList:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentFrameworkMetadata'
          description: A list of metadata that the ListAssessmentFrameworks API returns for each framework.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The unique identifier for the resource.
        resourceType:
          type: string
          description: The type of resource that's affected by the error.
      required:
      - message
      - resourceId
      - resourceType
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    SourceKeyword:
      type: object
      properties:
        keywordInputType:
          type: string
          enum:
          - SELECT_FROM_LIST
          - UPLOAD_FILE
          - INPUT_TEXT
          description: The input method for the keyword. SELECT_FROM_LIST is used when mapping a data source for automated
            evidence. When keywordInputType is SELECT_FROM_LIST, a keyword must be selected to collect automated evidence.
            For example, this keyword can be a CloudTrail event name, a rule name for Config, a Security Hub CSPM control,
            or the name of an Amazon Web Services API call. UPLOAD_FILE and INPUT_TEXT are only used when mapping a data source
            for manual evidence. When keywordInputType is UPLOAD_FILE, a file must be uploaded as manual evidence. When keywordInputType
            is INPUT_TEXT, text must be entered a
        keywordValue:
          type: string
          description: 'The value of the keyword that''s used when mapping a control data source. For example, this can be
            a CloudTrail event name, a rule name for Config, a Security Hub CSPM control, or the name of an Amazon Web Services
            API call. If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the
            type of rule: For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier
            from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For
            example, the rule name restricted-ssh has t'
    UpdateAssessmentFrameworkControlSet:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the control set.
        name:
          type: string
          description: The name of the control set.
        controls:
          type: array
          items:
            $ref: '#/components/schemas/CreateAssessmentFrameworkControl'
          description: The list of controls that are contained within the control set.
      required:
      - name
      - controls
    UpdateAssessmentFrameworkRequest:
      type: object
      properties:
        frameworkId:
          type: string
          description: The unique identifier for the framework.
        name:
          type: string
          description: The name of the framework to be updated.
        description:
          type: string
          description: The description of the updated framework.
        complianceType:
          type: string
          description: The compliance type that the new custom framework supports, such as CIS or HIPAA.
        controlSets:
          type: array
          items:
            $ref: '#/components/schemas/UpdateAssessmentFrameworkControlSet'
          description: The control sets that are associated with the framework. The Controls object returns a partial response
            when called through Framework APIs. For a complete Controls object, use GetControl.
      required:
      - frameworkId
      - name
      - controlSets
    UpdateAssessmentFrameworkResponse:
      type: object
      properties:
        framework:
          $ref: '#/components/schemas/Framework'
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The reason the request failed validation.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that caused the error, if applicable.
      required:
      - message
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation error.
        message:
          type: string
          description: The body of the error message.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/auditmanager/service/2017-07-25/auditmanager-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)