Amazon Macie

Amazon Macie Allow Lists API

The Allow Lists API from Amazon Macie — 2 operation(s) for allow lists.

Documentation GitHub OpenAPI

Operations 5

POST /allow-lists Create Allow List #

GET /allow-lists List Allow Lists #

DELETE /allow-lists/{id} Delete Allow List #

GET /allow-lists/{id} Get Allow List #

PUT /allow-lists/{id} Update Allow List #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-macie:amazon-macie-allow-lists-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Macie 2 Allow Lists API
  version: '2020-01-01'
  description: Generated from AWS's published Smithy model for Amazon Macie 2. 5 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://macie2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /allow-lists:
    post:
      operationId: CreateAllowList
      summary: Create Allow List
      description: Creates and defines the settings for an allow list.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAllowListResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAllowListRequest'
      tags:
      - Allow Lists
    get:
      operationId: ListAllowLists
      summary: List Allow Lists
      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'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAllowListsRequest'
      tags:
      - Allow Lists
  /allow-lists/{id}:
    delete:
      operationId: DeleteAllowList
      summary: Delete Allow List
      description: Deletes an allow list.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAllowListResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAllowListRequest'
      tags:
      - Allow Lists
    get:
      operationId: GetAllowList
      summary: Get Allow List
      description: Retrieves the settings and status of an allow list.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllowListResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAllowListRequest'
      tags:
      - Allow Lists
    put:
      operationId: UpdateAllowList
      summary: Update Allow List
      description: Updates the settings for an allow list.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAllowListResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAllowListRequest'
      tags:
      - Allow Lists
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: macie2
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    AllowListCriteria:
      type: object
      properties:
        regex:
          type: string
          description: The regular expression (regex) that defines the text pattern to ignore. The expression can contain
            as many as 512 characters.
        s3WordsList:
          $ref: '#/components/schemas/S3WordsList'
    AllowListStatus:
      type: object
      properties:
        code:
          type: string
          enum:
          - OK
          - S3_OBJECT_NOT_FOUND
          - S3_USER_ACCESS_DENIED
          - S3_OBJECT_ACCESS_DENIED
          - S3_THROTTLED
          - S3_OBJECT_OVERSIZE
          - S3_OBJECT_EMPTY
          - UNKNOWN_ERROR
          description: 'The current status of the allow list. If the list''s criteria specify a regular expression (regex),
            this value is typically OK. Amazon Macie can compile the expression. If the list''s criteria specify an S3 object,
            possible values are: OK - Macie can retrieve and parse the contents of the object. S3_OBJECT_ACCESS_DENIED - Macie
            isn''t allowed to access the object or the object is encrypted with a customer managed KMS key that Macie isn''t
            allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object
            is encrypted, also ensure that it''s encrypted'
        description:
          type: string
          description: A brief description of the status of the allow list. Amazon Macie uses this value to provide additional
            information about an error that occurred when Macie tried to access and use the list's criteria.
      required:
      - code
    AllowListSummary:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the allow list.
        createdAt:
          type: string
          format: date-time
          description: The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.
        description:
          type: string
          description: The custom description of the allow list.
        id:
          type: string
          description: The unique identifier for the allow list.
        name:
          type: string
          description: The custom name of the allow list.
        updatedAt:
          type: string
          format: date-time
          description: The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently
            changed in Amazon Macie.
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    CreateAllowListRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
        criteria:
          $ref: '#/components/schemas/AllowListCriteria'
        description:
          type: string
          description: A custom description of the allow list. The description can contain as many as 512 characters.
        name:
          type: string
          description: A custom name for the allow list. The name can contain as many as 128 characters.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A map of key-value pairs that specifies the tags to associate with the allow list. An allow list can
            have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a
            tag key is 128 characters. The maximum length of a tag value is 256 characters.
      required:
      - clientToken
      - criteria
      - name
    CreateAllowListResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the allow list.
        id:
          type: string
          description: The unique identifier for the allow list.
    DeleteAllowListRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the Amazon Macie resource that the request applies to.
        ignoreJobChecks:
          type: string
          description: Specifies whether to force deletion of the allow list, even if active classification jobs are configured
            to use the list. When you try to delete an allow list, Amazon Macie checks for classification jobs that use the
            list and have a status other than COMPLETE or CANCELLED. By default, Macie rejects your request if any jobs meet
            these criteria. To skip these checks and delete the list, set this value to true. To delete the list only if no
            active jobs are configured to use it, set this value to false.
      required:
      - id
    DeleteAllowListResponse:
      type: object
      properties: {}
    GetAllowListRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the Amazon Macie resource that the request applies to.
      required:
      - id
    GetAllowListResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the allow list.
        createdAt:
          type: string
          format: date-time
          description: The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.
        criteria:
          $ref: '#/components/schemas/AllowListCriteria'
        description:
          type: string
          description: The custom description of the allow list.
        id:
          type: string
          description: The unique identifier for the allow list.
        name:
          type: string
          description: The custom name of the allow list.
        status:
          $ref: '#/components/schemas/AllowListStatus'
        tags:
          type: object
          additionalProperties:
            type: string
          description: A map of key-value pairs that specifies which tags (keys and values) are associated with the allow
            list.
        updatedAt:
          type: string
          format: date-time
          description: The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently
            changed in Amazon Macie.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    ListAllowListsRequest:
      type: object
      properties:
        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.
    ListAllowListsResponse:
      type: object
      properties:
        allowLists:
          type: array
          items:
            $ref: '#/components/schemas/AllowListSummary'
          description: An array of objects, one for each allow list.
        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.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    S3WordsList:
      type: object
      properties:
        bucketName:
          type: string
          description: The full name of the S3 bucket that contains the object.
        objectKey:
          type: string
          description: The full name (key) of the object.
      required:
      - bucketName
      - objectKey
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    UpdateAllowListRequest:
      type: object
      properties:
        criteria:
          $ref: '#/components/schemas/AllowListCriteria'
        description:
          type: string
          description: A custom description of the allow list. The description can contain as many as 512 characters.
        id:
          type: string
          description: The unique identifier for the Amazon Macie resource that the request applies to.
        name:
          type: string
          description: A custom name for the allow list. The name can contain as many as 128 characters.
      required:
      - criteria
      - id
      - name
    UpdateAllowListResponse:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the allow list.
        id:
          type: string
          description: The unique identifier for the allow list.
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/macie2/service/2020-01-01/macie2-2020-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)

Amazon Macie Allow Lists API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources