Amazon Macie API

The Macie API from Amazon Macie — 2 operation(s) for macie.

GitHub OpenAPI

Operations 5

DELETE /macie Disable Macie #
POST /macie Enable Macie #
GET /macie Get Macie Session #
PATCH /macie Update Macie Session #
PATCH /macie/members/{id} Update Member Session #

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-macie-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.

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

OpenAPI Specification

amazon-macie-macie-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Macie 2 Macie 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:
  /macie:
    delete:
      operationId: DisableMacie
      summary: Disable Macie
      description: Disables Amazon Macie and deletes all settings and resources for a Macie account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisableMacieResponse'
        '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/DisableMacieRequest'
      tags:
      - Macie
    post:
      operationId: EnableMacie
      summary: Enable Macie
      description: Enables Amazon Macie and specifies the configuration settings for a Macie account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnableMacieResponse'
        '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/EnableMacieRequest'
      tags:
      - Macie
    get:
      operationId: GetMacieSession
      summary: Get Macie Session
      description: Retrieves the status and configuration settings for an Amazon Macie account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMacieSessionResponse'
        '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/GetMacieSessionRequest'
      tags:
      - Macie
    patch:
      operationId: UpdateMacieSession
      summary: Update Macie Session
      description: Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMacieSessionResponse'
        '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/UpdateMacieSessionRequest'
      tags:
      - Macie
  /macie/members/{id}:
    patch:
      operationId: UpdateMemberSession
      summary: Update Member Session
      description: Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMemberSessionResponse'
        '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/UpdateMemberSessionRequest'
      tags:
      - Macie
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.
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The explanation of the error that occurred.
    DisableMacieRequest:
      type: object
      properties: {}
    DisableMacieResponse:
      type: object
      properties: {}
    EnableMacieRequest:
      type: object
      properties:
        clientToken:
          type: string
          description: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
        findingPublishingFrequency:
          type: string
          enum:
          - FIFTEEN_MINUTES
          - ONE_HOUR
          - SIX_HOURS
          description: Specifies how often to publish updates to policy findings for the account. This includes publishing
            updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).
        status:
          type: string
          enum:
          - PAUSED
          - ENABLED
          description: Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for
            the account, set this value to ENABLED.
    EnableMacieResponse:
      type: object
      properties: {}
    GetMacieSessionRequest:
      type: object
      properties: {}
    GetMacieSessionResponse:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.
        findingPublishingFrequency:
          type: string
          enum:
          - FIFTEEN_MINUTES
          - ONE_HOUR
          - SIX_HOURS
          description: The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes
            publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).
        serviceRole:
          type: string
          description: The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze
            data in Amazon Web Services resources for the account.
        status:
          type: string
          enum:
          - PAUSED
          - ENABLED
          description: 'The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled
            but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all
            Macie activities are enabled for the account.'
        updatedAt:
          type: string
          format: date-time
          description: The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status or
            configuration settings for the Amazon Macie account.
    InternalServerException:
      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.
    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.
    UpdateMacieSessionRequest:
      type: object
      properties:
        findingPublishingFrequency:
          type: string
          enum:
          - FIFTEEN_MINUTES
          - ONE_HOUR
          - SIX_HOURS
          description: Specifies how often to publish updates to policy findings for the account. This includes publishing
            updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).
        status:
          type: string
          enum:
          - PAUSED
          - ENABLED
          description: 'Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities
            for the account; and, PAUSED, suspend all Macie activities for the account.'
    UpdateMacieSessionResponse:
      type: object
      properties: {}
    UpdateMemberSessionRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the Amazon Macie resource that the request applies to.
        status:
          type: string
          enum:
          - PAUSED
          - ENABLED
          description: 'Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities
            for the account; and, PAUSED, suspend all Macie activities for the account.'
      required:
      - id
      - status
    UpdateMemberSessionResponse:
      type: object
      properties: {}
    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)