Auditmanager

This page documents function available when using the Auditmanager module, created with @service Auditmanager.

Index

Documentation

Main.Auditmanager.associate_assessment_report_evidence_folderMethod
associate_assessment_report_evidence_folder(assessment_id, evidence_folder_id)
associate_assessment_report_evidence_folder(assessment_id, evidence_folder_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • evidence_folder_id: The identifier for the folder in which evidence is stored.
source
Main.Auditmanager.batch_associate_assessment_report_evidenceMethod
batch_associate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids)
batch_associate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The unique identifier for the specified assessment.
  • evidence_folder_id: The identifier for the folder in which the evidence is stored.
  • evidence_ids: The list of evidence identifiers.
source
Main.Auditmanager.batch_create_delegation_by_assessmentMethod
batch_create_delegation_by_assessment(assessment_id, create_delegation_requests)
batch_create_delegation_by_assessment(assessment_id, create_delegation_requests, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • create_delegation_requests: The API request to batch create delegations in Audit Manager.
source
Main.Auditmanager.batch_delete_delegation_by_assessmentMethod
batch_delete_delegation_by_assessment(assessment_id, delegation_ids)
batch_delete_delegation_by_assessment(assessment_id, delegation_ids, params::Dict{String,<:Any})

Deletes the delegations in the specified Audit Manager assessment.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • delegation_ids: The identifiers for the specified delegations.
source
Main.Auditmanager.batch_disassociate_assessment_report_evidenceMethod
batch_disassociate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids)
batch_disassociate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • evidence_folder_id: The identifier for the folder in which evidence is stored.
  • evidence_ids: The list of evidence identifiers.
source
Main.Auditmanager.batch_import_evidence_to_assessment_controlMethod
batch_import_evidence_to_assessment_control(assessment_id, control_id, control_set_id, manual_evidence)
batch_import_evidence_to_assessment_control(assessment_id, control_id, control_set_id, manual_evidence, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • control_id: The identifier for the specified control.
  • control_set_id: The identifier for the specified control set.
  • manual_evidence: The list of manual evidence objects.
source
Main.Auditmanager.create_assessmentMethod
create_assessment(assessment_reports_destination, framework_id, name, roles, scope)
create_assessment(assessment_reports_destination, framework_id, name, roles, scope, params::Dict{String,<:Any})

Creates an assessment in Audit Manager.

Arguments

  • assessment_reports_destination: The assessment report storage destination for the specified assessment that is being created.
  • framework_id: The identifier for the specified framework.
  • name: The name of the assessment to be created.
  • roles: The list of roles for the specified assessment.
  • scope:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The optional description of the assessment to be created.
  • "tags": The tags associated with the assessment.
source
Main.Auditmanager.create_assessment_frameworkMethod
create_assessment_framework(control_sets, name)
create_assessment_framework(control_sets, name, params::Dict{String,<:Any})

Creates a custom framework in Audit Manager.

Arguments

  • control_sets: The control sets to be associated with the framework.
  • name: The name of the new custom framework.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "complianceType": The compliance type that the new custom framework supports, such as CIS or HIPAA.
  • "description": An optional description for the new custom framework.
  • "tags": The tags associated with the framework.
source
Main.Auditmanager.create_assessment_reportMethod
create_assessment_report(assessment_id, name)
create_assessment_report(assessment_id, name, params::Dict{String,<:Any})

Creates an assessment report for the specified assessment.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • name: The name of the new assessment report.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the assessment report.
source
Main.Auditmanager.create_controlMethod
create_control(control_mapping_sources, name)
create_control(control_mapping_sources, name, params::Dict{String,<:Any})

Creates a new custom control in Audit Manager.

Arguments

  • control_mapping_sources: The data mapping sources for the specified control.
  • name: The name of the control.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "actionPlanInstructions": The recommended actions to carry out if the control is not fulfilled.
  • "actionPlanTitle": The title of the action plan for remediating the control.
  • "description": The description of the control.
  • "tags": The tags associated with the control.
  • "testingInformation": The steps to follow to determine if the control has been satisfied.
source
Main.Auditmanager.delete_assessmentMethod
delete_assessment(assessment_id)
delete_assessment(assessment_id, params::Dict{String,<:Any})

Deletes an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.
source
Main.Auditmanager.delete_assessment_frameworkMethod
delete_assessment_framework(framework_id)
delete_assessment_framework(framework_id, params::Dict{String,<:Any})

Deletes a custom framework in Audit Manager.

Arguments

  • framework_id: The identifier for the specified framework.
source
Main.Auditmanager.delete_assessment_reportMethod
delete_assessment_report(assessment_id, assessment_report_id)
delete_assessment_report(assessment_id, assessment_report_id, params::Dict{String,<:Any})

Deletes an assessment report from an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • assessment_report_id: The unique identifier for the assessment report.
source
Main.Auditmanager.delete_controlMethod
delete_control(control_id)
delete_control(control_id, params::Dict{String,<:Any})

Deletes a custom control in Audit Manager.

Arguments

  • control_id: The identifier for the specified control.
source
Main.Auditmanager.deregister_organization_admin_accountMethod
deregister_organization_admin_account()
deregister_organization_admin_account(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "adminAccountId": The identifier for the specified administrator account.
source
Main.Auditmanager.disassociate_assessment_report_evidence_folderMethod
disassociate_assessment_report_evidence_folder(assessment_id, evidence_folder_id)
disassociate_assessment_report_evidence_folder(assessment_id, evidence_folder_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • evidence_folder_id: The identifier for the folder in which evidence is stored.
source
Main.Auditmanager.get_assessmentMethod
get_assessment(assessment_id)
get_assessment(assessment_id, params::Dict{String,<:Any})

Returns an assessment from Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.
source
Main.Auditmanager.get_assessment_frameworkMethod
get_assessment_framework(framework_id)
get_assessment_framework(framework_id, params::Dict{String,<:Any})

Returns a framework from Audit Manager.

Arguments

  • framework_id: The identifier for the specified framework.
source
Main.Auditmanager.get_assessment_report_urlMethod
get_assessment_report_url(assessment_id, assessment_report_id)
get_assessment_report_url(assessment_id, assessment_report_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • assessment_report_id: The identifier for the assessment report.
source
Main.Auditmanager.get_change_logsMethod
get_change_logs(assessment_id)
get_change_logs(assessment_id, params::Dict{String,<:Any})

Returns a list of changelogs from Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "controlId": The identifier for the specified control.
  • "controlSetId": The identifier for the specified control set.
  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.get_controlMethod
get_control(control_id)
get_control(control_id, params::Dict{String,<:Any})

Returns a control from Audit Manager.

Arguments

  • control_id: The identifier for the specified control.
source
Main.Auditmanager.get_delegationsMethod
get_delegations()
get_delegations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.get_evidenceMethod
get_evidence(assessment_id, control_set_id, evidence_folder_id, evidence_id)
get_evidence(assessment_id, control_set_id, evidence_folder_id, evidence_id, params::Dict{String,<:Any})

Returns evidence from Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • control_set_id: The identifier for the specified control set.
  • evidence_folder_id: The identifier for the folder in which the evidence is stored.
  • evidence_id: The identifier for the evidence.
source
Main.Auditmanager.get_evidence_by_evidence_folderMethod
get_evidence_by_evidence_folder(assessment_id, control_set_id, evidence_folder_id)
get_evidence_by_evidence_folder(assessment_id, control_set_id, evidence_folder_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • control_set_id: The identifier for the control set.
  • evidence_folder_id: The unique identifier for the folder in which the evidence is stored.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.get_evidence_folderMethod
get_evidence_folder(assessment_id, control_set_id, evidence_folder_id)
get_evidence_folder(assessment_id, control_set_id, evidence_folder_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • control_set_id: The identifier for the specified control set.
  • evidence_folder_id: The identifier for the folder in which the evidence is stored.
source
Main.Auditmanager.get_evidence_folders_by_assessmentMethod
get_evidence_folders_by_assessment(assessment_id)
get_evidence_folders_by_assessment(assessment_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.get_evidence_folders_by_assessment_controlMethod
get_evidence_folders_by_assessment_control(assessment_id, control_id, control_set_id)
get_evidence_folders_by_assessment_control(assessment_id, control_id, control_set_id, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • control_id: The identifier for the specified control.
  • control_set_id: The identifier for the specified control set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.get_settingsMethod
get_settings(attribute)
get_settings(attribute, params::Dict{String,<:Any})

Returns the settings for the specified account.

Arguments

  • attribute: The list of SettingAttribute enum values.
source
Main.Auditmanager.list_assessment_frameworksMethod
list_assessment_frameworks(framework_type)
list_assessment_frameworks(framework_type, params::Dict{String,<:Any})

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

Arguments

  • framework_type: The type of framework, such as standard or custom.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.list_assessment_reportsMethod
list_assessment_reports()
list_assessment_reports(params::Dict{String,<:Any})

Returns a list of assessment reports created in Audit Manager.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.list_assessmentsMethod
list_assessments()
list_assessments(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.list_controlsMethod
list_controls(control_type)
list_controls(control_type, params::Dict{String,<:Any})

Returns a list of controls from Audit Manager.

Arguments

  • control_type: The type of control, such as standard or custom.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.list_keywords_for_data_sourceMethod
list_keywords_for_data_source(source)
list_keywords_for_data_source(source, params::Dict{String,<:Any})

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

Arguments

  • source: The control mapping data source to which the keywords apply.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.list_notificationsMethod
list_notifications()
list_notifications(params::Dict{String,<:Any})

Returns a list of all Audit Manager notifications.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Represents the maximum number of results per page, or per API request call.
  • "nextToken": The pagination token used to fetch the next set of results.
source
Main.Auditmanager.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the specified resource.
source
Main.Auditmanager.register_accountMethod
register_account()
register_account(params::Dict{String,<:Any})

Enables Audit Manager for the specified account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "delegatedAdminAccount": The delegated administrator account for Audit Manager.
  • "kmsKey": The KMS key details.
source
Main.Auditmanager.register_organization_admin_accountMethod
register_organization_admin_account(admin_account_id)
register_organization_admin_account(admin_account_id, params::Dict{String,<:Any})

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

Arguments

  • admin_account_id: The identifier for the specified delegated administrator account.
source
Main.Auditmanager.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Tags the specified resource in Audit Manager.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the specified resource.
  • tags: The tags to be associated with the resource.
source
Main.Auditmanager.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from a resource in Audit Manager.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the specified resource.
  • tag_keys: The name or key of the tag.
source
Main.Auditmanager.update_assessmentMethod
update_assessment(assessment_id, scope)
update_assessment(assessment_id, scope, params::Dict{String,<:Any})

Edits an Audit Manager assessment.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • scope: The scope of the specified assessment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assessmentDescription": The description of the specified assessment.
  • "assessmentName": The name of the specified assessment to be updated.
  • "assessmentReportsDestination": The assessment report storage destination for the specified assessment that is being updated.
  • "roles": The list of roles for the specified assessment.
source
Main.Auditmanager.update_assessment_controlMethod
update_assessment_control(assessment_id, control_id, control_set_id)
update_assessment_control(assessment_id, control_id, control_set_id, params::Dict{String,<:Any})

Updates a control within an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • control_id: The identifier for the specified control.
  • control_set_id: The identifier for the specified control set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "commentBody": The comment body text for the specified control.
  • "controlStatus": The status of the specified control.
source
Main.Auditmanager.update_assessment_control_set_statusMethod
update_assessment_control_set_status(assessment_id, comment, control_set_id, status)
update_assessment_control_set_status(assessment_id, comment, control_set_id, status, params::Dict{String,<:Any})

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

Arguments

  • assessment_id: The identifier for the specified assessment.
  • comment: The comment related to the status update.
  • control_set_id: The identifier for the specified control set.
  • status: The status of the control set that is being updated.
source
Main.Auditmanager.update_assessment_frameworkMethod
update_assessment_framework(control_sets, framework_id, name)
update_assessment_framework(control_sets, framework_id, name, params::Dict{String,<:Any})

Updates a custom framework in Audit Manager.

Arguments

  • control_sets: The control sets associated with the framework.
  • framework_id: The identifier for the specified framework.
  • name: The name of the framework to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "complianceType": The compliance type that the new custom framework supports, such as CIS or HIPAA.
  • "description": The description of the framework that is to be updated.
source
Main.Auditmanager.update_assessment_statusMethod
update_assessment_status(assessment_id, status)
update_assessment_status(assessment_id, status, params::Dict{String,<:Any})

Updates the status of an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the specified assessment.
  • status: The current status of the specified assessment.
source
Main.Auditmanager.update_controlMethod
update_control(control_id, control_mapping_sources, name)
update_control(control_id, control_mapping_sources, name, params::Dict{String,<:Any})

Updates a custom control in Audit Manager.

Arguments

  • control_id: The identifier for the specified control.
  • control_mapping_sources: The data mapping sources for the specified control.
  • name: The name of the control to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "actionPlanInstructions": The recommended actions to carry out if the control is not fulfilled.
  • "actionPlanTitle": The title of the action plan for remediating the control.
  • "description": The optional description of the control.
  • "testingInformation": The steps that to follow to determine if the control has been satisfied.
source
Main.Auditmanager.update_settingsMethod
update_settings()
update_settings(params::Dict{String,<:Any})

Updates Audit Manager settings for the current user account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "defaultAssessmentReportsDestination": The default storage destination for assessment reports.
  • "defaultProcessOwners": A list of the default audit owners.
  • "kmsKey": The KMS key details.
  • "snsTopic": The Amazon Simple Notification Service (Amazon SNS) topic to which Audit Manager sends notifications.
source
Main.Auditmanager.validate_assessment_report_integrityMethod
validate_assessment_report_integrity(s3_relative_path)
validate_assessment_report_integrity(s3_relative_path, params::Dict{String,<:Any})

Validates the integrity of an assessment report in Audit Manager.

Arguments

  • s3_relative_path: The relative path of the specified Amazon S3 bucket in which the assessment report is stored.
source