View Source aws_auditmanager (aws v0.3.1)

Welcome to the AWS Audit Manager API reference.

This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors.

AWS Audit Manager is a service that provides automated evidence collection so that you can continuously audit your AWS usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.

AWS Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which 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 unique requirements.

Use the following links to get started with the AWS Audit Manager API:

  • Actions: An alphabetical list of all AWS Audit Manager API operations.

  • Data types: An alphabetical list of all AWS Audit Manager data types.

  • Common parameters: Parameters that all Query operations can use.

  • Common errors: Client and server errors that all operations can return.

If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide.

Link to this section Summary

Functions

Associates an evidence folder to the specified assessment report in AWS Audit Manager.
Associates a list of evidence to an assessment report in an AWS Audit Manager assessment.
Create a batch of delegations for a specified assessment in AWS Audit Manager.
Deletes the delegations in the specified AWS Audit Manager assessment.
Disassociates a list of evidence from the specified assessment report in AWS Audit Manager.
Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager.
Creates an assessment in AWS Audit Manager.
Creates a custom framework in AWS Audit Manager.
Creates an assessment report for the specified assessment.
Creates a new custom control in AWS Audit Manager.
Deletes an assessment in AWS Audit Manager.
Deletes a custom framework in AWS Audit Manager.
Deletes an assessment report from an assessment in AWS Audit Manager.
Deletes a custom control in AWS Audit Manager.
Deregisters an account in AWS Audit Manager.
Deregisters the delegated AWS administrator account from the AWS organization.
Disassociates an evidence folder from the specified assessment report in AWS Audit Manager.
Returns the registration status of an account in AWS Audit Manager.
Returns an assessment from AWS Audit Manager.
Returns a framework from AWS Audit Manager.
Returns the URL of a specified assessment report in AWS Audit Manager.
Returns a list of changelogs from AWS Audit Manager.
Returns a control from AWS Audit Manager.
Returns a list of delegations from an audit owner to a delegate.
Returns all evidence from a specified evidence folder in AWS Audit Manager.
Returns an evidence folder from the specified assessment in AWS Audit Manager.
Returns the evidence folders from a specified assessment in AWS Audit Manager.
Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager.
Returns the name of the delegated AWS administrator account for the AWS organization.
Returns a list of the in-scope AWS services for the specified assessment.
Returns the settings for the specified AWS account.
Returns a list of the frameworks available in the AWS Audit Manager framework library.
Returns a list of assessment reports created in AWS Audit Manager.
Returns a list of current and past assessments from AWS Audit Manager.
Returns a list of controls from AWS Audit Manager.
Returns a list of keywords that pre-mapped to the specified control data source.
Returns a list of all AWS Audit Manager notifications.
Returns a list of tags for the specified resource in AWS Audit Manager.
Enables AWS Audit Manager for the specified AWS account.
Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager.
Tags the specified resource in AWS Audit Manager.
Removes a tag from a resource in AWS Audit Manager.
Edits an AWS Audit Manager assessment.
Updates a control within an assessment in AWS Audit Manager.
Updates the status of a control set in an AWS Audit Manager assessment.
Updates a custom framework in AWS Audit Manager.
Updates the status of an assessment in AWS Audit Manager.
Updates a custom control in AWS Audit Manager.
Updates AWS Audit Manager settings for the current user account.
Validates the integrity of an assessment report in AWS Audit Manager.

Link to this section Functions

Link to this function

associate_assessment_report_evidence_folder(Client, AssessmentId, Input)

View Source
Associates an evidence folder to the specified assessment report in AWS Audit Manager.
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
Associates a list of evidence to an assessment report in an AWS Audit Manager assessment.
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
Create a batch of delegations for a specified assessment in AWS Audit Manager.
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
Deletes the delegations in the specified AWS Audit Manager assessment.
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
Disassociates a list of evidence from the specified assessment report in AWS Audit Manager.
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
Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager.
Link to this function

batch_import_evidence_to_assessment_control(Client, AssessmentId, ControlId, ControlSetId, Input0, Options0)

View Source
Link to this function

create_assessment(Client, Input)

View Source
Creates an assessment in AWS Audit Manager.
Link to this function

create_assessment(Client, Input0, Options0)

View Source
Link to this function

create_assessment_framework(Client, Input)

View Source
Creates a custom framework in AWS Audit Manager.
Link to this function

create_assessment_framework(Client, Input0, Options0)

View Source
Link to this function

create_assessment_report(Client, AssessmentId, Input)

View Source
Creates an assessment report for the specified assessment.
Link to this function

create_assessment_report(Client, AssessmentId, Input0, Options0)

View Source
Link to this function

create_control(Client, Input)

View Source
Creates a new custom control in AWS Audit Manager.
Link to this function

create_control(Client, Input0, Options0)

View Source
Link to this function

delete_assessment(Client, AssessmentId, Input)

View Source
Deletes an assessment in AWS Audit Manager.
Link to this function

delete_assessment(Client, AssessmentId, Input0, Options0)

View Source
Link to this function

delete_assessment_framework(Client, FrameworkId, Input)

View Source
Deletes a custom framework in AWS Audit Manager.
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
Deletes an assessment report from an assessment in AWS Audit Manager.
Link to this function

delete_assessment_report(Client, AssessmentId, AssessmentReportId, Input0, Options0)

View Source
Link to this function

delete_control(Client, ControlId, Input)

View Source
Deletes a custom control in AWS Audit Manager.
Link to this function

delete_control(Client, ControlId, Input0, Options0)

View Source
Link to this function

deregister_account(Client, Input)

View Source
Deregisters an account in AWS Audit Manager.
Link to this function

deregister_account(Client, Input0, Options0)

View Source
Link to this function

deregister_organization_admin_account(Client, Input)

View Source
Deregisters the delegated AWS administrator account from the AWS organization.
Link to this function

deregister_organization_admin_account(Client, Input0, Options0)

View Source
Link to this function

disassociate_assessment_report_evidence_folder(Client, AssessmentId, Input)

View Source
Disassociates an evidence folder from the specified assessment report in AWS Audit Manager.
Link to this function

disassociate_assessment_report_evidence_folder(Client, AssessmentId, Input0, Options0)

View Source
Link to this function

get_account_status(Client)

View Source
Returns the registration status of an account in AWS Audit Manager.
Link to this function

get_account_status(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_account_status(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_assessment(Client, AssessmentId)

View Source
Returns an assessment from AWS Audit Manager.
Link to this function

get_assessment(Client, AssessmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_assessment(Client, AssessmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_assessment_framework(Client, FrameworkId)

View Source
Returns a framework from AWS Audit Manager.
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
Returns the URL of a specified assessment report in AWS Audit Manager.
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)

View Source
Returns a list of changelogs from AWS Audit Manager.
Link to this function

get_change_logs(Client, AssessmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_change_logs(Client, AssessmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_control(Client, ControlId)

View Source
Returns a control from AWS Audit Manager.
Link to this function

get_control(Client, ControlId, QueryMap, HeadersMap)

View Source
Link to this function

get_control(Client, ControlId, QueryMap, HeadersMap, Options0)

View Source
Returns a list of delegations from an audit owner to a delegate.
Link to this function

get_delegations(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_delegations(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_evidence(Client, AssessmentId, ControlSetId, EvidenceFolderId, EvidenceId)

View Source
Returns evidence from AWS Audit Manager.
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
Returns all evidence from a specified evidence folder in AWS Audit Manager.
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
Returns an evidence folder from the specified assessment in AWS Audit Manager.
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)

View Source
Returns the evidence folders from a specified assessment in AWS Audit Manager.
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
Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager.
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_organization_admin_account(Client)

View Source
Returns the name of the delegated AWS administrator account for the AWS organization.
Link to this function

get_organization_admin_account(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_organization_admin_account(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_services_in_scope(Client)

View Source
Returns a list of the in-scope AWS services for the specified assessment.
Link to this function

get_services_in_scope(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_services_in_scope(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_settings(Client, Attribute)

View Source
Returns the settings for the specified AWS account.
Link to this function

get_settings(Client, Attribute, QueryMap, HeadersMap)

View Source
Link to this function

get_settings(Client, Attribute, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_assessment_frameworks(Client, FrameworkType)

View Source
Returns a list of the frameworks available in the AWS Audit Manager framework library.
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 Source
Link to this function

list_assessment_reports(Client)

View Source
Returns a list of assessment reports created in AWS Audit Manager.
Link to this function

list_assessment_reports(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_assessment_reports(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_assessments(Client)

View Source
Returns a list of current and past assessments from AWS Audit Manager.
Link to this function

list_assessments(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_assessments(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_controls(Client, ControlType)

View Source
Returns a list of controls from AWS Audit Manager.
Link to this function

list_controls(Client, ControlType, QueryMap, HeadersMap)

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)

View Source
Returns a list of keywords that pre-mapped to the specified control data 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_notifications(Client)

View Source
Returns a list of all AWS Audit Manager notifications.
Link to this function

list_notifications(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_notifications(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Returns a list of tags for the specified resource in AWS Audit Manager.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

register_account(Client, Input)

View Source
Enables AWS Audit Manager for the specified AWS account.
Link to this function

register_account(Client, Input0, Options0)

View Source
Link to this function

register_organization_admin_account(Client, Input)

View Source
Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager.
Link to this function

register_organization_admin_account(Client, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source
Tags the specified resource in AWS Audit Manager.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Removes a tag from a resource in AWS Audit Manager.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_assessment(Client, AssessmentId, Input)

View Source
Edits an AWS Audit Manager assessment.
Link to this function

update_assessment(Client, AssessmentId, Input0, Options0)

View Source
Link to this function

update_assessment_control(Client, AssessmentId, ControlId, ControlSetId, Input)

View Source
Updates a control within an assessment in AWS Audit Manager.
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
Updates the status of a control set in an AWS Audit Manager assessment.
Link to this function

update_assessment_control_set_status(Client, AssessmentId, ControlSetId, Input0, Options0)

View Source
Link to this function

update_assessment_framework(Client, FrameworkId, Input)

View Source
Updates a custom framework in AWS Audit Manager.
Link to this function

update_assessment_framework(Client, FrameworkId, Input0, Options0)

View Source
Link to this function

update_assessment_status(Client, AssessmentId, Input)

View Source
Updates the status of an assessment in AWS Audit Manager.
Link to this function

update_assessment_status(Client, AssessmentId, Input0, Options0)

View Source
Link to this function

update_control(Client, ControlId, Input)

View Source
Updates a custom control in AWS Audit Manager.
Link to this function

update_control(Client, ControlId, Input0, Options0)

View Source
Link to this function

update_settings(Client, Input)

View Source
Updates AWS Audit Manager settings for the current user account.
Link to this function

update_settings(Client, Input0, Options0)

View Source
Link to this function

validate_assessment_report_integrity(Client, Input)

View Source
Validates the integrity of an assessment report in AWS Audit Manager.
Link to this function

validate_assessment_report_integrity(Client, Input0, Options0)

View Source