Class: Aws::AuditManager::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AuditManager::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-auditmanager/client.rb
Overview
An API client for AuditManager. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::AuditManager::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Associates an evidence folder to an assessment report in a Audit Manager assessment.
-
#batch_associate_assessment_report_evidence(params = {}) ⇒ Types::BatchAssociateAssessmentReportEvidenceResponse
Associates a list of evidence to an assessment report in an Audit Manager assessment.
-
#batch_create_delegation_by_assessment(params = {}) ⇒ Types::BatchCreateDelegationByAssessmentResponse
Creates a batch of delegations for an assessment in Audit Manager.
-
#batch_delete_delegation_by_assessment(params = {}) ⇒ Types::BatchDeleteDelegationByAssessmentResponse
Deletes a batch of delegations for an assessment in Audit Manager.
-
#batch_disassociate_assessment_report_evidence(params = {}) ⇒ Types::BatchDisassociateAssessmentReportEvidenceResponse
Disassociates a list of evidence from an assessment report in Audit Manager.
-
#batch_import_evidence_to_assessment_control(params = {}) ⇒ Types::BatchImportEvidenceToAssessmentControlResponse
Uploads one or more pieces of evidence to a control in an Audit Manager assessment.
-
#create_assessment(params = {}) ⇒ Types::CreateAssessmentResponse
Creates an assessment in Audit Manager.
-
#create_assessment_framework(params = {}) ⇒ Types::CreateAssessmentFrameworkResponse
Creates a custom framework in Audit Manager.
-
#create_assessment_report(params = {}) ⇒ Types::CreateAssessmentReportResponse
Creates an assessment report for the specified assessment.
-
#create_control(params = {}) ⇒ Types::CreateControlResponse
Creates a new custom control in Audit Manager.
-
#delete_assessment(params = {}) ⇒ Struct
Deletes an assessment in Audit Manager.
-
#delete_assessment_framework(params = {}) ⇒ Struct
Deletes a custom framework in Audit Manager.
-
#delete_assessment_framework_share(params = {}) ⇒ Struct
Deletes a share request for a custom framework in Audit Manager.
-
#delete_assessment_report(params = {}) ⇒ Struct
Deletes an assessment report in Audit Manager.
-
#delete_control(params = {}) ⇒ Struct
Deletes a custom control in Audit Manager.
-
#deregister_account(params = {}) ⇒ Types::DeregisterAccountResponse
Deregisters an account in Audit Manager.
-
#deregister_organization_admin_account(params = {}) ⇒ Struct
Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.
-
#disassociate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Disassociates an evidence folder from the specified assessment report in Audit Manager.
-
#get_account_status(params = {}) ⇒ Types::GetAccountStatusResponse
Returns the registration status of an account in Audit Manager.
-
#get_assessment(params = {}) ⇒ Types::GetAssessmentResponse
Returns an assessment from Audit Manager.
-
#get_assessment_framework(params = {}) ⇒ Types::GetAssessmentFrameworkResponse
Returns a framework from Audit Manager.
-
#get_assessment_report_url(params = {}) ⇒ Types::GetAssessmentReportUrlResponse
Returns the URL of an assessment report in Audit Manager.
-
#get_change_logs(params = {}) ⇒ Types::GetChangeLogsResponse
Returns a list of changelogs from Audit Manager.
-
#get_control(params = {}) ⇒ Types::GetControlResponse
Returns a control from Audit Manager.
-
#get_delegations(params = {}) ⇒ Types::GetDelegationsResponse
Returns a list of delegations from an audit owner to a delegate.
-
#get_evidence(params = {}) ⇒ Types::GetEvidenceResponse
Returns evidence from Audit Manager.
-
#get_evidence_by_evidence_folder(params = {}) ⇒ Types::GetEvidenceByEvidenceFolderResponse
Returns all evidence from a specified evidence folder in Audit Manager.
-
#get_evidence_folder(params = {}) ⇒ Types::GetEvidenceFolderResponse
Returns an evidence folder from the specified assessment in Audit Manager.
-
#get_evidence_folders_by_assessment(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentResponse
Returns the evidence folders from a specified assessment in Audit Manager.
-
#get_evidence_folders_by_assessment_control(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentControlResponse
Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager.
-
#get_insights(params = {}) ⇒ Types::GetInsightsResponse
Gets the latest analytics data for all your current active assessments.
-
#get_insights_by_assessment(params = {}) ⇒ Types::GetInsightsByAssessmentResponse
Gets the latest analytics data for a specific active assessment.
-
#get_organization_admin_account(params = {}) ⇒ Types::GetOrganizationAdminAccountResponse
Returns the name of the delegated Amazon Web Services administrator account for the organization.
-
#get_services_in_scope(params = {}) ⇒ Types::GetServicesInScopeResponse
Returns a list of all of the Amazon Web Services that you can choose to include in your assessment.
-
#get_settings(params = {}) ⇒ Types::GetSettingsResponse
Returns the settings for the specified Amazon Web Services account.
-
#list_assessment_control_insights_by_control_domain(params = {}) ⇒ Types::ListAssessmentControlInsightsByControlDomainResponse
Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
-
#list_assessment_framework_share_requests(params = {}) ⇒ Types::ListAssessmentFrameworkShareRequestsResponse
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
-
#list_assessment_frameworks(params = {}) ⇒ Types::ListAssessmentFrameworksResponse
Returns a list of the frameworks that are available in the Audit Manager framework library.
-
#list_assessment_reports(params = {}) ⇒ Types::ListAssessmentReportsResponse
Returns a list of assessment reports created in Audit Manager.
-
#list_assessments(params = {}) ⇒ Types::ListAssessmentsResponse
Returns a list of current and past assessments from Audit Manager.
-
#list_control_domain_insights(params = {}) ⇒ Types::ListControlDomainInsightsResponse
Lists the latest analytics data for control domains across all of your active assessments.
-
#list_control_domain_insights_by_assessment(params = {}) ⇒ Types::ListControlDomainInsightsByAssessmentResponse
Lists analytics data for control domains within a specified active assessment.
-
#list_control_insights_by_control_domain(params = {}) ⇒ Types::ListControlInsightsByControlDomainResponse
Lists the latest analytics data for controls within a specific control domain across all active assessments.
-
#list_controls(params = {}) ⇒ Types::ListControlsResponse
Returns a list of controls from Audit Manager.
-
#list_keywords_for_data_source(params = {}) ⇒ Types::ListKeywordsForDataSourceResponse
Returns a list of keywords that are pre-mapped to the specified control data source.
-
#list_notifications(params = {}) ⇒ Types::ListNotificationsResponse
Returns a list of all Audit Manager notifications.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for the specified resource in Audit Manager.
-
#register_account(params = {}) ⇒ Types::RegisterAccountResponse
Enables Audit Manager for the specified Amazon Web Services account.
-
#register_organization_admin_account(params = {}) ⇒ Types::RegisterOrganizationAdminAccountResponse
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
-
#start_assessment_framework_share(params = {}) ⇒ Types::StartAssessmentFrameworkShareResponse
Creates a share request for a custom framework in Audit Manager.
-
#tag_resource(params = {}) ⇒ Struct
Tags the specified resource in Audit Manager.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource in Audit Manager.
-
#update_assessment(params = {}) ⇒ Types::UpdateAssessmentResponse
Edits an Audit Manager assessment.
-
#update_assessment_control(params = {}) ⇒ Types::UpdateAssessmentControlResponse
Updates a control within an assessment in Audit Manager.
-
#update_assessment_control_set_status(params = {}) ⇒ Types::UpdateAssessmentControlSetStatusResponse
Updates the status of a control set in an Audit Manager assessment.
-
#update_assessment_framework(params = {}) ⇒ Types::UpdateAssessmentFrameworkResponse
Updates a custom framework in Audit Manager.
-
#update_assessment_framework_share(params = {}) ⇒ Types::UpdateAssessmentFrameworkShareResponse
Updates a share request for a custom framework in Audit Manager.
-
#update_assessment_status(params = {}) ⇒ Types::UpdateAssessmentStatusResponse
Updates the status of an assessment in Audit Manager.
-
#update_control(params = {}) ⇒ Types::UpdateControlResponse
Updates a custom control in Audit Manager.
-
#update_settings(params = {}) ⇒ Types::UpdateSettingsResponse
Updates Audit Manager settings for the current user account.
-
#validate_assessment_report_integrity(params = {}) ⇒ Types::ValidateAssessmentReportIntegrityResponse
Validates the integrity of an assessment report in Audit Manager.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 365 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3817 3818 3819 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3817 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3820 3821 3822 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3820 def errors_module Errors end |
Instance Method Details
#associate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Associates an evidence folder to an assessment report in a Audit Manager assessment.
393 394 395 396 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 393 def associate_assessment_report_evidence_folder(params = {}, = {}) req = build_request(:associate_assessment_report_evidence_folder, params) req.send_request() end |
#batch_associate_assessment_report_evidence(params = {}) ⇒ Types::BatchAssociateAssessmentReportEvidenceResponse
Associates a list of evidence to an assessment report in an Audit Manager assessment.
436 437 438 439 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 436 def batch_associate_assessment_report_evidence(params = {}, = {}) req = build_request(:batch_associate_assessment_report_evidence, params) req.send_request() end |
#batch_create_delegation_by_assessment(params = {}) ⇒ Types::BatchCreateDelegationByAssessmentResponse
Creates a batch of delegations for an assessment in Audit Manager.
494 495 496 497 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 494 def batch_create_delegation_by_assessment(params = {}, = {}) req = build_request(:batch_create_delegation_by_assessment, params) req.send_request() end |
#batch_delete_delegation_by_assessment(params = {}) ⇒ Types::BatchDeleteDelegationByAssessmentResponse
Deletes a batch of delegations for an assessment in Audit Manager.
529 530 531 532 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 529 def batch_delete_delegation_by_assessment(params = {}, = {}) req = build_request(:batch_delete_delegation_by_assessment, params) req.send_request() end |
#batch_disassociate_assessment_report_evidence(params = {}) ⇒ Types::BatchDisassociateAssessmentReportEvidenceResponse
Disassociates a list of evidence from an assessment report in Audit Manager.
572 573 574 575 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 572 def batch_disassociate_assessment_report_evidence(params = {}, = {}) req = build_request(:batch_disassociate_assessment_report_evidence, params) req.send_request() end |
#batch_import_evidence_to_assessment_control(params = {}) ⇒ Types::BatchImportEvidenceToAssessmentControlResponse
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].
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html [3]: docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files [4]: docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html
646 647 648 649 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 646 def batch_import_evidence_to_assessment_control(params = {}, = {}) req = build_request(:batch_import_evidence_to_assessment_control, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3795 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-auditmanager' context[:gem_version] = '1.28.0' Seahorse::Client::Request.new(handlers, context) end |
#create_assessment(params = {}) ⇒ Types::CreateAssessmentResponse
Creates an assessment in Audit Manager.
800 801 802 803 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 800 def create_assessment(params = {}, = {}) req = build_request(:create_assessment, params) req.send_request() end |
#create_assessment_framework(params = {}) ⇒ Types::CreateAssessmentFrameworkResponse
Creates a custom framework in Audit Manager.
898 899 900 901 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 898 def create_assessment_framework(params = {}, = {}) req = build_request(:create_assessment_framework, params) req.send_request() end |
#create_assessment_report(params = {}) ⇒ Types::CreateAssessmentReportResponse
Creates an assessment report for the specified assessment.
967 968 969 970 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 967 def create_assessment_report(params = {}, = {}) req = build_request(:create_assessment_report, params) req.send_request() end |
#create_control(params = {}) ⇒ Types::CreateControlResponse
Creates a new custom control in Audit Manager.
1058 1059 1060 1061 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1058 def create_control(params = {}, = {}) req = build_request(:create_control, params) req.send_request() end |
#delete_assessment(params = {}) ⇒ Struct
Deletes an assessment in Audit Manager.
1080 1081 1082 1083 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1080 def delete_assessment(params = {}, = {}) req = build_request(:delete_assessment, params) req.send_request() end |
#delete_assessment_framework(params = {}) ⇒ Struct
Deletes a custom framework in Audit Manager.
1102 1103 1104 1105 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1102 def delete_assessment_framework(params = {}, = {}) req = build_request(:delete_assessment_framework, params) req.send_request() end |
#delete_assessment_framework_share(params = {}) ⇒ Struct
Deletes a share request for a custom framework in Audit Manager.
1129 1130 1131 1132 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1129 def delete_assessment_framework_share(params = {}, = {}) req = build_request(:delete_assessment_framework_share, params) req.send_request() end |
#delete_assessment_report(params = {}) ⇒ Struct
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*.
[1]: docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination [2]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
1183 1184 1185 1186 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1183 def delete_assessment_report(params = {}, = {}) req = build_request(:delete_assessment_report, params) req.send_request() end |
#delete_control(params = {}) ⇒ Struct
Deletes a custom control in Audit Manager.
1205 1206 1207 1208 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1205 def delete_control(params = {}, = {}) req = build_request(:delete_control, params) req.send_request() end |
#deregister_account(params = {}) ⇒ Types::DeregisterAccountResponse
Deregisters an account in Audit Manager.
<note markdown=“1”> 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][1] (see also: [Deleting an assessment][2] in the
*Audit Manager User Guide*)
- DeleteAssessmentFramework][3
-
(see also: [Deleting a custom
framework] in the *Audit Manager User Guide*)
- DeleteAssessmentFrameworkShare][5
-
(see also: [Deleting a share
request] in the *Audit Manager User Guide*)
- DeleteAssessmentReport][7
-
(see also: [Deleting an assessment
report] in the *Audit Manager User Guide*)
- DeleteControl][9
-
(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.
</note>
[1]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html [2]: docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html [3]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html [4]: docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html [5]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html [6]: docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html [7]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html [8]: docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps [9]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html [10]: docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html
1266 1267 1268 1269 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1266 def deregister_account(params = {}, = {}) req = build_request(:deregister_account, params) req.send_request() end |
#deregister_organization_admin_account(params = {}) ⇒ Struct
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][2
-
(see also: [Deleting an assessment] in the
*Audit Manager User Guide*)
- DeleteAssessmentFramework][4
-
(see also: [Deleting a custom
framework] in the *Audit Manager User Guide*)
- DeleteAssessmentFrameworkShare][6
-
(see also: [Deleting a share
request] in the *Audit Manager User Guide*)
- DeleteAssessmentReport][8
-
(see also: [Deleting an assessment
report] in the *Audit Manager User Guide*)
- DeleteControl][10
-
(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.
[1]: docs.aws.amazon.com/userguide/awscloudtrail/latest/userguide/query-eds-disable-termination.html [2]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html [3]: docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html [4]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html [5]: docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html [6]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html [7]: docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html [8]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html [9]: docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps [10]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html [11]: docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html
1356 1357 1358 1359 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1356 def deregister_organization_admin_account(params = {}, = {}) req = build_request(:deregister_organization_admin_account, params) req.send_request() end |
#disassociate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Disassociates an evidence folder from the specified assessment report in Audit Manager.
1383 1384 1385 1386 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1383 def disassociate_assessment_report_evidence_folder(params = {}, = {}) req = build_request(:disassociate_assessment_report_evidence_folder, params) req.send_request() end |
#get_account_status(params = {}) ⇒ Types::GetAccountStatusResponse
Returns the registration status of an account in Audit Manager.
1402 1403 1404 1405 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1402 def get_account_status(params = {}, = {}) req = build_request(:get_account_status, params) req.send_request() end |
#get_assessment(params = {}) ⇒ Types::GetAssessmentResponse
Returns an assessment from Audit Manager.
1509 1510 1511 1512 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1509 def get_assessment(params = {}, = {}) req = build_request(:get_assessment, params) req.send_request() end |
#get_assessment_framework(params = {}) ⇒ Types::GetAssessmentFrameworkResponse
Returns a framework from Audit Manager.
1579 1580 1581 1582 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1579 def get_assessment_framework(params = {}, = {}) req = build_request(:get_assessment_framework, params) req.send_request() end |
#get_assessment_report_url(params = {}) ⇒ Types::GetAssessmentReportUrlResponse
Returns the URL of an assessment report in Audit Manager.
1612 1613 1614 1615 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1612 def get_assessment_report_url(params = {}, = {}) req = build_request(:get_assessment_report_url, params) req.send_request() end |
#get_change_logs(params = {}) ⇒ Types::GetChangeLogsResponse
Returns a list of changelogs from Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1666 1667 1668 1669 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1666 def get_change_logs(params = {}, = {}) req = build_request(:get_change_logs, params) req.send_request() end |
#get_control(params = {}) ⇒ Types::GetControlResponse
Returns a control from Audit Manager.
1718 1719 1720 1721 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1718 def get_control(params = {}, = {}) req = build_request(:get_control, params) req.send_request() end |
#get_delegations(params = {}) ⇒ Types::GetDelegationsResponse
Returns a list of delegations from an audit owner to a delegate.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1762 1763 1764 1765 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1762 def get_delegations(params = {}, = {}) req = build_request(:get_delegations, params) req.send_request() end |
#get_evidence(params = {}) ⇒ Types::GetEvidenceResponse
Returns evidence from Audit Manager.
1820 1821 1822 1823 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1820 def get_evidence(params = {}, = {}) req = build_request(:get_evidence, params) req.send_request() end |
#get_evidence_by_evidence_folder(params = {}) ⇒ Types::GetEvidenceByEvidenceFolderResponse
Returns all evidence from a specified evidence folder in Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1889 1890 1891 1892 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1889 def get_evidence_by_evidence_folder(params = {}, = {}) req = build_request(:get_evidence_by_evidence_folder, params) req.send_request() end |
#get_evidence_folder(params = {}) ⇒ Types::GetEvidenceFolderResponse
Returns an evidence folder from the specified assessment in Audit Manager.
1943 1944 1945 1946 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1943 def get_evidence_folder(params = {}, = {}) req = build_request(:get_evidence_folder, params) req.send_request() end |
#get_evidence_folders_by_assessment(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentResponse
Returns the evidence folders from a specified assessment in Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2003 2004 2005 2006 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2003 def get_evidence_folders_by_assessment(params = {}, = {}) req = build_request(:get_evidence_folders_by_assessment, params) req.send_request() end |
#get_evidence_folders_by_assessment_control(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentControlResponse
Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2071 2072 2073 2074 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2071 def get_evidence_folders_by_assessment_control(params = {}, = {}) req = build_request(:get_evidence_folders_by_assessment_control, params) req.send_request() end |
#get_insights(params = {}) ⇒ Types::GetInsightsResponse
Gets the latest analytics data for all your current active assessments.
2097 2098 2099 2100 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2097 def get_insights(params = {}, = {}) req = build_request(:get_insights, params) req.send_request() end |
#get_insights_by_assessment(params = {}) ⇒ Types::GetInsightsByAssessmentResponse
Gets the latest analytics data for a specific active assessment.
2130 2131 2132 2133 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2130 def get_insights_by_assessment(params = {}, = {}) req = build_request(:get_insights_by_assessment, params) req.send_request() end |
#get_organization_admin_account(params = {}) ⇒ Types::GetOrganizationAdminAccountResponse
Returns the name of the delegated Amazon Web Services administrator account for the organization.
2152 2153 2154 2155 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2152 def get_organization_admin_account(params = {}, = {}) req = build_request(:get_organization_admin_account, params) req.send_request() end |
#get_services_in_scope(params = {}) ⇒ Types::GetServicesInScopeResponse
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].
[1]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html [2]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_Scope.html
2183 2184 2185 2186 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2183 def get_services_in_scope(params = {}, = {}) req = build_request(:get_services_in_scope, params) req.send_request() end |
#get_settings(params = {}) ⇒ Types::GetSettingsResponse
Returns the settings for the specified Amazon Web Services account.
2222 2223 2224 2225 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2222 def get_settings(params = {}, = {}) req = build_request(:get_settings, params) req.send_request() end |
#list_assessment_control_insights_by_control_domain(params = {}) ⇒ Types::ListAssessmentControlInsightsByControlDomainResponse
Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
<note markdown=“1”> 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.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2283 2284 2285 2286 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2283 def list_assessment_control_insights_by_control_domain(params = {}, = {}) req = build_request(:list_assessment_control_insights_by_control_domain, params) req.send_request() end |
#list_assessment_framework_share_requests(params = {}) ⇒ Types::ListAssessmentFrameworkShareRequestsResponse
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2341 2342 2343 2344 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2341 def list_assessment_framework_share_requests(params = {}, = {}) req = build_request(:list_assessment_framework_share_requests, params) req.send_request() end |
#list_assessment_frameworks(params = {}) ⇒ Types::ListAssessmentFrameworksResponse
Returns a list of the frameworks that are available in the Audit Manager framework library.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2395 2396 2397 2398 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2395 def list_assessment_frameworks(params = {}, = {}) req = build_request(:list_assessment_frameworks, params) req.send_request() end |
#list_assessment_reports(params = {}) ⇒ Types::ListAssessmentReportsResponse
Returns a list of assessment reports created in Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2440 2441 2442 2443 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2440 def list_assessment_reports(params = {}, = {}) req = build_request(:list_assessment_reports, params) req.send_request() end |
#list_assessments(params = {}) ⇒ Types::ListAssessmentsResponse
Returns a list of current and past assessments from Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2502 2503 2504 2505 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2502 def list_assessments(params = {}, = {}) req = build_request(:list_assessments, params) req.send_request() end |
#list_control_domain_insights(params = {}) ⇒ Types::ListControlDomainInsightsResponse
Lists the latest analytics data for control domains across all of your active assessments.
<note markdown=“1”> 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.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2555 2556 2557 2558 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2555 def list_control_domain_insights(params = {}, = {}) req = build_request(:list_control_domain_insights, params) req.send_request() end |
#list_control_domain_insights_by_assessment(params = {}) ⇒ Types::ListControlDomainInsightsByAssessmentResponse
Lists analytics data for control domains within a specified active assessment.
<note markdown=“1”> 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.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2612 2613 2614 2615 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2612 def list_control_domain_insights_by_assessment(params = {}, = {}) req = build_request(:list_control_domain_insights_by_assessment, params) req.send_request() end |
#list_control_insights_by_control_domain(params = {}) ⇒ Types::ListControlInsightsByControlDomainResponse
Lists the latest analytics data for controls within a specific control domain across all active assessments.
<note markdown=“1”> 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.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2667 2668 2669 2670 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2667 def list_control_insights_by_control_domain(params = {}, = {}) req = build_request(:list_control_insights_by_control_domain, params) req.send_request() end |
#list_controls(params = {}) ⇒ Types::ListControlsResponse
Returns a list of controls from Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2714 2715 2716 2717 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2714 def list_controls(params = {}, = {}) req = build_request(:list_controls, params) req.send_request() end |
#list_keywords_for_data_source(params = {}) ⇒ Types::ListKeywordsForDataSourceResponse
Returns a list of keywords that are pre-mapped to the specified control data source.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2757 2758 2759 2760 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2757 def list_keywords_for_data_source(params = {}, = {}) req = build_request(:list_keywords_for_data_source, params) req.send_request() end |
#list_notifications(params = {}) ⇒ Types::ListNotificationsResponse
Returns a list of all Audit Manager notifications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2802 2803 2804 2805 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2802 def list_notifications(params = {}, = {}) req = build_request(:list_notifications, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for the specified resource in Audit Manager.
2831 2832 2833 2834 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2831 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_account(params = {}) ⇒ Types::RegisterAccountResponse
Enables Audit Manager for the specified Amazon Web Services account.
2863 2864 2865 2866 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2863 def register_account(params = {}, = {}) req = build_request(:register_account, params) req.send_request() end |
#register_organization_admin_account(params = {}) ⇒ Types::RegisterOrganizationAdminAccountResponse
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
2894 2895 2896 2897 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2894 def register_organization_admin_account(params = {}, = {}) req = build_request(:register_organization_admin_account, params) req.send_request() end |
#start_assessment_framework_share(params = {}) ⇒ Types::StartAssessmentFrameworkShareResponse
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*.
[1]: docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend [2]: docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility
2992 2993 2994 2995 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2992 def start_assessment_framework_share(params = {}, = {}) req = build_request(:start_assessment_framework_share, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags the specified resource in Audit Manager.
3020 3021 3022 3023 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3020 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource in Audit Manager.
3046 3047 3048 3049 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3046 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_assessment(params = {}) ⇒ Types::UpdateAssessmentResponse
Edits an Audit Manager assessment.
3192 3193 3194 3195 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3192 def update_assessment(params = {}, = {}) req = build_request(:update_assessment, params) req.send_request() end |
#update_assessment_control(params = {}) ⇒ Types::UpdateAssessmentControlResponse
Updates a control within an assessment in Audit Manager.
3248 3249 3250 3251 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3248 def update_assessment_control(params = {}, = {}) req = build_request(:update_assessment_control, params) req.send_request() end |
#update_assessment_control_set_status(params = {}) ⇒ Types::UpdateAssessmentControlSetStatusResponse
Updates the status of a control set in an Audit Manager assessment.
3321 3322 3323 3324 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3321 def update_assessment_control_set_status(params = {}, = {}) req = build_request(:update_assessment_control_set_status, params) req.send_request() end |
#update_assessment_framework(params = {}) ⇒ Types::UpdateAssessmentFrameworkResponse
Updates a custom framework in Audit Manager.
3418 3419 3420 3421 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3418 def update_assessment_framework(params = {}, = {}) req = build_request(:update_assessment_framework, params) req.send_request() end |
#update_assessment_framework_share(params = {}) ⇒ Types::UpdateAssessmentFrameworkShareResponse
Updates a share request for a custom framework in Audit Manager.
3469 3470 3471 3472 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3469 def update_assessment_framework_share(params = {}, = {}) req = build_request(:update_assessment_framework_share, params) req.send_request() end |
#update_assessment_status(params = {}) ⇒ Types::UpdateAssessmentStatusResponse
Updates the status of an assessment in Audit Manager.
3577 3578 3579 3580 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3577 def update_assessment_status(params = {}, = {}) req = build_request(:update_assessment_status, params) req.send_request() end |
#update_control(params = {}) ⇒ Types::UpdateControlResponse
Updates a custom control in Audit Manager.
3667 3668 3669 3670 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3667 def update_control(params = {}, = {}) req = build_request(:update_control, params) req.send_request() end |
#update_settings(params = {}) ⇒ Types::UpdateSettingsResponse
Updates Audit Manager settings for the current user account.
3748 3749 3750 3751 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3748 def update_settings(params = {}, = {}) req = build_request(:update_settings, params) req.send_request() end |
#validate_assessment_report_integrity(params = {}) ⇒ Types::ValidateAssessmentReportIntegrityResponse
Validates the integrity of an assessment report in Audit Manager.
3786 3787 3788 3789 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3786 def validate_assessment_report_integrity(params = {}, = {}) req = build_request(:validate_assessment_report_integrity, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3810 3811 3812 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3810 def waiter_names [] end |