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 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 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.
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.
422 423 424 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 422 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.
4024 4025 4026 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 4024 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.
4027 4028 4029 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 4027 def errors_module Errors end |
Instance Method Details
#associate_assessment_report_evidence_folder(params = {}) ⇒ Struct
Associates an evidence folder to an assessment report in an Audit Manager assessment.
450 451 452 453 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 450 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.
493 494 495 496 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 493 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.
551 552 553 554 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 551 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.
586 587 588 589 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 586 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.
629 630 631 632 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 629 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:
-
‘manualEvidence` can be only one of the following: `evidenceFileName`, `s3ResourcePath`, or `textResponse`
-
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/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files [2]: docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html
705 706 707 708 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 705 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.
4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 4002 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.51.0' Seahorse::Client::Request.new(handlers, context) end |
#create_assessment(params = {}) ⇒ Types::CreateAssessmentResponse
Creates an assessment in Audit Manager.
873 874 875 876 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 873 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.
972 973 974 975 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 972 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.
1041 1042 1043 1044 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1041 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.
1133 1134 1135 1136 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1133 def create_control(params = {}, = {}) req = build_request(:create_control, params) req.send_request() end |
#delete_assessment(params = {}) ⇒ Struct
Deletes an assessment in Audit Manager.
1155 1156 1157 1158 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1155 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.
1177 1178 1179 1180 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1177 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.
1204 1205 1206 1207 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1204 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
1258 1259 1260 1261 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1258 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.
1286 1287 1288 1289 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1286 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”> Before you deregister, you can use the [UpdateSettings] API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the ‘DeregistrationPolicy` attribute to request the deletion of your data.
For more information about data retention, see [Data Protection][2] in
the *Audit Manager User Guide*.
</note>
[1]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html [2]: docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html
1321 1322 1323 1324 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1321 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][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 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.
[1]: docs.aws.amazon.com/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
1414 1415 1416 1417 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1414 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.
1441 1442 1443 1444 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1441 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.
1460 1461 1462 1463 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1460 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.
1567 1568 1569 1570 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1567 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.
1638 1639 1640 1641 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1638 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.
1671 1672 1673 1674 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1671 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.
1725 1726 1727 1728 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1725 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.
1778 1779 1780 1781 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1778 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.
1822 1823 1824 1825 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1822 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.
1880 1881 1882 1883 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1880 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.
1948 1949 1950 1951 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 1948 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 ][1
-
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].
[1]: docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files [2]: docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files [3]: docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html
2005 2006 2007 2008 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2005 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.
2058 2059 2060 2061 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2058 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.
2118 2119 2120 2121 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2118 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.
2186 2187 2188 2189 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2186 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.
2212 2213 2214 2215 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2212 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.
2245 2246 2247 2248 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2245 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.
2267 2268 2269 2270 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2267 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 from which Audit Manager can collect evidence.
Audit Manager defines which Amazon Web 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 that are in this list.
<note markdown=“1”> For information about why it’s no longer possible to specify services in scope manually, see [I can’t edit the services in scope for my assessment] in the Troubleshooting section of the Audit Manager user guide.
</note>
2308 2309 2310 2311 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2308 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.
2350 2351 2352 2353 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2350 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.
2420 2421 2422 2423 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2420 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.
2478 2479 2480 2481 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2478 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.
2532 2533 2534 2535 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2532 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.
2577 2578 2579 2580 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2577 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.
2639 2640 2641 2642 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2639 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` ][1] in the Amazon Web Services Control Catalog API Reference.
<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>
[1]: docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2701 2702 2703 2704 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2701 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` ][1] in the Amazon Web Services Control Catalog API Reference.
<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>
[1]: docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2767 2768 2769 2770 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2767 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.
2831 2832 2833 2834 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2831 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.
2906 2907 2908 2909 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2906 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.
2949 2950 2951 2952 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2949 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.
2994 2995 2996 2997 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 2994 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.
3023 3024 3025 3026 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3023 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.
3055 3056 3057 3058 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3055 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.
3086 3087 3088 3089 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3086 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
3184 3185 3186 3187 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3184 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.
3212 3213 3214 3215 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3212 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.
3238 3239 3240 3241 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3238 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_assessment(params = {}) ⇒ Types::UpdateAssessmentResponse
Edits an Audit Manager assessment.
3384 3385 3386 3387 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3384 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.
3440 3441 3442 3443 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3440 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.
3513 3514 3515 3516 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3513 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.
3611 3612 3613 3614 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3611 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.
3662 3663 3664 3665 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3662 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.
3770 3771 3772 3773 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3770 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.
3861 3862 3863 3864 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3861 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.
3955 3956 3957 3958 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3955 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.
3993 3994 3995 3996 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 3993 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.
4017 4018 4019 |
# File 'lib/aws-sdk-auditmanager/client.rb', line 4017 def waiter_names [] end |