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.
auditmanager(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- auditmanager(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| associate_assessment_report_evidence_folder | Associates an evidence folder to an assessment report in an Audit Manager assessment |
| batch_associate_assessment_report_evidence | Associates a list of evidence to an assessment report in an Audit Manager assessment |
| batch_create_delegation_by_assessment | Creates a batch of delegations for an assessment in Audit Manager |
| batch_delete_delegation_by_assessment | Deletes a batch of delegations for an assessment in Audit Manager |
| batch_disassociate_assessment_report_evidence | Disassociates a list of evidence from an assessment report in Audit Manager |
| batch_import_evidence_to_assessment_control | Uploads one or more pieces of evidence to a control in an Audit Manager assessment |
| create_assessment | Creates an assessment in Audit Manager |
| create_assessment_framework | Creates a custom framework in Audit Manager |
| create_assessment_report | Creates an assessment report for the specified assessment |
| create_control | Creates a new custom control in Audit Manager |
| delete_assessment | Deletes an assessment in Audit Manager |
| delete_assessment_framework | Deletes a custom framework in Audit Manager |
| delete_assessment_framework_share | Deletes a share request for a custom framework in Audit Manager |
| delete_assessment_report | Deletes an assessment report in Audit Manager |
| delete_control | Deletes a custom control in Audit Manager |
| deregister_account | Deregisters an account in Audit Manager |
| deregister_organization_admin_account | Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager |
| disassociate_assessment_report_evidence_folder | Disassociates an evidence folder from the specified assessment report in Audit Manager |
| get_account_status | Returns the registration status of an account in Audit Manager |
| get_assessment | Returns an assessment from Audit Manager |
| get_assessment_framework | Returns a framework from Audit Manager |
| get_assessment_report_url | Returns the URL of an assessment report in Audit Manager |
| get_change_logs | Returns a list of changelogs from Audit Manager |
| get_control | Returns a control from Audit Manager |
| get_delegations | Returns a list of delegations from an audit owner to a delegate |
| get_evidence | Returns evidence from Audit Manager |
| get_evidence_by_evidence_folder | Returns all evidence from a specified evidence folder in Audit Manager |
| get_evidence_folder | Returns an evidence folder from the specified assessment in Audit Manager |
| get_evidence_folders_by_assessment | Returns the evidence folders from a specified assessment in Audit Manager |
| get_evidence_folders_by_assessment_control | Returns a list of evidence folders that are associated with a specified control in an Audit Manager assessment |
| get_insights | Gets the latest analytics data for all your current active assessments |
| get_insights_by_assessment | Gets the latest analytics data for a specific active assessment |
| get_organization_admin_account | Returns the name of the delegated Amazon Web Services administrator account for the organization |
| get_services_in_scope | Returns a list of all of the Amazon Web Services that you can choose to include in your assessment |
| get_settings | Returns the settings for the specified Amazon Web Services account |
| list_assessment_control_insights_by_control_domain | Lists the latest analytics data for controls within a specific control domain and a specific active assessment |
| list_assessment_frameworks | Returns a list of the frameworks that are available in the Audit Manager framework library |
| list_assessment_framework_share_requests | Returns a list of sent or received share requests for custom frameworks in Audit Manager |
| list_assessment_reports | Returns a list of assessment reports created in Audit Manager |
| list_assessments | Returns a list of current and past assessments from Audit Manager |
| list_control_domain_insights | Lists the latest analytics data for control domains across all of your active assessments |
| list_control_domain_insights_by_assessment | Lists analytics data for control domains within a specified active assessment |
| list_control_insights_by_control_domain | Lists the latest analytics data for controls within a specific control domain across all active assessments |
| list_controls | Returns a list of controls from Audit Manager |
| list_keywords_for_data_source | Returns a list of keywords that are pre-mapped to the specified control data source |
| list_notifications | Returns a list of all Audit Manager notifications |
| list_tags_for_resource | Returns a list of tags for the specified resource in Audit Manager |
| register_account | Enables Audit Manager for the specified Amazon Web Services account |
| register_organization_admin_account | Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager |
| start_assessment_framework_share | Creates a share request for a custom framework in Audit Manager |
| tag_resource | Tags the specified resource in Audit Manager |
| untag_resource | Removes a tag from a resource in Audit Manager |
| update_assessment | Edits an Audit Manager assessment |
| update_assessment_control | Updates a control within an assessment in Audit Manager |
| update_assessment_control_set_status | Updates the status of a control set in an Audit Manager assessment |
| update_assessment_framework | Updates a custom framework in Audit Manager |
| update_assessment_framework_share | Updates a share request for a custom framework in Audit Manager |
| update_assessment_status | Updates the status of an assessment in Audit Manager |
| update_control | Updates a custom control in Audit Manager |
| update_settings | Updates Audit Manager settings for the current account |
| validate_assessment_report_integrity | Validates the integrity of an assessment report in Audit Manager |
if (FALSE) {
svc <- auditmanager()
svc$associate_assessment_report_evidence_folder(
Foo = 123
)
}
Run the code above in your browser using DataLab