Amazon Audit Manager Settings API

openapi: 3.1.0
info:
  title: AWS Audit Manager Settings API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Audit Manager. 2 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:
  /settings/{attribute}:
    get:
      operationId: GetSettings
      summary: Get Settings
      description: Gets the settings for a specified Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSettingsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSettingsRequest'
      tags:
      - Settings
  /settings:
    put:
      operationId: UpdateSettings
      summary: Update Settings
      description: Updates Audit Manager settings for the current account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSettingsResponse'
        '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/UpdateSettingsRequest'
      tags:
      - Settings
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
    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.
    DefaultExportDestination:
      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 exported files.
    DeregistrationPolicy:
      type: object
      properties:
        deleteResources:
          type: string
          enum:
          - ALL
          - DEFAULT
          description: Specifies which Audit Manager data will be deleted when you deregister Audit Manager. If you set the
            value to ALL, all of your data is deleted within seven days of deregistration. If you set the value to DEFAULT,
            none of your data is deleted at the time of deregistration. However, keep in mind that the Audit Manager data
            retention policy still applies. As a result, any evidence data will be deleted two years after its creation date.
            Your other Audit Manager resources will continue to exist indefinitely.
    EvidenceFinderEnablement:
      type: object
      properties:
        eventDataStoreArn:
          type: string
          description: The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder.
            The event data store is the lake of evidence data that evidence finder runs queries against.
        enablementStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          - ENABLE_IN_PROGRESS
          - DISABLE_IN_PROGRESS
          description: The current status of the evidence finder feature and the related event data store. ENABLE_IN_PROGRESS
            means that you requested to enable evidence finder. An event data store is currently being created to support
            evidence finder queries. ENABLED means that an event data store was successfully created and evidence finder is
            enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’
            worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until
            the backfill is complete. DISABLE_IN_PROGRESS means th
        backfillStatus:
          type: string
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - COMPLETED
          description: The current status of the evidence data backfill process. The backfill starts after you enable evidence
            finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence
            data so that your evidence can be queried. NOT_STARTED means that the backfill hasn’t started yet. IN_PROGRESS
            means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence
            data. COMPLETED means that the backfill is complete. All of your past evidence is now queryable.
        error:
          type: string
          description: Represents any errors that occurred when enabling or disabling evidence finder.
    GetSettingsRequest:
      type: object
      properties:
        attribute:
          type: string
          enum:
          - ALL
          - IS_AWS_ORG_ENABLED
          - SNS_TOPIC
          - DEFAULT_ASSESSMENT_REPORTS_DESTINATION
          - DEFAULT_PROCESS_OWNERS
          - EVIDENCE_FINDER_ENABLEMENT
          - DEREGISTRATION_POLICY
          - DEFAULT_EXPORT_DESTINATION
          description: The list of setting attribute enum values.
      required:
      - attribute
    GetSettingsResponse:
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/Settings'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    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
    Settings:
      type: object
      properties:
        isAwsOrgEnabled:
          type: boolean
          description: Specifies whether Organizations is enabled.
        snsTopic:
          type: string
          description: The designated Amazon Simple Notification Service (Amazon SNS) topic.
        defaultAssessmentReportsDestination:
          $ref: '#/components/schemas/AssessmentReportsDestination'
        defaultProcessOwners:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: The designated default audit owners.
        kmsKey:
          type: string
          description: The KMS key details.
        evidenceFinderEnablement:
          $ref: '#/components/schemas/EvidenceFinderEnablement'
        deregistrationPolicy:
          $ref: '#/components/schemas/DeregistrationPolicy'
        defaultExportDestination:
          $ref: '#/components/schemas/DefaultExportDestination'
    UpdateSettingsRequest:
      type: object
      properties:
        snsTopic:
          type: string
          description: The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.
        defaultAssessmentReportsDestination:
          $ref: '#/components/schemas/AssessmentReportsDestination'
        defaultProcessOwners:
          type: array
          items:
            $ref: '#/components/schemas/Role'
          description: A list of the default audit owners.
        kmsKey:
          type: string
          description: The KMS key details.
        evidenceFinderEnabled:
          type: boolean
          description: Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable
            evidence finder. When you use this attribute to disable evidence finder, Audit Manager deletes the event data
            store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature
            again. Your only alternative is to deregister and then re-register Audit Manager.
        deregistrationPolicy:
          $ref: '#/components/schemas/DeregistrationPolicy'
        defaultExportDestination:
          $ref: '#/components/schemas/DefaultExportDestination'
    UpdateSettingsResponse:
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/Settings'
    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)