Amazon Macie API

openapi: 3.0.0
info:
  version: 2020-01-01
  x-release: v4
  title: Amazon Macie 2
  description: Amazon Macie
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: "#FFFFFF"
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: [email protected]
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: macie2
  x-aws-signingName: macie2
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/macie2-2020-01-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/macie2/
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)
x-hasEquivalentPaths: true
paths:
  /invitations/accept:
    post:
      operationId: AcceptInvitation
      description: Accepts an Amazon Macie membership invitation that was received from a specific account.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AcceptInvitationResponse"
        "480":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
        "483":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - invitationId
              properties:
                administratorAccountId:
                  description: The Amazon Web Services account ID for the account that sent the invitation.
                  type: string
                invitationId:
                  description: The unique identifier for the invitation to accept.
                  type: string
                masterAccount:
                  description: (Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is 
                    retained only for backward compatibility.
                  type: string
      summary: Amazon Macie Accept Invitation
    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"
  /custom-data-identifiers/get:
    post:
      operationId: BatchGetCustomDataIdentifiers
      description: Retrieves information about one or more custom data identifiers.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BatchGetCustomDataIdentifiersResponse"
        "480":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
        "483":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  description: An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.
                  type: array
                  items:
                    $ref: "#/components/schemas/__string"
      summary: Amazon Macie Batch Get Custom Data Identifiers
    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"
  /allow-lists:
    post:
      operationId: CreateAllowList
      description: Creates and defines the settings for an allow list.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateAllowListResponse"
        "480":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
        "483":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - clientToken
              - criteria
              - name
              properties:
                clientToken:
                  description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
                  type: string
                criteria:
                  description: Specifies the criteria for an allow list. The criteria must specify a regular expression (regex) or an S3 object (s3WordsList). It can't specify both.
                  type: object
                  properties:
                    regex:
                      allOf:
                      - $ref: "#/components/schemas/__stringMin1Max512PatternSS"
                      - description: The regular expression (<i>regex</i>) that defines the text pattern to ignore. The expression can contain as many as 512 characters.
                    s3WordsList:
                      allOf:
                      - $ref: "#/components/schemas/S3WordsList"
                      - description: The location and name of the S3 object that lists specific text to ignore.
                description:
                  description: A custom description of the allow list. The description can contain as many as 512 characters.
                  type: string
                  pattern: ^[\s\S]+$
                  minLength: 1
                  maxLength: 512
                name:
                  description: A custom name for the allow list. The name can contain as many as 128 characters.
                  type: string
                  pattern: ^.+$
                  minLength: 1
                  maxLength: 128
                tags:
                  description: A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.
                  type: object
                  additionalProperties:
                    $ref: "#/components/schemas/__string"
      summary: Amazon Macie Create Allow List
    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: ListAllowLists
      description: Retrieves a subset of information about all the allow lists for an account.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListAllowListsResponse"
        "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:
      - name: maxResults
        in: query
        required: false
        description: The maximum number of items to include in each page of a paginated response.
        schema:
          type: integer
          minimum: 1
          maximum: 25
      - name: nextToken
        in: query
        required: false
        description: The nextToken string that specifies which page of results to return in a paginated response.
        schema:
          type: string
      summary: Amazon Macie List Allow Lists
  /jobs:
    post:
      operationId: CreateClassificationJob
      description: Creates and defines the settings for a classification job.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateClassificationJobResponse"
        "480":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
        "483":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - clientToken
              - jobType
              - name
              - s3JobDefinition
              properties:
                allowListIds:
                  description: An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
                  type: array
                  items:
                    $ref: "#/components/schemas/__string"
                clientToken:
                  description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
                  type: string
                customDataIdentifierIds:
                  description: An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value
                    for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
                  type: array
                  items:
                    $ref: "#/components/schemas/__string"
                description:
                  description: A custom description of the job. The description can contain as many as 200 characters.
                  type: string
                initialRun:
                  description: <p>For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are 
                    created or changed after you create the job and before the job's first scheduled run, set this value to false.</p> <p>If you configure the job to run only once, don't specify a 
                    value for this property.</p>
                  type: boolean
                jobType:
                  description: "The schedule for running a classification job. Valid values are:"
                  type: string
                  enum:
                  - ONE_TIME
                  - SCHEDULED
                managedDataIdentifierIds:
                  description: <p>An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion 
                    depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).</p> <p>To retrieve a list of valid values for this property, use
                    the ListManagedDataIdentifiers operation.</p>
                  type: array
                  items:
                    $ref: "#/components/schemas/__string"
                managedDataIdentifierSelector:
                  description: "The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:"
                  type: string
                  enum:
                  - ALL
                  - EXCLUDE
                  - INCLUDE
                  - NONE
                name:
                  description: A custom name for the job. The name can contain as many as 500 characters.
                  type: string
                s3JobDefinition:
                  description: Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static 
                    (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job 
                    analyzes objects in any buckets that match the specified criteria each time the job starts to run.
                  type: object
                  properties:
                    bucketCriteria:
                      allOf:
                      - $ref: "#/components/schemas/S3BucketCriteriaForJob"
                      - description: The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria
                          to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
                    bucketDefinitions:
                      allOf:
                      - $ref: "#/components/schemas/__listOfS3BucketDefinitionForJob"
                      - description: An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one
                          or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
                    scoping:
                      allOf:
                      - $ref: "#/components/schemas/Scoping"
                      - description: The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria
                          to determine which objects to analyze.
                samplingPercentage:
                  description: The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If 
                    this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
                  type: integer
                scheduleFrequency:
                  description: Specifies the recurrence pattern for running a classification job.
                  type: object
                  properties:
                    dailySchedule:
                      allOf:
                      - $ref: "#/components/schemas/DailySchedule"
                      - description: Specifies a daily recurrence pattern for running the job.
                    monthlySchedule:
                      allOf:
                      - $ref: "#/components/schemas/MonthlySchedule"
                      - description: Specifies a monthly recurrence pattern for running the job.
                    weeklySchedule:
                      allOf:
                      - $ref: "#/components/schemas/WeeklySchedule"
                      - description: Specifies a weekly recurrence pattern for running the job.
                tags:
                  description: A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.
                  type: object
                  additionalProperties:
                    $ref: "#/components/schemas/__string"
      summary: Amazon Macie Create Classification Job
    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"
  /custom-data-identifiers:
    post:
      operationId: CreateCustomDataIdentifier
      description: Creates and defines the criteria and other settings for a custom data identifier.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateCustomDataIdentifierResponse"
        "480":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
        "483":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - regex
              properties:
                clientToken:
                  description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
                  type: string
                description:
                  description: <p>A custom description of the custom data identifier. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any 
                    sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to 
                    perform in Amazon Macie.</p>
                  type: string
                ignoreWords:
                  description: An array that lists specific character sequences (<i>ignore words</i>) to exclude from the results. If the text matched by the regular expression contains any string in 
                    this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
                  type: array
                  items:
                    $ref: "#/components/schemas/__string"
                keywords:
                  description: An array that lists specific character sequences (<i>keywords</i>), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to
                    match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
                  type: array
                  items:
                    $ref: "#/components/schemas/__string"
                maximumMatchDistance:
                  description: The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that 
                    matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. 
                    The distance can be 1-300 characters. The default value is 50.
                  type: integer
                name:
                  description: <p>A custom name for the custom data identifier. The name can contain as many as 128 characters.</p> <p>We strongly recommend that you avoid including any sensitive data
                    in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.</p>
                  type: string
                regex:
                  description: The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.
                  type: string
                severityLevels:
                  description: "<p>The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection
                    criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds
                    must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified
                    threshold, Amazon Macie doesn't create a finding.</p> <p>If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of
                    text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.</p>"
                  type: array
                  items:
                    $ref: "#/components/schemas/SeverityLevel"
                tags:
                  description: A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.
                  type: object
                  additionalProperties:
                    $ref: "#/components/schemas/__string"
      summary: Amazon Macie Create Custom Data Identifier
    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"
  /findingsfilters:
    post:
      operationId: CreateFindingsFilter
      description: Creates and defines the criteria and other settings for a findings filter.
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateFindingsFilterResponse"
        "480":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
        "483":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
        

# --- truncated at 32 KB (515 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-macie/refs/heads/main/openapi/amazon-macie-openapi-original.yaml