View Source aws_auditmanager (aws v0.5.0)
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 Query operations can use.
Common errors: Client and server errors that all operations can return.
Link to this section Summary
Functions
Associates an evidence folder to an assessment report in a Audit Manager assessment.
Associates a list of evidence to an assessment report in an Audit Manager assessment.
Creates a batch of delegations for an assessment in Audit Manager.
Deletes a batch of delegations for an assessment in Audit Manager.
Disassociates a list of evidence from an assessment report in Audit Manager.
Uploads one or more pieces of evidence to a control in an Audit Manager assessment.
Creates an assessment in Audit Manager.
Creates a custom framework in Audit Manager.
Creates an assessment report for the specified assessment.
Creates a new custom control in Audit Manager.
Deletes an assessment in Audit Manager.
Deletes a custom framework in Audit Manager.
Deletes a share request for a custom framework in Audit Manager.
Deletes an assessment report from an assessment in Audit Manager.
Deletes a custom control in Audit Manager.
Deregisters an account in Audit Manager.
Removes the specified member Amazon Web Services account as a delegated administrator for Audit Manager.
Disassociates an evidence folder from the specified assessment report in Audit Manager.
Returns the registration status of an account in Audit Manager.
Returns an assessment from Audit Manager.
Returns a framework from Audit Manager.
Returns the URL of an assessment report in Audit Manager.
Returns a list of changelogs from Audit Manager.
Returns a control from Audit Manager.
Returns a list of delegations from an audit owner to a delegate.
Returns evidence from Audit Manager.
Returns all evidence from a specified evidence folder in Audit Manager.
Returns an evidence folder from the specified assessment in Audit Manager.
Returns the evidence folders from a specified assessment in Audit Manager.
Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager.
Gets the latest analytics data for all your current active assessments.
Gets the latest analytics data for a specific active assessment.
Returns the name of the delegated Amazon Web Services administrator account for the organization.
Returns a list of the in-scope Amazon Web Services services for the specified assessment.
Returns the settings for the specified Amazon Web Services account.
Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
Returns a list of the frameworks that are available in the Audit Manager framework library.
Returns a list of assessment reports created in Audit Manager.
Returns a list of current and past assessments from Audit Manager.
Lists the latest analytics data for control domains across all of your active assessments.
Lists analytics data for control domains within a specified active assessment.
Lists the latest analytics data for controls within a specific control domain across all active assessments.
Returns a list of controls from Audit Manager.
Returns a list of keywords that are pre-mapped to the specified control data source.
Returns a list of all Audit Manager notifications.
Returns a list of tags for the specified resource in Audit Manager.
Enables Audit Manager for the specified Amazon Web Services account.
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
Creates a share request for a custom framework in Audit Manager.
Tags the specified resource in Audit Manager.
Removes a tag from a resource in Audit Manager.
Edits an Audit Manager assessment.
Updates a control within an assessment in Audit Manager.
Updates the status of a control set in an Audit Manager assessment.
Updates a custom framework in Audit Manager.
Updates a share request for a custom framework in Audit Manager.
Updates the status of an assessment in Audit Manager.
Updates a custom control in Audit Manager.
Updates Audit Manager settings for the current user account.
Validates the integrity of an assessment report in Audit Manager.
Link to this section Functions
Link to this function
associate_assessment_report_evidence_folder(Client, AssessmentId, Input)
View Source
Link to this function
associate_assessment_report_evidence_folder(Client, AssessmentId, Input0, Options0)
View Source
Link to this function
batch_associate_assessment_report_evidence(Client, AssessmentId, Input)
View Source
Link to this function
batch_associate_assessment_report_evidence(Client, AssessmentId, Input0, Options0)
View Source
Link to this function
batch_create_delegation_by_assessment(Client, AssessmentId, Input)
View Source
Link to this function
batch_create_delegation_by_assessment(Client, AssessmentId, Input0, Options0)
View Source
Link to this function
batch_delete_delegation_by_assessment(Client, AssessmentId, Input)
View Source
Link to this function
batch_delete_delegation_by_assessment(Client, AssessmentId, Input0, Options0)
View Source
Link to this function
batch_disassociate_assessment_report_evidence(Client, AssessmentId, Input)
View Source
Link to this function
batch_disassociate_assessment_report_evidence(Client, AssessmentId, Input0, Options0)
View Source
Link to this function
batch_import_evidence_to_assessment_control(Client, AssessmentId, ControlId, ControlSetId, Input)
View Source
Link to this function
batch_import_evidence_to_assessment_control(Client, AssessmentId, ControlId, ControlSetId, Input0, Options0)
View Source
Link to this function
delete_assessment_framework(Client, FrameworkId, Input0, Options0)
View Source
Link to this function
delete_assessment_report(Client, AssessmentId, AssessmentReportId, Input)
View Source
Link to this function
delete_assessment_report(Client, AssessmentId, AssessmentReportId, Input0, Options0)
View SourceRemoves the specified member Amazon Web Services account as a delegated administrator for Audit Manager.
When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Audit Manager. However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward.
Link to this function
disassociate_assessment_report_evidence_folder(Client, AssessmentId, Input)
View Source
Link to this function
disassociate_assessment_report_evidence_folder(Client, AssessmentId, Input0, Options0)
View Source
Link to this function
get_assessment(Client, AssessmentId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_assessment_framework(Client, FrameworkId, QueryMap, HeadersMap)
View Source
Link to this function
get_assessment_framework(Client, FrameworkId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_assessment_report_url(Client, AssessmentId, AssessmentReportId)
View Source
Link to this function
get_assessment_report_url(Client, AssessmentId, AssessmentReportId, QueryMap, HeadersMap)
View Source
Link to this function
get_assessment_report_url(Client, AssessmentId, AssessmentReportId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_change_logs(Client, AssessmentId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_evidence(Client, AssessmentId, ControlSetId, EvidenceFolderId, EvidenceId)
View Source
Link to this function
get_evidence(Client, AssessmentId, ControlSetId, EvidenceFolderId, EvidenceId, QueryMap, HeadersMap)
View Source
Link to this function
get_evidence(Client, AssessmentId, ControlSetId, EvidenceFolderId, EvidenceId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_evidence_by_evidence_folder(Client, AssessmentId, ControlSetId, EvidenceFolderId)
View Source
Link to this function
get_evidence_by_evidence_folder(Client, AssessmentId, ControlSetId, EvidenceFolderId, QueryMap, HeadersMap)
View Source
Link to this function
get_evidence_by_evidence_folder(Client, AssessmentId, ControlSetId, EvidenceFolderId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_evidence_folder(Client, AssessmentId, ControlSetId, EvidenceFolderId)
View Source
Link to this function
get_evidence_folder(Client, AssessmentId, ControlSetId, EvidenceFolderId, QueryMap, HeadersMap)
View Source
Link to this function
get_evidence_folder(Client, AssessmentId, ControlSetId, EvidenceFolderId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_evidence_folders_by_assessment(Client, AssessmentId, QueryMap, HeadersMap)
View Source
Link to this function
get_evidence_folders_by_assessment(Client, AssessmentId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_evidence_folders_by_assessment_control(Client, AssessmentId, ControlId, ControlSetId)
View Source
Link to this function
get_evidence_folders_by_assessment_control(Client, AssessmentId, ControlId, ControlSetId, QueryMap, HeadersMap)
View Source
Link to this function
get_evidence_folders_by_assessment_control(Client, AssessmentId, ControlId, ControlSetId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_insights_by_assessment(Client, AssessmentId, QueryMap, HeadersMap)
View Source
Link to this function
get_insights_by_assessment(Client, AssessmentId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
get_organization_admin_account(Client, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_assessment_control_insights_by_control_domain(Client, AssessmentId, ControlDomainId)
View SourceLists the latest analytics data for controls within a specific control domain and a specific active assessment.
Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on thelastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.
Link to this function
list_assessment_control_insights_by_control_domain(Client, AssessmentId, ControlDomainId, QueryMap, HeadersMap)
View Source
Link to this function
list_assessment_control_insights_by_control_domain(Client, AssessmentId, ControlDomainId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_assessment_frameworks(Client, FrameworkType, QueryMap, HeadersMap)
View Source
Link to this function
list_assessment_frameworks(Client, FrameworkType, QueryMap, HeadersMap, Options0)
View SourceLists the latest analytics data for control domains across all of your active assessments.
A control domain is listed only if at least one of the controls within that domain collected evidence on thelastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.
Link to this function
list_control_domain_insights(Client, QueryMap, HeadersMap, Options0)
View SourceLists analytics data for control domains within a specified active assessment.
A control domain is listed only if at least one of the controls within that domain collected evidence on thelastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.
Link to this function
list_control_domain_insights_by_assessment(Client, AssessmentId, QueryMap, HeadersMap)
View Source
Link to this function
list_control_domain_insights_by_assessment(Client, AssessmentId, QueryMap, HeadersMap, Options0)
View SourceLists the latest analytics data for controls within a specific control domain across all active assessments.
Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on thelastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.
Link to this function
list_control_insights_by_control_domain(Client, ControlDomainId, QueryMap, HeadersMap)
View Source
Link to this function
list_control_insights_by_control_domain(Client, ControlDomainId, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_controls(Client, ControlType, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_keywords_for_data_source(Client, Source, QueryMap, HeadersMap)
View Source
Link to this function
list_keywords_for_data_source(Client, Source, QueryMap, HeadersMap, Options0)
View Source
Link to this function
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Source
Link to this function
update_assessment_control(Client, AssessmentId, ControlId, ControlSetId, Input)
View Source
Link to this function
update_assessment_control(Client, AssessmentId, ControlId, ControlSetId, Input0, Options0)
View Source
Link to this function
update_assessment_control_set_status(Client, AssessmentId, ControlSetId, Input)
View Source
Link to this function
update_assessment_control_set_status(Client, AssessmentId, ControlSetId, Input0, Options0)
View Source
Link to this function