Amazon Audit Manager Reports API

openapi: 3.1.0
info:
  title: AWS Audit Manager Reports API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Audit Manager. 3 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/{assessmentId}/reports:
    post:
      operationId: CreateAssessmentReport
      summary: Create Assessment Report
      description: Creates an assessment report for the specified assessment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssessmentReportResponse'
        '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/CreateAssessmentReportRequest'
      tags:
      - Reports
  /assessments/{assessmentId}/reports/{assessmentReportId}:
    delete:
      operationId: DeleteAssessmentReport
      summary: Delete Assessment Report
      description: 'Deletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport operation, Audit
        Manager attempts to delete the following data: The specified assessment report that’s stored in your S3 bucket The
        associated metadata that’s stored in Audit Manager If Audit Manager can’t access the assessment report in your S3
        bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds
        to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. This
        scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this,
        make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete
        resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination
        permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or
        404 (Not Found) error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API Reference.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssessmentReportResponse'
        '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/DeleteAssessmentReportRequest'
      tags:
      - Reports
  /assessmentReports:
    get:
      operationId: ListAssessmentReports
      summary: List Assessment Reports
      description: Returns a list of assessment reports created in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssessmentReportsResponse'
        '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/ListAssessmentReportsRequest'
      tags:
      - Reports
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
    AssessmentReport:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the assessment report.
        name:
          type: string
          description: The name that's given to the assessment report.
        description:
          type: string
          description: The description of the specified assessment report.
        awsAccountId:
          type: string
          description: The identifier for the specified Amazon Web Services account.
        assessmentId:
          type: string
          description: The identifier for the specified assessment.
        assessmentName:
          type: string
          description: The name of the associated assessment.
        author:
          type: string
          description: The name of the user who created the assessment report.
        status:
          type: string
          enum:
          - COMPLETE
          - IN_PROGRESS
          - FAILED
          description: The current status of the specified assessment report.
        creationTime:
          type: string
          format: date-time
          description: Specifies when the assessment report was created.
    AssessmentReportMetadata:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the assessment report.
        name:
          type: string
          description: The name of the assessment report.
        description:
          type: string
          description: The description of the assessment report.
        assessmentId:
          type: string
          description: The unique identifier for the associated assessment.
        assessmentName:
          type: string
          description: The name of the associated assessment.
        author:
          type: string
          description: The name of the user who created the assessment report.
        status:
          type: string
          enum:
          - COMPLETE
          - IN_PROGRESS
          - FAILED
          description: The current status of the assessment report.
        creationTime:
          type: string
          format: date-time
          description: Specifies when the assessment report was created.
    CreateAssessmentReportRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the new assessment report.
        description:
          type: string
          description: The description of the assessment report.
        assessmentId:
          type: string
          description: The identifier for the assessment.
        queryStatement:
          type: string
          description: 'A SQL statement that represents an evidence finder query. Provide this parameter when you want to
            generate an assessment report from the results of an evidence finder search query. When you use this parameter,
            Audit Manager generates a one-time report using only the evidence from the query output. This report does not
            include any assessment evidence that was manually added to a report using the console, or associated with a report
            using the API. To use this parameter, the enablementStatus of evidence finder must be ENABLED. For examples and
            help resolving queryStatement validation exceptions, '
      required:
      - name
      - assessmentId
    CreateAssessmentReportResponse:
      type: object
      properties:
        assessmentReport:
          $ref: '#/components/schemas/AssessmentReport'
    DeleteAssessmentReportRequest:
      type: object
      properties:
        assessmentId:
          type: string
          description: The unique identifier for the assessment.
        assessmentReportId:
          type: string
          description: The unique identifier for the assessment report.
      required:
      - assessmentId
      - assessmentReportId
    DeleteAssessmentReportResponse:
      type: object
      properties: {}
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListAssessmentReportsRequest:
      type: object
      properties:
        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.
    ListAssessmentReportsResponse:
      type: object
      properties:
        assessmentReports:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentReportMetadata'
          description: The list of assessment reports that the ListAssessmentReports API returned.
        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
    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)