aws-elixir v0.8.0

AWS.AuditManager (aws-elixir v0.8.0) View Source

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 continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.

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

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

Link to this section Summary

Functions

associate_assessment_report_evidence_folder(client, assessment_id, input, options \\ [])

Associates an evidence folder to the specified assessment report in Audit Manager.

batch_associate_assessment_report_evidence(client, assessment_id, input, options \\ [])

Associates a list of evidence to an assessment report in an Audit Manager assessment.

batch_create_delegation_by_assessment(client, assessment_id, input, options \\ [])

Create a batch of delegations for a specified assessment in Audit Manager.

batch_delete_delegation_by_assessment(client, assessment_id, input, options \\ [])

Deletes the delegations in the specified Audit Manager assessment.

batch_disassociate_assessment_report_evidence(client, assessment_id, input, options \\ [])

Disassociates a list of evidence from the specified assessment report in Audit Manager.

batch_import_evidence_to_assessment_control(client, assessment_id, control_id, control_set_id, input, options \\ [])

Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager.

create_assessment(client, input, options \\ [])

Creates an assessment in Audit Manager.

create_assessment_framework(client, input, options \\ [])

Creates a custom framework in Audit Manager.

create_assessment_report(client, assessment_id, input, options \\ [])

Creates an assessment report for the specified assessment.

create_control(client, input, options \\ [])

Creates a new custom control in Audit Manager.

delete_assessment(client, assessment_id, input, options \\ [])

Deletes an assessment in Audit Manager.

delete_assessment_framework(client, framework_id, input, options \\ [])

Deletes a custom framework in Audit Manager.

delete_assessment_report(client, assessment_id, assessment_report_id, input, options \\ [])

Deletes an assessment report from an assessment in Audit Manager.

delete_control(client, control_id, input, options \\ [])

Deletes a custom control in Audit Manager.

deregister_account(client, input, options \\ [])

Deregisters an account in Audit Manager.

deregister_organization_admin_account(client, input, options \\ [])

Removes the specified member account as a delegated administrator for Audit Manager.

disassociate_assessment_report_evidence_folder(client, assessment_id, input, options \\ [])

Disassociates an evidence folder from the specified assessment report in Audit Manager.

get_account_status(client, options \\ [])

Returns the registration status of an account in Audit Manager.

get_assessment(client, assessment_id, options \\ [])

Returns an assessment from Audit Manager.

get_assessment_framework(client, framework_id, options \\ [])

Returns a framework from Audit Manager.

get_assessment_report_url(client, assessment_id, assessment_report_id, options \\ [])

Returns the URL of a specified assessment report in Audit Manager.

get_change_logs(client, assessment_id, control_id \\ nil, control_set_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of changelogs from Audit Manager.

get_control(client, control_id, options \\ [])

Returns a control from Audit Manager.

get_delegations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of delegations from an audit owner to a delegate.

get_evidence(client, assessment_id, control_set_id, evidence_folder_id, evidence_id, options \\ [])

Returns evidence from Audit Manager.

get_evidence_by_evidence_folder(client, assessment_id, control_set_id, evidence_folder_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns all evidence from a specified evidence folder in Audit Manager.

get_evidence_folder(client, assessment_id, control_set_id, evidence_folder_id, options \\ [])

Returns an evidence folder from the specified assessment in Audit Manager.

get_evidence_folders_by_assessment(client, assessment_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns the evidence folders from a specified assessment in Audit Manager.

get_evidence_folders_by_assessment_control(client, assessment_id, control_id, control_set_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager.

get_organization_admin_account(client, options \\ [])

Returns the name of the delegated Amazon Web Services administrator account for the organization.

get_services_in_scope(client, options \\ [])

Returns a list of the in-scope Amazon Web Services services for the specified assessment.

get_settings(client, attribute, options \\ [])

Returns the settings for the specified account.

list_assessment_frameworks(client, framework_type, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the frameworks available in the Audit Manager framework library.

list_assessment_reports(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of assessment reports created in Audit Manager.

list_assessments(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of current and past assessments from Audit Manager.

list_controls(client, control_type, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of controls from Audit Manager.

list_keywords_for_data_source(client, max_results \\ nil, next_token \\ nil, source, options \\ [])

Returns a list of keywords that pre-mapped to the specified control data source.

list_notifications(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all Audit Manager notifications.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for the specified resource in Audit Manager.

metadata()
register_account(client, input, options \\ [])

Enables Audit Manager for the specified account.

register_organization_admin_account(client, input, options \\ [])

Enables an account within the organization as the delegated administrator for Audit Manager.

tag_resource(client, resource_arn, input, options \\ [])

Tags the specified resource in Audit Manager.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag from a resource in Audit Manager.

update_assessment(client, assessment_id, input, options \\ [])

Edits an Audit Manager assessment.

update_assessment_control(client, assessment_id, control_id, control_set_id, input, options \\ [])

Updates a control within an assessment in Audit Manager.

update_assessment_control_set_status(client, assessment_id, control_set_id, input, options \\ [])

Updates the status of a control set in an Audit Manager assessment.

update_assessment_framework(client, framework_id, input, options \\ [])

Updates a custom framework in Audit Manager.

update_assessment_status(client, assessment_id, input, options \\ [])

Updates the status of an assessment in Audit Manager.

update_control(client, control_id, input, options \\ [])

Updates a custom control in Audit Manager.

update_settings(client, input, options \\ [])

Updates Audit Manager settings for the current user account.

validate_assessment_report_integrity(client, input, options \\ [])

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, assessment_id, input, options \\ [])

View Source

Associates an evidence folder to the specified assessment report in Audit Manager.

Link to this function

batch_associate_assessment_report_evidence(client, assessment_id, input, options \\ [])

View Source

Associates a list of evidence to an assessment report in an Audit Manager assessment.

Link to this function

batch_create_delegation_by_assessment(client, assessment_id, input, options \\ [])

View Source

Create a batch of delegations for a specified assessment in Audit Manager.

Link to this function

batch_delete_delegation_by_assessment(client, assessment_id, input, options \\ [])

View Source

Deletes the delegations in the specified Audit Manager assessment.

Link to this function

batch_disassociate_assessment_report_evidence(client, assessment_id, input, options \\ [])

View Source

Disassociates a list of evidence from the specified assessment report in Audit Manager.

Link to this function

batch_import_evidence_to_assessment_control(client, assessment_id, control_id, control_set_id, input, options \\ [])

View Source

Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager.

Link to this function

create_assessment(client, input, options \\ [])

View Source

Creates an assessment in Audit Manager.

Link to this function

create_assessment_framework(client, input, options \\ [])

View Source

Creates a custom framework in Audit Manager.

Link to this function

create_assessment_report(client, assessment_id, input, options \\ [])

View Source

Creates an assessment report for the specified assessment.

Link to this function

create_control(client, input, options \\ [])

View Source

Creates a new custom control in Audit Manager.

Link to this function

delete_assessment(client, assessment_id, input, options \\ [])

View Source

Deletes an assessment in Audit Manager.

Link to this function

delete_assessment_framework(client, framework_id, input, options \\ [])

View Source

Deletes a custom framework in Audit Manager.

Link to this function

delete_assessment_report(client, assessment_id, assessment_report_id, input, options \\ [])

View Source

Deletes an assessment report from an assessment in Audit Manager.

Link to this function

delete_control(client, control_id, input, options \\ [])

View Source

Deletes a custom control in Audit Manager.

Link to this function

deregister_account(client, input, options \\ [])

View Source

Deregisters an account in Audit Manager.

Link to this function

deregister_organization_admin_account(client, input, options \\ [])

View Source

Removes the specified member account as a delegated administrator for Audit Manager.

When you remove a delegated administrator from your Audit Manager settings, or when you deregister a delegated administrator from Organizations, you continue to have access to the evidence that you previously collected under that account. 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, assessment_id, input, options \\ [])

View Source

Disassociates an evidence folder from the specified assessment report in Audit Manager.

Link to this function

get_account_status(client, options \\ [])

View Source

Returns the registration status of an account in Audit Manager.

Link to this function

get_assessment(client, assessment_id, options \\ [])

View Source

Returns an assessment from Audit Manager.

Link to this function

get_assessment_framework(client, framework_id, options \\ [])

View Source

Returns a framework from Audit Manager.

Link to this function

get_assessment_report_url(client, assessment_id, assessment_report_id, options \\ [])

View Source

Returns the URL of a specified assessment report in Audit Manager.

Link to this function

get_change_logs(client, assessment_id, control_id \\ nil, control_set_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of changelogs from Audit Manager.

Link to this function

get_control(client, control_id, options \\ [])

View Source

Returns a control from Audit Manager.

Link to this function

get_delegations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of delegations from an audit owner to a delegate.

Link to this function

get_evidence(client, assessment_id, control_set_id, evidence_folder_id, evidence_id, options \\ [])

View Source

Returns evidence from Audit Manager.

Link to this function

get_evidence_by_evidence_folder(client, assessment_id, control_set_id, evidence_folder_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns all evidence from a specified evidence folder in Audit Manager.

Link to this function

get_evidence_folder(client, assessment_id, control_set_id, evidence_folder_id, options \\ [])

View Source

Returns an evidence folder from the specified assessment in Audit Manager.

Link to this function

get_evidence_folders_by_assessment(client, assessment_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns the evidence folders from a specified assessment in Audit Manager.

Link to this function

get_evidence_folders_by_assessment_control(client, assessment_id, control_id, control_set_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager.

Link to this function

get_organization_admin_account(client, options \\ [])

View Source

Returns the name of the delegated Amazon Web Services administrator account for the organization.

Link to this function

get_services_in_scope(client, options \\ [])

View Source

Returns a list of the in-scope Amazon Web Services services for the specified assessment.

Link to this function

get_settings(client, attribute, options \\ [])

View Source

Returns the settings for the specified account.

Link to this function

list_assessment_frameworks(client, framework_type, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of the frameworks available in the Audit Manager framework library.

Link to this function

list_assessment_reports(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of assessment reports created in Audit Manager.

Link to this function

list_assessments(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of current and past assessments from Audit Manager.

Link to this function

list_controls(client, control_type, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of controls from Audit Manager.

Link to this function

list_keywords_for_data_source(client, max_results \\ nil, next_token \\ nil, source, options \\ [])

View Source

Returns a list of keywords that pre-mapped to the specified control data source.

Link to this function

list_notifications(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all Audit Manager notifications.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of tags for the specified resource in Audit Manager.

Link to this function

metadata()

View Source
Link to this function

register_account(client, input, options \\ [])

View Source

Enables Audit Manager for the specified account.

Link to this function

register_organization_admin_account(client, input, options \\ [])

View Source

Enables an account within the organization as the delegated administrator for Audit Manager.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags the specified resource in Audit Manager.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource in Audit Manager.

Link to this function

update_assessment(client, assessment_id, input, options \\ [])

View Source

Edits an Audit Manager assessment.

Link to this function

update_assessment_control(client, assessment_id, control_id, control_set_id, input, options \\ [])

View Source

Updates a control within an assessment in Audit Manager.

Link to this function

update_assessment_control_set_status(client, assessment_id, control_set_id, input, options \\ [])

View Source

Updates the status of a control set in an Audit Manager assessment.

Link to this function

update_assessment_framework(client, framework_id, input, options \\ [])

View Source

Updates a custom framework in Audit Manager.

Link to this function

update_assessment_status(client, assessment_id, input, options \\ [])

View Source

Updates the status of an assessment in Audit Manager.

Link to this function

update_control(client, control_id, input, options \\ [])

View Source

Updates a custom control in Audit Manager.

Link to this function

update_settings(client, input, options \\ [])

View Source

Updates Audit Manager settings for the current user account.

Link to this function

validate_assessment_report_integrity(client, input, options \\ [])

View Source

Validates the integrity of an assessment report in Audit Manager.