Amazon Macie Automated Discovery API

openapi: 3.2.0
info:
  title: Amazon Macie Automated Discovery API
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-aws-signingName differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Automated Discovery across 2 of this provider''s published API definitions: amazon-macie-openapi-original.yaml, amazon-macie-automated-discovery-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://macie2.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Macie 2 multi-region endpoint
- url: https://macie2.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Macie 2 multi-region endpoint
- url: http://macie2.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia)
- url: https://macie2.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia)
tags:
- name: Automated Discovery
paths:
  /automated-discovery/configuration:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: GetAutomatedDiscoveryConfiguration
      description: Retrieves the configuration settings and status of automated sensitive data discovery for an account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutomatedDiscoveryConfigurationResponse'
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters: []
      summary: Amazon Macie Get Automated Discovery Configuration
      tags:
      - Automated Discovery
      security:
      - hmac: []
    put:
      operationId: UpdateAutomatedDiscoveryConfiguration
      description: Enables or disables automated sensitive data discovery for an account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAutomatedDiscoveryConfigurationResponse'
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - status
              properties:
                status:
                  description: 'The status of the automated sensitive data discovery configuration for an Amazon Macie account. Valid values are:'
                  type: string
                  enum:
                  - ENABLED
                  - DISABLED
      summary: Amazon Macie Update Automated Discovery Configuration
      tags:
      - Automated Discovery
      security:
      - hmac: []
    servers:
    - url: http://macie2.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The Amazon Macie 2 multi-region endpoint
    - url: https://macie2.{region}.amazonaws.com
      variables:
        region:
          description: The AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-1
          - us-west-2
          - us-gov-west-1
          - us-gov-east-1
          - ca-central-1
          - eu-north-1
          - eu-west-1
          - eu-west-2
          - eu-west-3
          - eu-central-1
          - eu-south-1
          - af-south-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-northeast-3
          - ap-southeast-1
          - ap-southeast-2
          - ap-east-1
          - ap-south-1
          - sa-east-1
          - me-south-1
          default: us-east-1
      description: The Amazon Macie 2 multi-region endpoint
    - url: http://macie2.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia)
    - url: https://macie2.{region}.amazonaws.com.cn
      variables:
        region:
          description: The AWS region
          enum:
          - cn-north-1
          - cn-northwest-1
          default: cn-north-1
      description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia)
  /automated-discovery/accounts:
    patch:
      operationId: BatchUpdateAutomatedDiscoveryAccounts
      summary: Batch Update Automated Discovery Accounts
      description: Changes the status of automated sensitive data discovery for one or more accounts.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUpdateAutomatedDiscoveryAccountsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_2'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException_2'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException_2'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdateAutomatedDiscoveryAccountsRequest'
      tags:
      - Automated Discovery
      security:
      - sigv4: []
    get:
      operationId: ListAutomatedDiscoveryAccounts
      summary: List Automated Discovery Accounts
      description: Retrieves the status of automated sensitive data discovery for one or more accounts.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAutomatedDiscoveryAccountsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_2'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException_2'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException_2'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAutomatedDiscoveryAccountsRequest'
      tags:
      - Automated Discovery
      security:
      - sigv4: []
    servers:
    - url: https://macie2.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    ValidationException: {}
    Timestamp:
      type: string
      description: Specifies a date and time in UTC and extended ISO 8601 format.
      format: date-time
    SensitivityInspectionTemplateId:
      type: string
      description: The unique identifier for the sensitivity inspection template.
    AutomatedDiscoveryStatus:
      type: string
      enum:
      - ENABLED
      - DISABLED
      description: 'The status of the automated sensitive data discovery configuration for an Amazon Macie account. Valid values are:'
    AccessDeniedException: {}
    GetAutomatedDiscoveryConfigurationResponse:
      type: object
      properties:
        classificationScopeId:
          allOf:
          - $ref: '#/components/schemas/ClassificationScopeId'
          - description: The unique identifier for the classification scope that's used when performing automated sensitive data discovery for the account. The classification scope specifies S3 buckets to exclude from automated sensitive data discovery.
        disabledAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled for the account. This value is null if automated sensitive data discovery wasn't enabled and subsequently disabled for the account.
        firstEnabledAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled for the account. This value is null if automated sensitive data discovery has never been enabled for the account.
        lastUpdatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently enabled or disabled for the account.
        sensitivityInspectionTemplateId:
          allOf:
          - $ref: '#/components/schemas/SensitivityInspectionTemplateId'
          - description: The unique identifier for the sensitivity inspection template that's used when performing automated sensitive data discovery for the account. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.
        status:
          allOf:
          - $ref: '#/components/schemas/AutomatedDiscoveryStatus'
          - description: 'The current status of the automated sensitive data discovery configuration for the account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities for the account; and, DISABLED, don''t perform automated sensitive data discovery activities for the account.'
    ClassificationScopeId:
      type: string
      pattern: ^[0-9a-z]*$
      description: The unique identifier the classification scope.
    InternalServerException: {}
    UpdateAutomatedDiscoveryConfigurationResponse:
      type: object
      properties: {}
    ThrottlingException: {}
    ValidationException_2:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    BatchUpdateAutomatedDiscoveryAccountsResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedDiscoveryAccountUpdateError'
          description: An array of objects, one for each account whose status wasn't changed. Each object identifies the account and explains why the status of automated sensitive data discovery wasn't changed for the account. This value is null if the request succeeded for all specified accounts.
    ListAutomatedDiscoveryAccountsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedDiscoveryAccount'
          description: An array of objects, one for each account specified in the request. Each object specifies the Amazon Web Services account ID for an account and the current status of automated sensitive data discovery for that account.
        nextToken:
          type: string
          description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
    AutomatedDiscoveryAccount:
      type: object
      properties:
        accountId:
          type: string
          description: The Amazon Web Services account ID for the account.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: 'The current status of automated sensitive data discovery for the account. Possible values are: ENABLED, perform automated sensitive data discovery activities for the account; and, DISABLED, don''t perform automated sensitive data discovery activities for the account.'
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    ListAutomatedDiscoveryAccountsRequest:
      type: object
      properties:
        accountIds:
          type: array
          items:
            type: string
          description: The Amazon Web Services account ID for each account, for as many as 50 accounts. To retrieve the status for multiple accounts, append the accountIds parameter and argument for each account, separated by an ampersand (&). To retrieve the status for all the accounts in an organization, omit this parameter.
        maxResults:
          type: integer
          description: The maximum number of items to include in each page of a paginated response.
        nextToken:
          type: string
          description: The nextToken string that specifies which page of results to return in a paginated response.
    AccessDeniedException_2:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    AutomatedDiscoveryAccountUpdateError:
      type: object
      properties:
        accountId:
          type: string
          description: The Amazon Web Services account ID for the account that the request applied to.
        errorCode:
          type: string
          enum:
          - ACCOUNT_PAUSED
          - ACCOUNT_NOT_FOUND
          description: 'The error code for the error that caused the request to fail for the account (accountId). Possible values are: ACCOUNT_NOT_FOUND, the account doesn''t exist or you''re not the Amazon Macie administrator for the account; and, ACCOUNT_PAUSED, Macie isn''t enabled for the account in the current Amazon Web Services Region.'
    AutomatedDiscoveryAccountUpdate:
      type: object
      properties:
        accountId:
          type: string
          description: The Amazon Web Services account ID for the account.
        status:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: 'The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, perform automated sensitive data discovery activities for the account; and, DISABLED, don''t perform automated sensitive data discovery activities for the account.'
    BatchUpdateAutomatedDiscoveryAccountsRequest:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedDiscoveryAccountUpdate'
          description: An array of objects, one for each account to change the status of automated sensitive data discovery for. Each object specifies the Amazon Web Services account ID for an account and a new status for that account.
    InternalServerException_2:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    ThrottlingException_2:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
  parameters:
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
    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: macie2
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/macie2/
x-refined-from:
- amazon-macie-openapi-original.yaml
- amazon-macie-automated-discovery-api-openapi.yml
x-hasEquivalentPaths: true