AWS Audit Manager
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and…
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
Welcome to the Audit Manager API reference. This guide is for developers who
need detailed information about the Audit Manager API operations, data types, and
errors.
Audit Manager is a service that provides automated evidence collection so that you
can continually audit your Amazon Web Services usage. You can use it to assess the
effectiveness of your controls, manage risk, and simplify compliance.
Audit Manager provides prebuilt frameworks that structure and automate assessments
for a given compliance standard. Frameworks include a prebuilt collection of controls with
descriptions and testing procedures. These controls are grouped according to the
requirements of the specified compliance standard or regulation. You can also customize
frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
Actions : An
alphabetical list of all Audit Manager API operations.
Data types : An alphabetical list of all Audit Manager data
types.
Common
parameters : Parameters that all operations can use.
Common errors :
Client and server errors that all operations can return.
If you're new to Audit Manager, we recommend that you review the
Audit Manager User Guide .
Endpoints 62
- PUTAssociate assessment report evidence folder
/assessments/:assessmentId/associateToAssessmentReportAssociates an evidence folder to an assessment report in an Audit Manager assessment. - PUTBatch associate assessment report evidence
/assessments/:assessmentId/batchAssociateToAssessmentReportAssociates a list of evidence to an assessment report in an Audit Manager assessment. - PUTBatch delete delegation by assessment
/assessments/:assessmentId/delegationsDeletes a batch of delegations for an assessment in Audit Manager. - POSTBatch create delegation by assessment
/assessments/:assessmentId/delegationsCreates a batch of delegations for an assessment in Audit Manager. - PUTBatch disassociate assessment report evidence
/assessments/:assessmentId/batchDisassociateFromAssessmentReportDisassociates a list of evidence from an assessment report in Audit Manager. - POSTBatch import evidence to assessment control
/assessments/:assessmentId/controlSets/:controlSetId/controls/:controlId/evidenceAdds one or more pieces of evidence to a control in an Audit Manager assessment. You can import manual evidence from any S3 bucket by specifying the S3 URI of… - GETList assessments
/assessments?status=string&nextToken=string&maxResults=0Returns a list of current and past assessments from Audit Manager. - POSTCreate assessment
/assessmentsCreates an assessment in Audit Manager. - GETList assessment frameworks
/assessmentFrameworks?frameworkType=string&nextToken=string&maxResults=0Returns a list of the frameworks that are available in the Audit Manager framework library. - POSTCreate assessment framework
/assessmentFrameworksCreates a custom framework in Audit Manager. - POSTCreate assessment report
/assessments/:assessmentId/reportsCreates an assessment report for the specified assessment. - GETList controls
/controls?controlType=string&nextToken=string&maxResults=0&controlCatalogId=stringReturns a list of controls from Audit Manager. - POSTCreate control
/controlsCreates a new custom control in Audit Manager. - GETGet assessment
/assessments/:assessmentIdGets information about a specified assessment. - PUTUpdate assessment
/assessments/:assessmentIdEdits an Audit Manager assessment. - DELETEDelete assessment
/assessments/:assessmentIdDeletes an assessment in Audit Manager. - GETGet assessment framework
/assessmentFrameworks/:frameworkIdGets information about a specified framework. - PUTUpdate assessment framework
/assessmentFrameworks/:frameworkIdUpdates a custom framework in Audit Manager. - DELETEDelete assessment framework
/assessmentFrameworks/:frameworkIdDeletes a custom framework in Audit Manager. - PUTUpdate assessment framework share
/assessmentFrameworkShareRequests/:requestIdUpdates a share request for a custom framework in Audit Manager. - DELETEDelete assessment framework share
/assessmentFrameworkShareRequests/:requestId?requestType=stringDeletes a share request for a custom framework in Audit Manager. - DELETEDelete assessment report
/assessments/:assessmentId/reports/:assessmentReportIdDeletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data: The… - GETGet control
/controls/:controlIdGets information about a specified control. - PUTUpdate control
/controls/:controlIdUpdates a custom control in Audit Manager. - DELETEDelete control
/controls/:controlIdDeletes a custom control in Audit Manager. When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s… - POSTDeregister account
/account/deregisterAccountDeregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By… - POSTDeregister organization admin account
/account/deregisterOrganizationAdminAccountRemoves the specified Amazon Web Services account as a delegated administrator for Audit Manager. When you remove a delegated administrator from your Audit… - PUTDisassociate assessment report evidence folder
/assessments/:assessmentId/disassociateFromAssessmentReportDisassociates an evidence folder from the specified assessment report in Audit Manager. - GETGet account status
/account/statusGets the registration status of an account in Audit Manager. - GETGet assessment report url
/assessments/:assessmentId/reports/:assessmentReportId/urlGets the URL of an assessment report in Audit Manager. - GETGet change logs
/assessments/:assessmentId/changelogs?controlSetId=string&controlId=string&nextToken=string&maxResults=0Gets a list of changelogs from Audit Manager. - GETGet delegations
/delegations?nextToken=string&maxResults=0Gets a list of delegations from an audit owner to a delegate. - GETGet evidence
/assessments/:assessmentId/controlSets/:controlSetId/evidenceFolders/:evidenceFolderId/evidence/:evidenceIdGets information about a specified evidence item. - GETGet evidence by evidence folder
/assessments/:assessmentId/controlSets/:controlSetId/evidenceFolders/:evidenceFolderId/evidence?nextToken=string&maxResults=0Gets all evidence from a specified evidence folder in Audit Manager. - GETGet evidence file upload url
/evidenceFileUploadUrl?fileName=stringCreates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from… - GETGet evidence folder
/assessments/:assessmentId/controlSets/:controlSetId/evidenceFolders/:evidenceFolderIdGets an evidence folder from a specified assessment in Audit Manager. - GETGet evidence folders by assessment
/assessments/:assessmentId/evidenceFolders?nextToken=string&maxResults=0Gets the evidence folders from a specified assessment in Audit Manager. - GETGet evidence folders by assessment control
/assessments/:assessmentId/evidenceFolders-by-assessment-control/:controlSetId/:controlId?nextToken=string&maxResults=0Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment. - GETGet insights
/insightsGets the latest analytics data for all your current active assessments. - GETGet insights by assessment
/insights/assessments/:assessmentIdGets the latest analytics data for a specific active assessment. - GETGet organization admin account
/account/organizationAdminAccountGets the name of the delegated Amazon Web Services administrator account for a specified organization. - GETGet services in scope
/servicesGets a list of the Amazon Web Services services from which Audit Manager can collect evidence. Audit Manager defines which Amazon Web Services services are in… - GETGet settings
/settings/:attributeGets the settings for a specified Amazon Web Services account. - GETList assessment control insights by control domain
/insights/controls-by-assessment?controlDomainId=string&assessmentId=string&nextToken=string&maxResults=0Lists the latest analytics data for controls within a specific control domain and a specific active assessment. Control insights are listed only if the… - GETList assessment framework share requests
/assessmentFrameworkShareRequests?requestType=string&nextToken=string&maxResults=0Returns a list of sent or received share requests for custom frameworks in Audit Manager. - GETList assessment reports
/assessmentReports?nextToken=string&maxResults=0Returns a list of assessment reports created in Audit Manager. - GETList control domain insights
/insights/control-domains?nextToken=string&maxResults=0Lists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by… - GETList control domain insights by assessment
/insights/control-domains-by-assessment?assessmentId=string&nextToken=string&maxResults=0Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web… - GETList control insights by control domain
/insights/controls?controlDomainId=string&nextToken=string&maxResults=0Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control… - GETList keywords for data source
/dataSourceKeywords?source=string&nextToken=string&maxResults=0Returns a list of keywords that are pre-mapped to the specified control data source. - GETList notifications
/notifications?nextToken=string&maxResults=0Returns a list of all Audit Manager notifications. - GETList tags for resource
/tags/:resourceArnReturns a list of tags for the specified resource in Audit Manager. - POSTTag resource
/tags/:resourceArnTags the specified resource in Audit Manager. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes a tag from a resource in Audit Manager. - POSTRegister account
/account/registerAccountEnables Audit Manager for the specified Amazon Web Services account. - POSTRegister organization admin account
/account/registerOrganizationAdminAccountEnables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. - POSTStart assessment framework share
/assessmentFrameworks/:frameworkId/shareRequestsCreates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is… - PUTUpdate assessment control
/assessments/:assessmentId/controlSets/:controlSetId/controls/:controlIdUpdates a control within an assessment in Audit Manager. - PUTUpdate assessment control set status
/assessments/:assessmentId/controlSets/:controlSetId/statusUpdates the status of a control set in an Audit Manager assessment. - PUTUpdate assessment status
/assessments/:assessmentId/statusUpdates the status of an assessment in Audit Manager. - PUTUpdate settings
/settingsUpdates Audit Manager settings for the current account. - POSTValidate assessment report integrity
/assessmentReports/integrityValidates the integrity of an assessment report in Audit Manager.
API details
- Base URL
https://auditmanager.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 62 operations on 49 pathsGET 30PUT 13POST 13DELETE 6
- Description format
- AWS Smithy model, API version
2017-07-25 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Audit Manager in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Audit Manager collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Associate assessment report evidence folder” (PUT /assessments/:assessmentId/associateToAssessmentReport), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Audit Manager?
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and… It is listed under Developer tools and has 62 endpoints.
Who publishes the AWS Audit Manager?
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 AWS Audit Manager?
Requests go to https://auditmanager.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Audit Manager?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Audit Manager have?
62 operations on 49 paths (30 GET, 13 PUT, 13 POST, 6 DELETE).
Is forking the AWS Audit Manager free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.