Amazon Web Services, Inc.

Amazon Macie 2

Amazon Macie

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Macie

Endpoints 81

  • POSTAccept invitation/invitations/acceptAccepts an Amazon Macie membership invitation that was received from a specific account.
  • POSTBatch get custom data identifiers/custom-data-identifiers/getRetrieves information about one or more custom data identifiers.
  • GETList automated discovery accounts/automated-discovery/accounts?accountIds=&maxResults=0&nextToken=stringRetrieves the status of automated sensitive data discovery for one or more accounts.
  • PATCHBatch update automated discovery accounts/automated-discovery/accountsChanges the status of automated sensitive data discovery for one or more accounts.
  • GETList allow lists/allow-lists?maxResults=0&nextToken=stringRetrieves a subset of information about all the allow lists for an account.
  • POSTCreate allow list/allow-listsCreates and defines the settings for an allow list.
  • POSTCreate classification job/jobsCreates and defines the settings for a classification job.
  • POSTCreate custom data identifier/custom-data-identifiersCreates and defines the criteria and other settings for a custom data identifier.
  • GETList findings filters/findingsfilters?maxResults=0&nextToken=stringRetrieves a subset of information about all the findings filters for an account.
  • POSTCreate findings filter/findingsfiltersCreates and defines the criteria and other settings for a findings filter.
  • GETList invitations/invitations?maxResults=0&nextToken=stringRetrieves information about Amazon Macie membership invitations that were received by an account.
  • POSTCreate invitations/invitationsSends an Amazon Macie membership invitation to one or more accounts.
  • GETList members/members?maxResults=0&nextToken=string&onlyAssociated=stringRetrieves information about the accounts that are associated with an Amazon Macie administrator account.
  • POSTCreate member/membersAssociates an account with an Amazon Macie administrator account.
  • POSTCreate sample findings/findings/sampleCreates sample findings.
  • POSTDecline invitations/invitations/declineDeclines Amazon Macie membership invitations that were received from specific accounts.
  • GETGet allow list/allow-lists/:idRetrieves the settings and status of an allow list.
  • PUTUpdate allow list/allow-lists/:idUpdates the settings for an allow list.
  • DELETEDelete allow list/allow-lists/:id?ignoreJobChecks=stringDeletes an allow list.
  • GETGet custom data identifier/custom-data-identifiers/:idRetrieves the criteria and other settings for a custom data identifier.
  • DELETEDelete custom data identifier/custom-data-identifiers/:idSoft deletes a custom data identifier.
  • GETGet findings filter/findingsfilters/:idRetrieves the criteria and other settings for a findings filter.
  • DELETEDelete findings filter/findingsfilters/:idDeletes a findings filter.
  • PATCHUpdate findings filter/findingsfilters/:idUpdates the criteria and other settings for a findings filter.
  • POSTDelete invitations/invitations/deleteDeletes Amazon Macie membership invitations that were received from specific accounts.
  • GETGet member/members/:idRetrieves information about an account that's associated with an Amazon Macie administrator account.
  • DELETEDelete member/members/:idDeletes the association between an Amazon Macie administrator account and an account.
  • POSTDescribe buckets/datasources/s3Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.
  • GETDescribe classification job/jobs/:jobIdRetrieves the status and settings for a classification job.
  • PATCHUpdate classification job/jobs/:jobIdChanges the status of a classification job.
  • GETDescribe organization configuration/admin/configurationRetrieves the Amazon Macie configuration settings for an organization in Organizations.
  • PATCHUpdate organization configuration/admin/configurationUpdates the Amazon Macie configuration settings for an organization in Organizations.
  • GETGet macie session/macieRetrieves the status and configuration settings for an Amazon Macie account.
  • POSTEnable macie/macieEnables Amazon Macie and specifies the configuration settings for a Macie account.
  • DELETEDisable macie/macieDisables Amazon Macie and deletes all settings and resources for a Macie account.
  • PATCHUpdate macie session/macieSuspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
  • GETList organization admin accounts/admin?maxResults=0&nextToken=stringRetrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.
  • POSTEnable organization admin account/adminDesignates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
  • DELETEDisable organization admin account/admin?adminAccountId=stringDisables an account as the delegated Amazon Macie administrator account for an organization in Organizations.
  • POSTDisassociate from administrator account/administrator/disassociateDisassociates a member account from its Amazon Macie administrator account.
  • POSTDisassociate from master account/master/disassociate(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the…
  • POSTDisassociate member/members/disassociate/:idDisassociates an Amazon Macie administrator account from a member account.
  • GETGet administrator account/administratorRetrieves information about the Amazon Macie administrator account for an account.
  • GETGet automated discovery configuration/automated-discovery/configurationRetrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
  • PUTUpdate automated discovery configuration/automated-discovery/configurationChanges the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
  • POSTGet bucket statistics/datasources/s3/statisticsRetrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.
  • GETGet classification export configuration/classification-export-configurationRetrieves the configuration settings for storing data classification results.
  • PUTPut classification export configuration/classification-export-configurationAdds or updates the configuration settings for storing data classification results.
  • GETGet classification scope/classification-scopes/:idRetrieves the classification scope settings for an account.
  • PATCHUpdate classification scope/classification-scopes/:idUpdates the classification scope settings for an account.
  • POSTGet finding statistics/findings/statisticsRetrieves (queries) aggregated statistical data about findings.
  • POSTGet findings/findings/describeRetrieves the details of one or more findings.
  • GETGet findings publication configuration/findings-publication-configurationRetrieves the configuration settings for publishing findings to Security Hub.
  • PUTPut findings publication configuration/findings-publication-configurationUpdates the configuration settings for publishing findings to Security Hub.
  • GETGet invitations count/invitations/countRetrieves the count of Amazon Macie membership invitations that were received by an account.
  • GETGet master account/master(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the…
  • GETGet resource profile/resource-profiles?resourceArn=stringRetrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.
  • PATCHUpdate resource profile/resource-profiles?resourceArn=stringUpdates the sensitivity score for an S3 bucket.
  • GETGet reveal configuration/reveal-configurationRetrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
  • PUTUpdate reveal configuration/reveal-configurationUpdates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
  • GETGet sensitive data occurrences/findings/:findingId/revealRetrieves occurrences of sensitive data reported by a finding.
  • GETGet sensitive data occurrences availability/findings/:findingId/reveal/availabilityChecks whether occurrences of sensitive data can be retrieved for a finding.
  • GETGet sensitivity inspection template/templates/sensitivity-inspections/:idRetrieves the settings for the sensitivity inspection template for an account.
  • PUTUpdate sensitivity inspection template/templates/sensitivity-inspections/:idUpdates the settings for the sensitivity inspection template for an account.
  • POSTGet usage statistics/usage/statisticsRetrieves (queries) quotas and aggregated usage data for one or more accounts.
  • GETGet usage totals/usage?timeRange=stringRetrieves (queries) aggregated usage data for an account.
  • POSTList classification jobs/jobs/listRetrieves a subset of information about one or more classification jobs.
  • GETList classification scopes/classification-scopes?name=string&nextToken=stringRetrieves a subset of information about the classification scope for an account.
  • POSTList custom data identifiers/custom-data-identifiers/listRetrieves a subset of information about the custom data identifiers for an account.
  • POSTList findings/findingsRetrieves a subset of information about one or more findings.
  • POSTList managed data identifiers/managed-data-identifiers/listRetrieves information about all the managed data identifiers that Amazon Macie currently provides.
  • GETList resource profile artifacts/resource-profiles/artifacts?nextToken=string&resourceArn=stringRetrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery.
  • GETList resource profile detections/resource-profiles/detections?maxResults=0&nextToken=string&resourceArn=stringRetrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.
  • PATCHUpdate resource profile detections/resource-profiles/detections?resourceArn=stringUpdates the sensitivity scoring settings for an S3 bucket.
  • GETList sensitivity inspection templates/templates/sensitivity-inspections?maxResults=0&nextToken=stringRetrieves a subset of information about the sensitivity inspection template for an account.
  • GETList tags for resource/tags/:resourceArnRetrieves the tags (keys and values) that are associated with an Amazon Macie resource.
  • POSTTag resource/tags/:resourceArnAdds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes one or more tags (keys and values) from an Amazon Macie resource.
  • POSTSearch resources/datasources/search-resourcesRetrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account.
  • POSTTest custom data identifier/custom-data-identifiers/testTests criteria for a custom data identifier.
  • PATCHUpdate member session/macie/members/:idEnables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

API details

Base URL
https://macie2.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
81 operations on 53 pathsGET 31POST 28PATCH 9DELETE 7PUT 6
Description format
AWS Smithy model, API version 2020-01-01

How to test the Amazon Macie 2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Macie 2 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept invitation” (POST /invitations/accept), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Macie 2?

Amazon Macie It is listed under Identity & security and has 81 endpoints.

Who publishes the Amazon Macie 2?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Macie 2?

Requests go to https://macie2.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Macie 2?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Macie 2 have?

81 operations on 53 paths (31 GET, 28 POST, 9 PATCH, 7 DELETE, 6 PUT).

Is forking the Amazon Macie 2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.