Amazon Audit Manager

Amazon Audit Manager Assessments API

Operations for creating and managing compliance assessments

Documentation GitHub OpenAPI

Business capability

Audit Execution Management BC-140.20

Operations 6

POST /assessments Create Assessment #

GET /assessments List Assessments #

DELETE /assessments/{assessmentId} Delete Assessment #

GET /assessments/{assessmentId} Get Assessment #

PUT /assessments/{assessmentId} Update Assessment #

PUT /assessments/{assessmentId}/status Update Assessment Status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-audit-manager:amazon-audit-manager-assessments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWS Audit Manager Assessments API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Audit Manager. 6 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:
  /assessments:
    post:
      operationId: CreateAssessment
      summary: Create Assessment
      description: Creates an assessment in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssessmentResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAssessmentRequest'
      tags:
      - Assessments
    get:
      operationId: ListAssessments
      summary: List Assessments
      description: Returns a list of current and past assessments from Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssessmentsResponse'
        '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/ListAssessmentsRequest'
      tags:
      - Assessments
  /assessments/{assessmentId}:
    delete:
      operationId: DeleteAssessment
      summary: Delete Assessment
      description: Deletes an assessment in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssessmentResponse'
        '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/DeleteAssessmentRequest'
      tags:
      - Assessments
    get:
      operationId: GetAssessment
      summary: Get Assessment
      description: Gets information about a specified assessment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAssessmentResponse'
        '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/GetAssessmentRequest'
      tags:
      - Assessments
    put:
      operationId: UpdateAssessment
      summary: Update Assessment
      description: Edits an Audit Manager assessment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAssessmentResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAssessmentRequest'
      tags:
      - Assessments
  /assessments/{assessmentId}/status:
    put:
      operationId: UpdateAssessmentStatus
      summary: Update Assessment Status
      description: Updates the status of an assessment in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAssessmentStatusResponse'
        '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/UpdateAssessmentStatusRequest'
      tags:
      - Assessments
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:
    AWSAccount:
      type: object
      properties:
        id:
          type: string
          description: The identifier for the Amazon Web Services account.
        emailAddress:
          type: string
          description: The email address that's associated with the Amazon Web Services account.
        name:
          type: string
          description: The name of the Amazon Web Services account.
    AWSService:
      type: object
      properties:
        serviceName:
          type: string
          description: The name of the Amazon Web Services service.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Assessment:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the assessment.
        awsAccount:
          $ref: '#/components/schemas/AWSAccount'
        metadata:
          $ref: '#/components/schemas/AssessmentMetadata'
        framework:
          $ref: '#/components/schemas/AssessmentFramework'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that are associated with the assessment.
    AssessmentControl:
      type: object
      properties:
        id:
          type: string
          description: The identifier for the control.
        name:
          type: string
          description: The name of the control.
        description:
          type: string
          description: The description of the control.
        status:
          type: string
          enum:
          - UNDER_REVIEW
          - REVIEWED
          - INACTIVE
          description: The status of the control.
        response:
          type: string
          enum:
          - MANUAL
          - AUTOMATE
          - DEFER
          - IGNORE
          description: The response of the control.
        comments:
          type: array
          items:
            $ref: '#/components/schemas/ControlComment'
          description: The list of comments that's attached to the control.
        evidenceSources:
          type: array
          items:
            type: string
          description: The list of data sources for the evidence.
        evidenceCount:
          type: integer
          description: The amount of evidence that's collected for the control.
        assessmentReportEvidenceCount:
          type: integer
          description: The amount of evidence in the assessment report.
    AssessmentControlSet:
      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.
        description:
          type: string
          description: The description for the control set.
        status:
          type: string
          enum:
          - ACTIVE
          - UNDER_REVIEW
          - REVIEWED
          description: The current status of the control set.
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: The roles that are associated with the control set.
        controls:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentControl'
          description: The list of controls that's contained with the control set.
        delegations:
          type: array
          items:
            $ref: '#/components/schemas/Delegation'
          description: The delegations that are associated with the control set.
        systemEvidenceCount:
          type: integer
          description: The total number of evidence objects that are retrieved automatically for the control set.
        manualEvidenceCount:
          type: integer
          description: The total number of evidence objects that are uploaded manually to the control set.
    AssessmentFramework:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the framework.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the framework.
        metadata:
          $ref: '#/components/schemas/FrameworkMetadata'
        controlSets:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentControlSet'
          description: The control sets that are associated with the framework.
    AssessmentMetadata:
      type: object
      properties:
        name:
          type: string
          description: The name of the assessment.
        id:
          type: string
          description: The unique identifier for the assessment.
        description:
          type: string
          description: The description of the assessment.
        complianceType:
          type: string
          description: The name of the compliance standard that's related to the assessment, such as PCI-DSS.
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The overall status of the assessment.
        assessmentReportsDestination:
          $ref: '#/components/schemas/AssessmentReportsDestination'
        scope:
          $ref: '#/components/schemas/Scope'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: The roles that are associated with the assessment.
        delegations:
          type: array
          items:
            $ref: '#/components/schemas/Delegation'
          description: The delegations that are associated with the assessment.
        creationTime:
          type: string
          format: date-time
          description: Specifies when the assessment was created.
        lastUpdated:
          type: string
          format: date-time
          description: The time of the most recent update.
    AssessmentMetadataItem:
      type: object
      properties:
        name:
          type: string
          description: The name of the assessment.
        id:
          type: string
          description: The unique identifier for the assessment.
        complianceType:
          type: string
          description: The name of the compliance standard that's related to the assessment, such as PCI-DSS.
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the assessment.
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: The roles that are associated with the assessment.
        delegations:
          type: array
          items:
            $ref: '#/components/schemas/Delegation'
          description: The delegations that are associated with the assessment.
        creationTime:
          type: string
          format: date-time
          description: Specifies when the assessment was created.
        lastUpdated:
          type: string
          format: date-time
          description: The time of the most recent update.
    AssessmentReportsDestination:
      type: object
      properties:
        destinationType:
          type: string
          enum:
          - S3
          description: The destination type, such as Amazon S3.
        destination:
          type: string
          description: The destination bucket where Audit Manager stores assessment reports.
    ControlComment:
      type: object
      properties:
        authorName:
          type: string
          description: The name of the user who authored the comment.
        commentBody:
          type: string
          description: The body text of a control comment.
        postedDate:
          type: string
          format: date-time
          description: The time when the comment was posted.
    CreateAssessmentRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the assessment to be created.
        description:
          type: string
          description: The optional description of the assessment to be created.
        assessmentReportsDestination:
          $ref: '#/components/schemas/AssessmentReportsDestination'
        scope:
          $ref: '#/components/schemas/Scope'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: The list of roles for the assessment.
        frameworkId:
          type: string
          description: The identifier for the framework that the assessment will be created from.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that are associated with the assessment.
      required:
      - name
      - assessmentReportsDestination
      - scope
      - roles
      - frameworkId
    CreateAssessmentResponse:
      type: object
      properties:
        assessment:
          $ref: '#/components/schemas/Assessment'
    Delegation:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the delegation.
        assessmentName:
          type: string
          description: The name of the assessment that's associated with the delegation.
        assessmentId:
          type: string
          description: The identifier for the assessment that's associated with the delegation.
        status:
          type: string
          enum:
          - IN_PROGRESS
          - UNDER_REVIEW
          - COMPLETE
          description: The status of the delegation.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role.
        roleType:
          type: string
          enum:
          - PROCESS_OWNER
          - RESOURCE_OWNER
          description: The type of customer persona. In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings,
            roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
        creationTime:
          type: string
          format: date-time
          description: Specifies when the delegation was created.
        lastUpdated:
          type: string
          format: date-time
          description: Specifies when the delegation was last updated.
        controlSetId:
          type: string
          description: The identifier for the control set that's associated with the delegation.
        comment:
          type: string
          description: The comment that's related to the delegation.
        createdBy:
          type: string
          description: The user or role that created the delegation.
    DeleteAssessmentRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The identifier for the assessment.
      required:
      - assessmentId
    DeleteAssessmentResponse:
      type: object
      properties: {}
    FrameworkMetadata:
      type: object
      properties:
        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 standard that's associated with the framework. For example, this could be PCI DSS or
            HIPAA.
    GetAssessmentRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the assessment.
      required:
      - assessmentId
    GetAssessmentResponse:
      type: object
      properties:
        assessment:
          $ref: '#/components/schemas/Assessment'
        userRole:
          $ref: '#/components/schemas/Role'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListAssessmentsRequest:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the assessment.
        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.
    ListAssessmentsResponse:
      type: object
      properties:
        assessmentMetadata:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentMetadataItem'
          description: The metadata that the ListAssessments API returns for each assessment.
        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
    Role:
      type: object
      properties:
        roleType:
          type: string
          enum:
          - PROCESS_OWNER
          - RESOURCE_OWNER
          description: The type of customer persona. In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings,
            roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role.
      required:
      - roleType
      - roleArn
    Scope:
      type: object
      properties:
        awsAccounts:
          type: array
          items:
            $ref: '#/components/schemas/AWSAccount'
          description: The Amazon Web Services accounts that are included in the scope of the assessment.
        awsServices:
          type: array
          items:
            $ref: '#/components/schemas/AWSService'
          description: The Amazon Web Services services that are included in the scope of the assessment. This API parameter
            is no longer supported. If you use this parameter to specify one or more Amazon Web Services services, Audit Manager
            ignores this input. Instead, the value for awsServices will show as empty.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateAssessmentRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the assessment.
        assessmentName:
          type: string
          description: The name of the assessment to be updated.
        assessmentDescription:
          type: string
          description: The description of the assessment.
        scope:
          $ref: '#/components/schemas/Scope'
        assessmentReportsDestination:
          $ref: '#/components/schemas/AssessmentReportsDestination'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: The list of roles for the assessment.
      required:
      - assessmentId
      - scope
    UpdateAssessmentResponse:
      type: object
      properties:
        assessment:
          $ref: '#/components/schemas/Assessment'
    UpdateAssessmentStatusRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the assessment.
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current status of the assessment.
      required:
      - assessmentId
      - status
    UpdateAssessmentStatusResponse:
      type: object
      properties:
        assessment:
          $ref: '#/components/schemas/Assessment'
    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)

Amazon Audit Manager Assessments API

Operations 6

Specifications

Examples

Schemas & Data

Other Resources