Amazon Macie Templates API

openapi: 3.0.0
info:
  version: 2020-01-01
  x-release: v4
  title: Amazon Macie 2 Admin#adminAccountId Templates API
  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: mike.ralphson@gmail.com
    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
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)
security:
- hmac: []
tags:
- name: Templates
paths:
  /templates/sensitivity-inspections/{id}:
    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: GetSensitivityInspectionTemplate
      description: ' <p>Retrieves the settings for the sensitivity inspection template for an account.</p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSensitivityInspectionTemplateResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '484':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier for the Amazon Macie resource that the request applies to.
        schema:
          type: string
      summary: Amazon Macie Get Sensitivity Inspection Template
      tags:
      - Templates
    put:
      operationId: UpdateSensitivityInspectionTemplate
      description: ' <p>Updates the settings for the sensitivity inspection template for an account.</p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSensitivityInspectionTemplateResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '484':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier for the Amazon Macie resource that the request applies to.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  description: A custom description of the template. The description can contain as many as 200 characters.
                  type: string
                excludes:
                  description: Specifies managed data identifiers to exclude (not use) when performing automated sensitive data discovery for an Amazon Macie account. For information about the managed data identifiers that Amazon Macie currently provides, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.
                  type: object
                  properties:
                    managedDataIdentifierIds:
                      allOf:
                      - $ref: '#/components/schemas/__listOf__string'
                      - description: An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.
                includes:
                  description: Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery for an Amazon Macie account. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.
                  type: object
                  properties:
                    allowListIds:
                      allOf:
                      - $ref: '#/components/schemas/__listOf__string'
                      - description: An array of unique identifiers, one for each allow list to include.
                    customDataIdentifierIds:
                      allOf:
                      - $ref: '#/components/schemas/__listOf__string'
                      - description: An array of unique identifiers, one for each custom data identifier to include.
                    managedDataIdentifierIds:
                      allOf:
                      - $ref: '#/components/schemas/__listOf__string'
                      - description: <p>An array of unique identifiers, one for each managed data identifier to include.</p> <p>Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.</p> <para/>
      summary: Amazon Macie Update Sensitivity Inspection Template
      tags:
      - Templates
  /templates/sensitivity-inspections:
    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: ListSensitivityInspectionTemplates
      description: ' <p>Retrieves a subset of information about the sensitivity inspection template for an account.</p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSensitivityInspectionTemplatesResponse'
        '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: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '484':
          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 Sensitivity Inspection Templates
      tags:
      - Templates
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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
  schemas:
    InternalServerException: {}
    ThrottlingException: {}
    SensitivityInspectionTemplateId:
      type: string
      description: The unique identifier for the sensitivity inspection template.
    __string:
      type: string
    __listOf__string:
      type: array
      items:
        $ref: '#/components/schemas/__string'
    __listOfSensitivityInspectionTemplatesEntry:
      type: array
      items:
        $ref: '#/components/schemas/SensitivityInspectionTemplatesEntry'
    ServiceQuotaExceededException: {}
    GetSensitivityInspectionTemplateResponse:
      type: object
      properties:
        description:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The custom description of the template.
        excludes:
          allOf:
          - $ref: '#/components/schemas/SensitivityInspectionTemplateExcludes'
          - description: ' <p>The managed data identifiers that are explicitly excluded (not used) when analyzing data.</p>'
        includes:
          allOf:
          - $ref: '#/components/schemas/SensitivityInspectionTemplateIncludes'
          - description: The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.
        name:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: 'The name of the template: automated-sensitive-data-discovery.'
        sensitivityInspectionTemplateId:
          allOf:
          - $ref: '#/components/schemas/SensitivityInspectionTemplateId'
          - description: The unique identifier for the template.
    SensitivityInspectionTemplateExcludes:
      type: object
      properties:
        managedDataIdentifierIds:
          allOf:
          - $ref: '#/components/schemas/__listOf__string'
          - description: An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.
      description: Specifies managed data identifiers to exclude (not use) when performing automated sensitive data discovery for an Amazon Macie account. For information about the managed data identifiers that Amazon Macie currently provides, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.
    ResourceNotFoundException: {}
    AccessDeniedException: {}
    SensitivityInspectionTemplatesEntry:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: The unique identifier for the sensitivity inspection template.
        name:
          allOf:
          - $ref: '#/components/schemas/__string'
          - description: 'The name of the sensitivity inspection template: automated-sensitive-data-discovery.'
      description: Provides information about the sensitivity inspection template for an Amazon Macie account. Macie uses the template's settings when it performs automated sensitive data discovery for the account.
    UpdateSensitivityInspectionTemplateResponse:
      type: object
      properties: {}
    ListSensitivityInspectionTemplatesResponse:
      type: object
      properties:
        nextToken:
          allOf:
          - $ref: '#/components/schemas/__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.
        sensitivityInspectionTemplates:
          allOf:
          - $ref: '#/components/schemas/__listOfSensitivityInspectionTemplatesEntry'
          - description: An array that specifies the unique identifier and name of the sensitivity inspection template for the account.
    ValidationException: {}
    SensitivityInspectionTemplateIncludes:
      type: object
      properties:
        allowListIds:
          allOf:
          - $ref: '#/components/schemas/__listOf__string'
          - description: An array of unique identifiers, one for each allow list to include.
        customDataIdentifierIds:
          allOf:
          - $ref: '#/components/schemas/__listOf__string'
          - description: An array of unique identifiers, one for each custom data identifier to include.
        managedDataIdentifierIds:
          allOf:
          - $ref: '#/components/schemas/__listOf__string'
          - description: <p>An array of unique identifiers, one for each managed data identifier to include.</p> <p>Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.</p> <para/>
      description: Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery for an Amazon Macie account. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, see <a href="https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html">Using managed data identifiers</a> in the <i>Amazon Macie User Guide</i>.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/macie2/
x-hasEquivalentPaths: true