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 an assessment report in a Audit Manager assessment.

Arguments

  • assessment_id: The identifier for the assessment.
  • evidence_folder_id: The identifier for the folder that the evidence is stored in.
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 identifier for the assessment.
  • evidence_folder_id: The identifier for the folder that the evidence is stored in.
  • 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})

Creates a batch of delegations for an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the 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 a batch of delegations for an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the assessment.
  • delegation_ids: The identifiers for the 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 an assessment report in Audit Manager.

Arguments

  • assessment_id: The identifier for the assessment.
  • evidence_folder_id: The identifier for the folder that the evidence is stored in.
  • 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 a control in an Audit Manager assessment. You can upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by specifying the S3 URI of the evidence. You must upload manual evidence to your S3 bucket before you can upload it to your assessment. For instructions, see CreateBucket and PutObject in the Amazon Simple Storage Service API Reference. The following restrictions apply to this action: Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager.

Arguments

  • assessment_id: The identifier for the assessment.
  • control_id: The identifier for the control.
  • control_set_id: The identifier for the 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 assessment that's being created.
  • framework_id: The identifier for the framework that the assessment will be created from.
  • name: The name of the assessment to be created.
  • roles: The list of roles for the 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 that are 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 that are 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 that are 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 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.
  • "queryStatement": A SQL statement that represents an evidence finder query. Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API. To use this parameter, the enablementStatus of evidence finder must be ENABLED. For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the AWS Audit Manager User Guide.
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 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 isn't fulfilled.
  • "actionPlanTitle": The title of the action plan for remediating the control.
  • "description": The description of the control.
  • "tags": The tags that are associated with the control.
  • "testingInformation": The steps to follow to determine if the control is 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 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 custom framework.
source
Main.Auditmanager.delete_assessment_framework_shareMethod
delete_assessment_framework_share(request_id, request_type)
delete_assessment_framework_share(request_id, request_type, params::Dict{String,<:Any})

Deletes a share request for a custom framework in Audit Manager.

Arguments

  • request_id: The unique identifier for the share request to be deleted.
  • request_type: Specifies whether the share request is a sent request or a received request.
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 in Audit Manager. When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data: The specified assessment report that’s stored in your S3 bucket The associated metadata that’s stored in Audit Manager If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API Reference.

Arguments

  • assessment_id: The unique identifier for the 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 unique identifier for the control.
source
Main.Auditmanager.deregister_accountMethod
deregister_account()
deregister_account(params::Dict{String,<:Any})

Deregisters an account in Audit Manager. When you deregister your account from Audit Manager, your data isn’t deleted. If you want to delete your resource data, you must perform that task separately before you deregister your account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions: DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide) DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide) At this time, Audit Manager doesn't provide an option to delete evidence. All available delete operations are listed above.

source
Main.Auditmanager.deregister_organization_admin_accountMethod
deregister_organization_admin_account()
deregister_organization_admin_account(params::Dict{String,<:Any})

Removes the specified 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 Organizations. However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward. Keep in mind the following cleanup task if you use evidence finder: Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store. This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager will ignore an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it. When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions: DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide) DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide) At this time, Audit Manager doesn't provide an option to delete evidence. All available delete operations are listed above.

Optional Parameters

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

  • "adminAccountId": The identifier for the 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 unique identifier for the assessment.
  • evidence_folder_id: The unique identifier for the folder that the evidence is stored in.
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 unique identifier for the 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 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 an assessment report in Audit Manager.

Arguments

  • assessment_id: The unique identifier for the assessment.
  • assessment_report_id: The unique 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 unique identifier for the assessment.

Optional Parameters

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

  • "controlId": The unique identifier for the control.
  • "controlSetId": The unique identifier for the control set.
  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 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 on a page or for an API request call.
  • "nextToken": The pagination token that's 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 unique identifier for the assessment.
  • control_set_id: The unique identifier for the control set.
  • evidence_folder_id: The unique identifier for the folder that the evidence is stored in.
  • evidence_id: The unique 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 assessment.
  • control_set_id: The identifier for the control set.
  • evidence_folder_id: The unique identifier for the folder that the evidence is stored in.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 unique identifier for the assessment.
  • control_set_id: The unique identifier for the control set.
  • evidence_folder_id: The unique identifier for the folder that the evidence is stored in.
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 unique identifier for the assessment.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 that are associated with a specified control of an assessment in Audit Manager.

Arguments

  • assessment_id: The identifier for the assessment.
  • control_id: The identifier for the control.
  • control_set_id: The identifier for the 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 on a page or for an API request call.
  • "nextToken": The pagination token that's used to fetch the next set of results.
source
Main.Auditmanager.get_insights_by_assessmentMethod
get_insights_by_assessment(assessment_id)
get_insights_by_assessment(assessment_id, params::Dict{String,<:Any})

Gets the latest analytics data for a specific active assessment.

Arguments

  • assessment_id: The unique identifier for the assessment.
source
Main.Auditmanager.get_services_in_scopeMethod
get_services_in_scope()
get_services_in_scope(params::Dict{String,<:Any})

Returns a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an assessment, specify which of these services you want to include to narrow the assessment's scope.

source
Main.Auditmanager.get_settingsMethod
get_settings(attribute)
get_settings(attribute, params::Dict{String,<:Any})

Returns the settings for the specified Amazon Web Services account.

Arguments

  • attribute: The list of SettingAttribute enum values.
source
Main.Auditmanager.list_assessment_control_insights_by_control_domainMethod
list_assessment_control_insights_by_control_domain(assessment_id, control_domain_id)
list_assessment_control_insights_by_control_domain(assessment_id, control_domain_id, params::Dict{String,<:Any})

Lists 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 the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.

Arguments

  • assessment_id: The unique identifier for the active assessment.
  • control_domain_id: The unique identifier for the control domain.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's used to fetch the next set of results.
source
Main.Auditmanager.list_assessment_framework_share_requestsMethod
list_assessment_framework_share_requests(request_type)
list_assessment_framework_share_requests(request_type, params::Dict{String,<:Any})

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

Arguments

  • request_type: Specifies whether the share request is a sent request or a received request.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's used to fetch the next set of results.
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 that are available in the Audit Manager framework library.

Arguments

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

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 on a page or for an API request call.
  • "nextToken": The pagination token that's 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 on a page or for an API request call.
  • "nextToken": The pagination token that's used to fetch the next set of results.
  • "status": The current status of the assessment.
source
Main.Auditmanager.list_control_domain_insightsMethod
list_control_domain_insights()
list_control_domain_insights(params::Dict{String,<:Any})

Lists 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 the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's used to fetch the next set of results.
source
Main.Auditmanager.list_control_domain_insights_by_assessmentMethod
list_control_domain_insights_by_assessment(assessment_id)
list_control_domain_insights_by_assessment(assessment_id, params::Dict{String,<:Any})

Lists 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 the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

Arguments

  • assessment_id: The unique identifier for the active assessment.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's used to fetch the next set of results.
source
Main.Auditmanager.list_control_insights_by_control_domainMethod
list_control_insights_by_control_domain(control_domain_id)
list_control_insights_by_control_domain(control_domain_id, params::Dict{String,<:Any})

Lists 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 the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.

Arguments

  • control_domain_id: The unique identifier for the control domain.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 a standard control or a custom control.

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 are pre-mapped to the specified control data source.

Arguments

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

Optional Parameters

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

  • "maxResults": Represents the maximum number of results on a page or for an API request call.
  • "nextToken": The pagination token that's 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 on a page or for an API request call.
  • "nextToken": The pagination token that's 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 resource.
source
Main.Auditmanager.register_accountMethod
register_account()
register_account(params::Dict{String,<:Any})

Enables Audit Manager for the specified Amazon Web Services 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 Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

Arguments

  • admin_account_id: The identifier for the delegated administrator account.
source
Main.Auditmanager.start_assessment_framework_shareMethod
start_assessment_framework_share(destination_account, destination_region, framework_id)
start_assessment_framework_share(destination_account, destination_region, framework_id, params::Dict{String,<:Any})

Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs: The sender revokes the share request. The recipient declines the share request. The recipient encounters an error and doesn't successfully accept the share request. The share request expires before the recipient responds to the request. When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide.

Arguments

  • destination_account: The Amazon Web Services account of the recipient.
  • destination_region: The Amazon Web Services Region of the recipient.
  • framework_id: The unique identifier for the custom framework to be shared.

Optional Parameters

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

  • "comment": An optional comment from the sender about the share request.
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 resource.
  • tags: The tags that are 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 unique identifier for the assessment.
  • scope: The scope of the assessment.

Optional Parameters

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

  • "assessmentDescription": The description of the assessment.
  • "assessmentName": The name of the assessment to be updated.
  • "assessmentReportsDestination": The assessment report storage destination for the assessment that's being updated.
  • "roles": The list of roles for the 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 unique identifier for the assessment.
  • control_id: The unique identifier for the control.
  • control_set_id: The unique identifier for the 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 control.
  • "controlStatus": The status of the 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 unique identifier for the assessment.
  • comment: The comment that's related to the status update.
  • control_set_id: The unique identifier for the control set.
  • status: The status of the control set that's 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 that are associated with the framework.
  • framework_id: The unique identifier for the 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 updated framework.
source
Main.Auditmanager.update_assessment_framework_shareMethod
update_assessment_framework_share(action, request_id, request_type)
update_assessment_framework_share(action, request_id, request_type, params::Dict{String,<:Any})

Updates a share request for a custom framework in Audit Manager.

Arguments

  • action: Specifies the update action for the share request.
  • request_id: The unique identifier for the share request.
  • request_type: Specifies whether the share request is a sent request or a received request.
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 unique identifier for the assessment.
  • status: The current status of the 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 control.
  • control_mapping_sources: The data mapping sources for the control.
  • name: The name of the updated 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 isn't fulfilled.
  • "actionPlanTitle": The title of the action plan for remediating the control.
  • "description": The optional description of the control.
  • "testingInformation": The steps that you should follow to determine if the control is met.
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.
  • "evidenceFinderEnabled": Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder. When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager. Disabling evidence finder is permanent, so consider this decision carefully before you proceed. If you’re using Audit Manager as a delegated administrator, keep in mind that this action applies to all member accounts in your organization.
  • "kmsKey": The KMS key details.
  • "snsTopic": The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.
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 Amazon S3 bucket that the assessment report is stored in.
source