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 an 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
Adds 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
Gets the registration status of an account in Audit Manager.
-
#get_assessment(params = {}) ⇒ Types::GetAssessmentResponse
Gets information about a specified assessment.
-
#get_assessment_framework(params = {}) ⇒ Types::GetAssessmentFrameworkResponse
Gets information about a specified framework.
-
#get_assessment_report_url(params = {}) ⇒ Types::GetAssessmentReportUrlResponse
Gets the URL of an assessment report in Audit Manager.
-
#get_change_logs(params = {}) ⇒ Types::GetChangeLogsResponse
Gets a list of changelogs from Audit Manager.
-
#get_control(params = {}) ⇒ Types::GetControlResponse
Gets information about a specified control.
-
#get_delegations(params = {}) ⇒ Types::GetDelegationsResponse
Gets a list of delegations from an audit owner to a delegate.
-
#get_evidence(params = {}) ⇒ Types::GetEvidenceResponse
Gets information about a specified evidence item.
-
#get_evidence_by_evidence_folder(params = {}) ⇒ Types::GetEvidenceByEvidenceFolderResponse
Gets all evidence from a specified evidence folder in Audit Manager.
-
#get_evidence_file_upload_url(params = {}) ⇒ Types::GetEvidenceFileUploadUrlResponse
Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence.
-
#get_evidence_folder(params = {}) ⇒ Types::GetEvidenceFolderResponse
Gets an evidence folder from a specified assessment in Audit Manager.
-
#get_evidence_folders_by_assessment(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentResponse
Gets the evidence folders from a specified assessment in Audit Manager.
-
#get_evidence_folders_by_assessment_control(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentControlResponse
Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
-
#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
Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
-
#get_services_in_scope(params = {}) ⇒ Types::GetServicesInScopeResponse
Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.
-
#get_settings(params = {}) ⇒ Types::GetSettingsResponse
Gets the settings for a 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 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.
479 480 481 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#associate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Associates an evidence folder to an assessment report in an Audit Manager assessment.
507 508 509 510 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 507 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.
550 551 552 553 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 550 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.
608 609 610 611 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 608 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.
643 644 645 646 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 643 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.
686 687 688 689 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 686 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
Adds one or more pieces of evidence to a control in an Audit Manager assessment.
You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question.
The following restrictions apply to this action:
manualEvidencecan be only one of the following:evidenceFileName,s3ResourcePath, ortextResponseMaximum 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.
762 763 764 765 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 762 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.
930 931 932 933 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 930 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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1034 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.
1103 1104 1105 1106 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1103 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.
1195 1196 1197 1198 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1195 def create_control(params = {}, = {}) req = build_request(:create_control, params) req.send_request() end |
#delete_assessment(params = {}) ⇒ Struct
Deletes an assessment in Audit Manager.
1217 1218 1219 1220 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1217 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.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1239 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.
1266 1267 1268 1269 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1266 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.
1320 1321 1322 1323 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1320 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.
When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1348 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.
DeregistrationPolicy attribute to request the deletion
of your data.
For more information about data retention, see Data Protection in the Audit Manager User Guide.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1383 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 stops 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 ignores 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 for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1476 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1503 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
Gets the registration status of an account in Audit Manager.
1522 1523 1524 1525 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1522 def get_account_status(params = {}, = {}) req = build_request(:get_account_status, params) req.send_request() end |
#get_assessment(params = {}) ⇒ Types::GetAssessmentResponse
Gets information about a specified assessment.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1629 def get_assessment(params = {}, = {}) req = build_request(:get_assessment, params) req.send_request() end |
#get_assessment_framework(params = {}) ⇒ Types::GetAssessmentFrameworkResponse
Gets information about a specified framework.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1700 def get_assessment_framework(params = {}, = {}) req = build_request(:get_assessment_framework, params) req.send_request() end |
#get_assessment_report_url(params = {}) ⇒ Types::GetAssessmentReportUrlResponse
Gets the URL of an assessment report in Audit Manager.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1733 def get_assessment_report_url(params = {}, = {}) req = build_request(:get_assessment_report_url, params) req.send_request() end |
#get_change_logs(params = {}) ⇒ Types::GetChangeLogsResponse
Gets a list of changelogs from Audit Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1787 1788 1789 1790 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1787 def get_change_logs(params = {}, = {}) req = build_request(:get_change_logs, params) req.send_request() end |
#get_control(params = {}) ⇒ Types::GetControlResponse
Gets information about a specified control.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1840 def get_control(params = {}, = {}) req = build_request(:get_control, params) req.send_request() end |
#get_delegations(params = {}) ⇒ Types::GetDelegationsResponse
Gets 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1884 def get_delegations(params = {}, = {}) req = build_request(:get_delegations, params) req.send_request() end |
#get_evidence(params = {}) ⇒ Types::GetEvidenceResponse
Gets information about a specified evidence item.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 1942 def get_evidence(params = {}, = {}) req = build_request(:get_evidence, params) req.send_request() end |
#get_evidence_by_evidence_folder(params = {}) ⇒ Types::GetEvidenceByEvidenceFolderResponse
Gets 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.
2010 2011 2012 2013 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2010 def get_evidence_by_evidence_folder(params = {}, = {}) req = build_request(:get_evidence_by_evidence_folder, params) req.send_request() end |
#get_evidence_file_upload_url(params = {}) ⇒ Types::GetEvidenceFileUploadUrlResponse
Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide.
The following restrictions apply to this operation:
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.
2067 2068 2069 2070 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2067 def get_evidence_file_upload_url(params = {}, = {}) req = build_request(:get_evidence_file_upload_url, params) req.send_request() end |
#get_evidence_folder(params = {}) ⇒ Types::GetEvidenceFolderResponse
Gets an evidence folder from a specified assessment in Audit Manager.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2120 def get_evidence_folder(params = {}, = {}) req = build_request(:get_evidence_folder, params) req.send_request() end |
#get_evidence_folders_by_assessment(params = {}) ⇒ Types::GetEvidenceFoldersByAssessmentResponse
Gets 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.
2180 2181 2182 2183 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2180 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
Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2248 2249 2250 2251 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2248 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.
2274 2275 2276 2277 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2274 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.
2307 2308 2309 2310 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2307 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
Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
2329 2330 2331 2332 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2329 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
Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.
Audit Manager defines which Amazon Web Services services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services services that are in this list.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2370 def get_services_in_scope(params = {}, = {}) req = build_request(:get_services_in_scope, params) req.send_request() end |
#get_settings(params = {}) ⇒ Types::GetSettingsResponse
Gets the settings for a specified Amazon Web Services account.
2412 2413 2414 2415 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2412 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.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2482 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.
2540 2541 2542 2543 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2540 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.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2594 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.
2639 2640 2641 2642 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2639 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.
2701 2702 2703 2704 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2701 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.
Audit Manager supports the control domains that are provided by Amazon
Web Services Control Catalog. For information about how to find a list
of available control domains, see ListDomains in the Amazon
Web Services Control Catalog API Reference.
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.
2763 2764 2765 2766 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2763 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.
Audit Manager supports the control domains that are provided by Amazon
Web Services Control Catalog. For information about how to find a list
of available control domains, see ListDomains in the Amazon
Web Services Control Catalog API Reference.
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.
2829 2830 2831 2832 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2829 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.
2893 2894 2895 2896 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2893 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.
2968 2969 2970 2971 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 2968 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.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3011 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.
3056 3057 3058 3059 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3056 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.
3085 3086 3087 3088 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3085 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.
3117 3118 3119 3120 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3117 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.
3148 3149 3150 3151 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3148 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.
3246 3247 3248 3249 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3246 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.
3274 3275 3276 3277 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3274 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.
3300 3301 3302 3303 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3300 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_assessment(params = {}) ⇒ Types::UpdateAssessmentResponse
Edits an Audit Manager assessment.
3446 3447 3448 3449 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3446 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.
3502 3503 3504 3505 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3502 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.
3575 3576 3577 3578 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3575 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.
3678 3679 3680 3681 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3678 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.
3729 3730 3731 3732 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3729 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.
3837 3838 3839 3840 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3837 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.
3928 3929 3930 3931 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 3928 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 account.
4022 4023 4024 4025 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 4022 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.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/client.rb', line 4060 def validate_assessment_report_integrity(params = {}, = {}) req = build_request(:validate_assessment_report_integrity, params) req.send_request() end |