Class: Aws::AuditManager::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AuditManager::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-auditmanager/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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 the in-scope Amazon Web Services services for the specified 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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#associate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Associates an evidence folder to an assessment report in a Audit Manager assessment.
376 377 378 379 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 376 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.
419 420 421 422 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 419 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.
477 478 479 480 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 477 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.
512 513 514 515 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 512 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.
555 556 557 558 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 555 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.
603 604 605 606 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 603 def batch_import_evidence_to_assessment_control(params = {}, = {}) req = build_request(:batch_import_evidence_to_assessment_control, params) req.send_request() end |
#create_assessment(params = {}) ⇒ Types::CreateAssessmentResponse
Creates an assessment in Audit Manager.
757 758 759 760 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 757 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.
855 856 857 858 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 855 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.
899 900 901 902 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 899 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.
990 991 992 993 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 990 def create_control(params = {}, = {}) req = build_request(:create_control, params) req.send_request() end |
#delete_assessment(params = {}) ⇒ Struct
Deletes an assessment in Audit Manager.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1012 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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1034 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.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1061 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.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1115 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.
1137 1138 1139 1140 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1137 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.
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.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1198 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.
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.
1271 1272 1273 1274 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1271 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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1298 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.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1317 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.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1424 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.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1494 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.
1527 1528 1529 1530 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1527 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.
1581 1582 1583 1584 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1581 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.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1633 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.
1677 1678 1679 1680 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1677 def get_delegations(params = {}, = {}) req = build_request(:get_delegations, params) req.send_request() end |
#get_evidence(params = {}) ⇒ Types::GetEvidenceResponse
Returns evidence from Audit Manager.
1734 1735 1736 1737 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1734 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.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1802 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.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1856 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.
1916 1917 1918 1919 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1916 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.
1984 1985 1986 1987 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1984 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.
2010 2011 2012 2013 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2010 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.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2043 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.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2065 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 the in-scope Amazon Web Services services for the specified assessment.
2089 2090 2091 2092 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2089 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.
2124 2125 2126 2127 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2124 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.
lastUpdated
date of
controlInsightsByAssessment
. If neither of these conditions are met,
no data is listed for that control.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2185 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.
2243 2244 2245 2246 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2243 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.
2297 2298 2299 2300 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2297 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.
2342 2343 2344 2345 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2342 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.
2404 2405 2406 2407 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2404 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.
lastUpdated
date of
controlDomainInsights
. If this condition isn’t met, no data is
listed for that control domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2457 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.
lastUpdated
date of
controlDomainInsights
. If this condition isn’t met, no data is
listed for that domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2514 2515 2516 2517 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2514 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.
lastUpdated
date of controlInsightsMetadata
. If neither of these
conditions are met, no data is listed for that control.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2569 2570 2571 2572 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2569 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.
2616 2617 2618 2619 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2616 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.
2659 2660 2661 2662 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2659 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.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2704 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.
2733 2734 2735 2736 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2733 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.
2765 2766 2767 2768 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2765 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.
2796 2797 2798 2799 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2796 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 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.
2867 2868 2869 2870 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2867 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.
2895 2896 2897 2898 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2895 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.
2921 2922 2923 2924 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2921 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_assessment(params = {}) ⇒ Types::UpdateAssessmentResponse
Edits an Audit Manager assessment.
3067 3068 3069 3070 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3067 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.
3123 3124 3125 3126 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3123 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.
3196 3197 3198 3199 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3196 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.
3293 3294 3295 3296 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3293 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.
3344 3345 3346 3347 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3344 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.
3452 3453 3454 3455 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3452 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.
3542 3543 3544 3545 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3542 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.
3598 3599 3600 3601 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3598 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.
3636 3637 3638 3639 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3636 def validate_assessment_report_integrity(params = {}, = {}) req = build_request(:validate_assessment_report_integrity, params) req.send_request() end |