Amazon Audit Manager Evidence API

openapi: 3.2.0
info:
  title: Amazon Audit Manager Evidence API
  version: '2017-07-25'
  description: 'Operations tagged Evidence across 2 of this provider''s published API definitions: amazon-audit-manager-openapi.yml, amazon-audit-manager-evidence-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://auditmanager.us-east-1.amazonaws.com
  description: Amazon Audit Manager API endpoint
- url: https://auditmanager.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Evidence
  description: Operations for managing audit evidence
paths:
  /assessments/{assessmentId}/controlSets/{controlSetId}/evidence:
    get:
      operationId: listEvidence
      summary: Amazon Audit Manager List Evidence
      description: Returns a list of evidence from AWS Audit Manager, filtered by assessment and control set.
      tags:
      - Evidence
      x-microcks-operation:
        delay: 100
        dispatcher: QUERY_MATCH
      parameters:
      - name: assessmentId
        in: path
        required: true
        schema:
          type: string
      - name: controlSetId
        in: path
        required: true
        schema:
          type: string
      - name: evidenceFolderId
        in: query
        required: true
        schema:
          type: string
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Evidence listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEvidenceResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    evidence:
                    - id: e1f2a3b4-c5d6-7890-efab-c12345678901
                      evidenceSources: AWS Config
                      evidenceByType: complianceCheck
                    nextToken: ''
    servers:
    - url: https://auditmanager.us-east-1.amazonaws.com
      description: Amazon Audit Manager API endpoint
  /assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders:
    get:
      operationId: getEvidenceFoldersByAssessmentControl
      summary: Amazon Audit Manager Get Evidence Folders By Assessment Control
      description: Returns the evidence folders from a specified assessment and control set in AWS Audit Manager.
      tags:
      - Evidence
      x-microcks-operation:
        delay: 100
        dispatcher: QUERY_MATCH
      parameters:
      - name: assessmentId
        in: path
        required: true
        schema:
          type: string
      - name: controlSetId
        in: path
        required: true
        schema:
          type: string
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: nextToken
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Evidence folders retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEvidenceFoldersByAssessmentControlResponse'
              examples:
                default:
                  x-microcks-default: true
                  value:
                    evidenceFolders:
                    - id: f1a2b3c4-d5e6-7890-fabc-d12345678901
                      name: Access Control Evidence
                      assessmentId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    nextToken: ''
    servers:
    - url: https://auditmanager.us-east-1.amazonaws.com
      description: Amazon Audit Manager API endpoint
  /assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence:
    post:
      operationId: BatchImportEvidenceToAssessmentControl
      summary: Batch Import Evidence To Assessment Control
      description: 'Adds one or more pieces of evidence to a control in an Audit Manager assessment. You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question. The following restrictions apply to this action: manualEvidence can be only one of the following: evidenceFileName, s3ResourcePath, or textResponse Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchImportEvidenceToAssessmentControlResponse'
        '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'
        '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/BatchImportEvidenceToAssessmentControlRequest'
      tags:
      - Evidence
    servers:
    - url: https://auditmanager.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}:
    get:
      operationId: GetEvidence
      summary: Get Evidence
      description: Gets information about a specified evidence item.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEvidenceResponse'
        '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/GetEvidenceRequest'
      tags:
      - Evidence
    servers:
    - url: https://auditmanager.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence:
    get:
      operationId: GetEvidenceByEvidenceFolder
      summary: Get Evidence By Evidence Folder
      description: Gets all evidence from a specified evidence folder in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEvidenceByEvidenceFolderResponse'
        '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/GetEvidenceByEvidenceFolderRequest'
      tags:
      - Evidence
    servers:
    - url: https://auditmanager.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    EvidenceFolder:
      type: object
      properties:
        name:
          type: string
        date:
          type: string
          format: date-time
        assessmentId:
          type: string
        controlSetId:
          type: string
        controlId:
          type: string
        id:
          type: string
        dataSource:
          type: string
        author:
          type: string
        totalEvidence:
          type: integer
        assessmentReportSelectionCount:
          type: integer
        controlName:
          type: string
        evidenceResourcesIncludedCount:
          type: integer
        evidenceByTypeConfigurationDataCount:
          type: integer
        evidenceByTypeManualCount:
          type: integer
        evidenceByTypeComplianceCheckCount:
          type: integer
        evidenceByTypeComplianceCheckIssuesCount:
          type: integer
        evidenceByTypeUserActivityCount:
          type: integer
    Resource:
      type: object
      properties:
        arn:
          type: string
        value:
          type: string
        complianceCheck:
          type: string
    Evidence:
      type: object
      properties:
        dataSource:
          type: string
        evidenceAwsAccountId:
          type: string
        time:
          type: string
          format: date-time
        serviceName:
          type: string
        eventName:
          type: string
        eventSource:
          type: string
        evidenceByType:
          type: string
        resourcesIncluded:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        attributes:
          type: object
          additionalProperties:
            type: string
        iamId:
          type: string
        complianceCheck:
          type: string
        awsOrganization:
          type: string
        awsAccountId:
          type: string
        evidenceFolderId:
          type: string
        id:
          type: string
        assessmentReportSelection:
          type: string
    ListEvidenceResponse:
      type: object
      properties:
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/Evidence'
        nextToken:
          type: string
    GetEvidenceFoldersByAssessmentControlResponse:
      type: object
      properties:
        evidenceFolders:
          type: array
          items:
            $ref: '#/components/schemas/EvidenceFolder'
        nextToken:
          type: string
    GetEvidenceByEvidenceFolderResponse:
      type: object
      properties:
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/Evidence_2'
          description: The list of evidence that the GetEvidenceByEvidenceFolder API returned.
        nextToken:
          type: string
          description: The pagination token that's used to fetch the next set of results.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    BatchImportEvidenceToAssessmentControlError:
      type: object
      properties:
        manualEvidence:
          $ref: '#/components/schemas/ManualEvidence'
        errorCode:
          type: string
          description: The error code that the BatchImportEvidenceToAssessmentControl API returned.
        errorMessage:
          type: string
          description: The error message that the BatchImportEvidenceToAssessmentControl API returned.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetEvidenceResponse:
      type: object
      properties:
        evidence:
          $ref: '#/components/schemas/Evidence_2'
    GetEvidenceByEvidenceFolderRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The identifier for the assessment.
        controlSetId:
          type: string
          description: The identifier for the control set.
        evidenceFolderId:
          type: string
          description: The unique identifier for the folder that the evidence is stored in.
        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:
      - assessmentId
      - controlSetId
      - evidenceFolderId
    BatchImportEvidenceToAssessmentControlResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/BatchImportEvidenceToAssessmentControlError'
          description: A list of errors that the BatchImportEvidenceToAssessmentControl API returned.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      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
    Evidence_2:
      type: object
      properties:
        dataSource:
          type: string
          description: The data source where the evidence was collected from.
        evidenceAwsAccountId:
          type: string
          description: The identifier for the Amazon Web Services account.
        time:
          type: string
          format: date-time
          description: The timestamp that represents when the evidence was collected.
        eventSource:
          type: string
          description: The Amazon Web Services service that the evidence is collected from.
        eventName:
          type: string
          description: The name of the evidence event.
        evidenceByType:
          type: string
          description: The type of automated evidence.
        resourcesIncluded:
          type: array
          items:
            $ref: '#/components/schemas/Resource_2'
          description: The list of resources that are assessed to generate the evidence.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).
        iamId:
          type: string
          description: The unique identifier for the user or role that's associated with the evidence.
        complianceCheck:
          type: string
          description: The evaluation status for automated evidence that falls under the compliance check category. Audit Manager classes evidence as non-compliant if Security Hub CSPM reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes evidence as compliant if Security Hub CSPM reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub CSPM as the underlying data source type, but those services aren't
        awsOrganization:
          type: string
          description: The Amazon Web Services account that the evidence is collected from, and its organization path.
        awsAccountId:
          type: string
          description: The identifier for the Amazon Web Services account.
        evidenceFolderId:
          type: string
          description: The identifier for the folder that the evidence is stored in.
        id:
          type: string
          description: The identifier for the evidence.
        assessmentReportSelection:
          type: string
          description: Specifies whether the evidence is included in the assessment report.
    Resource_2:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) for the resource.
        value:
          type: string
          description: The value of the resource.
        complianceCheck:
          type: string
          description: The evaluation status for a resource that was assessed when collecting compliance check evidence. Audit Manager classes the resource as non-compliant if Security Hub CSPM reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes the resource as compliant if Security Hub CSPM reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that resource. This is the case if a resource assessment uses Config or Security Hub CSPM as the underlying data source type, but
    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
    ManualEvidence:
      type: object
      properties:
        s3ResourcePath:
          type: string
          description: The S3 URL of the object that's imported as manual evidence.
        textResponse:
          type: string
          description: The plain text response that's entered and saved as manual evidence.
        evidenceFileName:
          type: string
          description: The name of the file that's uploaded as manual evidence. This name is populated using the evidenceFileName value from the GetEvidenceFileUploadUrl API response.
    BatchImportEvidenceToAssessmentControlRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The identifier for the assessment.
        controlSetId:
          type: string
          description: The identifier for the control set.
        controlId:
          type: string
          description: The identifier for the control.
        manualEvidence:
          type: array
          items:
            $ref: '#/components/schemas/ManualEvidence'
          description: The list of manual evidence objects.
      required:
      - assessmentId
      - controlSetId
      - controlId
      - manualEvidence
    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
    GetEvidenceRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the assessment.
        controlSetId:
          type: string
          description: The unique identifier for the control set.
        evidenceFolderId:
          type: string
          description: The unique identifier for the folder that the evidence is stored in.
        evidenceId:
          type: string
          description: The unique identifier for the evidence.
      required:
      - assessmentId
      - controlSetId
      - evidenceFolderId
      - evidenceId
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
x-refined-from:
- amazon-audit-manager-openapi.yml
- amazon-audit-manager-evidence-api-openapi.yml