@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAuditManagerClient extends AmazonWebServiceClient implements AWSAuditManager
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.
Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
Actions: An alphabetical list of all Audit Manager API operations.
Data types: An alphabetical list of all Audit Manager data types.
Common parameters: Parameters that all operations can use.
Common errors: Client and server errors that all operations can return.
If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSAuditManagerClientBuilder builder()
public AssociateAssessmentReportEvidenceFolderResult associateAssessmentReportEvidenceFolder(AssociateAssessmentReportEvidenceFolderRequest request)
Associates an evidence folder to an assessment report in an Audit Manager assessment.
associateAssessmentReportEvidenceFolder
in interface AWSAuditManager
associateAssessmentReportEvidenceFolderRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public BatchAssociateAssessmentReportEvidenceResult batchAssociateAssessmentReportEvidence(BatchAssociateAssessmentReportEvidenceRequest request)
Associates a list of evidence to an assessment report in an Audit Manager assessment.
batchAssociateAssessmentReportEvidence
in interface AWSAuditManager
batchAssociateAssessmentReportEvidenceRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public BatchCreateDelegationByAssessmentResult batchCreateDelegationByAssessment(BatchCreateDelegationByAssessmentRequest request)
Creates a batch of delegations for an assessment in Audit Manager.
batchCreateDelegationByAssessment
in interface AWSAuditManager
batchCreateDelegationByAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public BatchDeleteDelegationByAssessmentResult batchDeleteDelegationByAssessment(BatchDeleteDelegationByAssessmentRequest request)
Deletes a batch of delegations for an assessment in Audit Manager.
batchDeleteDelegationByAssessment
in interface AWSAuditManager
batchDeleteDelegationByAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public BatchDisassociateAssessmentReportEvidenceResult batchDisassociateAssessmentReportEvidence(BatchDisassociateAssessmentReportEvidenceRequest request)
Disassociates a list of evidence from an assessment report in Audit Manager.
batchDisassociateAssessmentReportEvidence
in interface AWSAuditManager
batchDisassociateAssessmentReportEvidenceRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public BatchImportEvidenceToAssessmentControlResult batchImportEvidenceToAssessmentControl(BatchImportEvidenceToAssessmentControlRequest request)
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.
batchImportEvidenceToAssessmentControl
in interface AWSAuditManager
batchImportEvidenceToAssessmentControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ThrottlingException
- The request was denied due to request throttling.public CreateAssessmentResult createAssessment(CreateAssessmentRequest request)
Creates an assessment in Audit Manager.
createAssessment
in interface AWSAuditManager
createAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException
- You've reached your account quota for this resource type. To perform the requested action, delete some
existing resources or request a quota increase
from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and
restrictions for Audit Manager.ThrottlingException
- The request was denied due to request throttling.public CreateAssessmentFrameworkResult createAssessmentFramework(CreateAssessmentFrameworkRequest request)
Creates a custom framework in Audit Manager.
createAssessmentFramework
in interface AWSAuditManager
createAssessmentFrameworkRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException
- You've reached your account quota for this resource type. To perform the requested action, delete some
existing resources or request a quota increase
from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and
restrictions for Audit Manager.public CreateAssessmentReportResult createAssessmentReport(CreateAssessmentReportRequest request)
Creates an assessment report for the specified assessment.
createAssessmentReport
in interface AWSAuditManager
createAssessmentReportRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public CreateControlResult createControl(CreateControlRequest request)
Creates a new custom control in Audit Manager.
createControl
in interface AWSAuditManager
createControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException
- You've reached your account quota for this resource type. To perform the requested action, delete some
existing resources or request a quota increase
from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and
restrictions for Audit Manager.public DeleteAssessmentResult deleteAssessment(DeleteAssessmentRequest request)
Deletes an assessment in Audit Manager.
deleteAssessment
in interface AWSAuditManager
deleteAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public DeleteAssessmentFrameworkResult deleteAssessmentFramework(DeleteAssessmentFrameworkRequest request)
Deletes a custom framework in Audit Manager.
deleteAssessmentFramework
in interface AWSAuditManager
deleteAssessmentFrameworkRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public DeleteAssessmentFrameworkShareResult deleteAssessmentFrameworkShare(DeleteAssessmentFrameworkShareRequest request)
Deletes a share request for a custom framework in Audit Manager.
deleteAssessmentFrameworkShare
in interface AWSAuditManager
deleteAssessmentFrameworkShareRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public DeleteAssessmentReportResult deleteAssessmentReport(DeleteAssessmentReportRequest request)
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.
deleteAssessmentReport
in interface AWSAuditManager
deleteAssessmentReportRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public DeleteControlResult deleteControl(DeleteControlRequest request)
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.
deleteControl
in interface AWSAuditManager
deleteControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public DeregisterAccountResult deregisterAccount(DeregisterAccountRequest request)
Deregisters an account in Audit Manager.
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 in the Audit Manager User Guide.
deregisterAccount
in interface AWSAuditManager
deregisterAccountRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public DeregisterOrganizationAdminAccountResult deregisterOrganizationAdminAccount(DeregisterOrganizationAdminAccountRequest request)
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.
deregisterOrganizationAdminAccount
in interface AWSAuditManager
deregisterOrganizationAdminAccountRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public DisassociateAssessmentReportEvidenceFolderResult disassociateAssessmentReportEvidenceFolder(DisassociateAssessmentReportEvidenceFolderRequest request)
Disassociates an evidence folder from the specified assessment report in Audit Manager.
disassociateAssessmentReportEvidenceFolder
in interface AWSAuditManager
disassociateAssessmentReportEvidenceFolderRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public GetAccountStatusResult getAccountStatus(GetAccountStatusRequest request)
Gets the registration status of an account in Audit Manager.
getAccountStatus
in interface AWSAuditManager
getAccountStatusRequest
- InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetAssessmentResult getAssessment(GetAssessmentRequest request)
Gets information about a specified assessment.
getAssessment
in interface AWSAuditManager
getAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetAssessmentFrameworkResult getAssessmentFramework(GetAssessmentFrameworkRequest request)
Gets information about a specified framework.
getAssessmentFramework
in interface AWSAuditManager
getAssessmentFrameworkRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetAssessmentReportUrlResult getAssessmentReportUrl(GetAssessmentReportUrlRequest request)
Gets the URL of an assessment report in Audit Manager.
getAssessmentReportUrl
in interface AWSAuditManager
getAssessmentReportUrlRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public GetChangeLogsResult getChangeLogs(GetChangeLogsRequest request)
Gets a list of changelogs from Audit Manager.
getChangeLogs
in interface AWSAuditManager
getChangeLogsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetControlResult getControl(GetControlRequest request)
Gets information about a specified control.
getControl
in interface AWSAuditManager
getControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetDelegationsResult getDelegations(GetDelegationsRequest request)
Gets a list of delegations from an audit owner to a delegate.
getDelegations
in interface AWSAuditManager
getDelegationsRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetEvidenceResult getEvidence(GetEvidenceRequest request)
Gets information about a specified evidence item.
getEvidence
in interface AWSAuditManager
getEvidenceRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetEvidenceByEvidenceFolderResult getEvidenceByEvidenceFolder(GetEvidenceByEvidenceFolderRequest request)
Gets all evidence from a specified evidence folder in Audit Manager.
getEvidenceByEvidenceFolder
in interface AWSAuditManager
getEvidenceByEvidenceFolderRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetEvidenceFileUploadUrlResult getEvidenceFileUploadUrl(GetEvidenceFileUploadUrlRequest request)
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.
getEvidenceFileUploadUrl
in interface AWSAuditManager
getEvidenceFileUploadUrlRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ThrottlingException
- The request was denied due to request throttling.public GetEvidenceFolderResult getEvidenceFolder(GetEvidenceFolderRequest request)
Gets an evidence folder from a specified assessment in Audit Manager.
getEvidenceFolder
in interface AWSAuditManager
getEvidenceFolderRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetEvidenceFoldersByAssessmentResult getEvidenceFoldersByAssessment(GetEvidenceFoldersByAssessmentRequest request)
Gets the evidence folders from a specified assessment in Audit Manager.
getEvidenceFoldersByAssessment
in interface AWSAuditManager
getEvidenceFoldersByAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetEvidenceFoldersByAssessmentControlResult getEvidenceFoldersByAssessmentControl(GetEvidenceFoldersByAssessmentControlRequest request)
Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
getEvidenceFoldersByAssessmentControl
in interface AWSAuditManager
getEvidenceFoldersByAssessmentControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetInsightsResult getInsights(GetInsightsRequest request)
Gets the latest analytics data for all your current active assessments.
getInsights
in interface AWSAuditManager
getInsightsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetInsightsByAssessmentResult getInsightsByAssessment(GetInsightsByAssessmentRequest request)
Gets the latest analytics data for a specific active assessment.
getInsightsByAssessment
in interface AWSAuditManager
getInsightsByAssessmentRequest
- ValidationException
- The request has invalid or missing parameters.ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetOrganizationAdminAccountResult getOrganizationAdminAccount(GetOrganizationAdminAccountRequest request)
Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
getOrganizationAdminAccount
in interface AWSAuditManager
getOrganizationAdminAccountRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public GetServicesInScopeResult getServicesInScope(GetServicesInScopeRequest request)
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.
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.
getServicesInScope
in interface AWSAuditManager
getServicesInScopeRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public GetSettingsResult getSettings(GetSettingsRequest request)
Gets the settings for a specified Amazon Web Services account.
getSettings
in interface AWSAuditManager
getSettingsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListAssessmentControlInsightsByControlDomainResult listAssessmentControlInsightsByControlDomain(ListAssessmentControlInsightsByControlDomainRequest request)
Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
Control insights are listed only if the control belongs to the control domain and assessment that was specified.
Moreover, the control must have collected evidence on the lastUpdated
date of
controlInsightsByAssessment
. If neither of these conditions are met, no data is listed for that
control.
listAssessmentControlInsightsByControlDomain
in interface AWSAuditManager
listAssessmentControlInsightsByControlDomainRequest
- ValidationException
- The request has invalid or missing parameters.ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListAssessmentFrameworkShareRequestsResult listAssessmentFrameworkShareRequests(ListAssessmentFrameworkShareRequestsRequest request)
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
listAssessmentFrameworkShareRequests
in interface AWSAuditManager
listAssessmentFrameworkShareRequestsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListAssessmentFrameworksResult listAssessmentFrameworks(ListAssessmentFrameworksRequest request)
Returns a list of the frameworks that are available in the Audit Manager framework library.
listAssessmentFrameworks
in interface AWSAuditManager
listAssessmentFrameworksRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListAssessmentReportsResult listAssessmentReports(ListAssessmentReportsRequest request)
Returns a list of assessment reports created in Audit Manager.
listAssessmentReports
in interface AWSAuditManager
listAssessmentReportsRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListAssessmentsResult listAssessments(ListAssessmentsRequest request)
Returns a list of current and past assessments from Audit Manager.
listAssessments
in interface AWSAuditManager
listAssessmentsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListControlDomainInsightsResult listControlDomainInsights(ListControlDomainInsightsRequest request)
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.
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.
listControlDomainInsights
in interface AWSAuditManager
listControlDomainInsightsRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ValidationException
- The request has invalid or missing parameters.public ListControlDomainInsightsByAssessmentResult listControlDomainInsightsByAssessment(ListControlDomainInsightsByAssessmentRequest request)
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.
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.
listControlDomainInsightsByAssessment
in interface AWSAuditManager
listControlDomainInsightsByAssessmentRequest
- ValidationException
- The request has invalid or missing parameters.ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListControlInsightsByControlDomainResult listControlInsightsByControlDomain(ListControlInsightsByControlDomainRequest request)
Lists the latest analytics data for controls within a specific control domain across all active assessments.
Control insights are listed only if the control belongs to the control domain that was specified and the control
collected evidence on the lastUpdated
date of controlInsightsMetadata
. If neither of
these conditions are met, no data is listed for that control.
listControlInsightsByControlDomain
in interface AWSAuditManager
listControlInsightsByControlDomainRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ValidationException
- The request has invalid or missing parameters.public ListControlsResult listControls(ListControlsRequest request)
Returns a list of controls from Audit Manager.
listControls
in interface AWSAuditManager
listControlsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListKeywordsForDataSourceResult listKeywordsForDataSource(ListKeywordsForDataSourceRequest request)
Returns a list of keywords that are pre-mapped to the specified control data source.
listKeywordsForDataSource
in interface AWSAuditManager
listKeywordsForDataSourceRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListNotificationsResult listNotifications(ListNotificationsRequest request)
Returns a list of all Audit Manager notifications.
listNotifications
in interface AWSAuditManager
listNotificationsRequest
- AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.ValidationException
- The request has invalid or missing parameters.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for the specified resource in Audit Manager.
listTagsForResource
in interface AWSAuditManager
listTagsForResourceRequest
- InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ValidationException
- The request has invalid or missing parameters.ResourceNotFoundException
- The resource that's specified in the request can't be found.public RegisterAccountResult registerAccount(RegisterAccountRequest request)
Enables Audit Manager for the specified Amazon Web Services account.
registerAccount
in interface AWSAuditManager
registerAccountRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.ThrottlingException
- The request was denied due to request throttling.public RegisterOrganizationAdminAccountResult registerOrganizationAdminAccount(RegisterOrganizationAdminAccountRequest request)
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
registerOrganizationAdminAccount
in interface AWSAuditManager
registerOrganizationAdminAccountRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public StartAssessmentFrameworkShareResult startAssessmentFrameworkShare(StartAssessmentFrameworkShareRequest request)
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.
startAssessmentFrameworkShare
in interface AWSAuditManager
startAssessmentFrameworkShareRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public TagResourceResult tagResource(TagResourceRequest request)
Tags the specified resource in Audit Manager.
tagResource
in interface AWSAuditManager
tagResourceRequest
- InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ValidationException
- The request has invalid or missing parameters.ResourceNotFoundException
- The resource that's specified in the request can't be found.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from a resource in Audit Manager.
untagResource
in interface AWSAuditManager
untagResourceRequest
- InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ValidationException
- The request has invalid or missing parameters.ResourceNotFoundException
- The resource that's specified in the request can't be found.public UpdateAssessmentResult updateAssessment(UpdateAssessmentRequest request)
Edits an Audit Manager assessment.
updateAssessment
in interface AWSAuditManager
updateAssessmentRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ThrottlingException
- The request was denied due to request throttling.public UpdateAssessmentControlResult updateAssessmentControl(UpdateAssessmentControlRequest request)
Updates a control within an assessment in Audit Manager.
updateAssessmentControl
in interface AWSAuditManager
updateAssessmentControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public UpdateAssessmentControlSetStatusResult updateAssessmentControlSetStatus(UpdateAssessmentControlSetStatusRequest request)
Updates the status of a control set in an Audit Manager assessment.
updateAssessmentControlSetStatus
in interface AWSAuditManager
updateAssessmentControlSetStatusRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public UpdateAssessmentFrameworkResult updateAssessmentFramework(UpdateAssessmentFrameworkRequest request)
Updates a custom framework in Audit Manager.
updateAssessmentFramework
in interface AWSAuditManager
updateAssessmentFrameworkRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public UpdateAssessmentFrameworkShareResult updateAssessmentFrameworkShare(UpdateAssessmentFrameworkShareRequest request)
Updates a share request for a custom framework in Audit Manager.
updateAssessmentFrameworkShare
in interface AWSAuditManager
updateAssessmentFrameworkShareRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException
- You've reached your account quota for this resource type. To perform the requested action, delete some
existing resources or request a quota increase
from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and
restrictions for Audit Manager.public UpdateAssessmentStatusResult updateAssessmentStatus(UpdateAssessmentStatusRequest request)
Updates the status of an assessment in Audit Manager.
updateAssessmentStatus
in interface AWSAuditManager
updateAssessmentStatusRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException
- You've reached your account quota for this resource type. To perform the requested action, delete some
existing resources or request a quota increase
from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and
restrictions for Audit Manager.public UpdateControlResult updateControl(UpdateControlRequest request)
Updates a custom control in Audit Manager.
updateControl
in interface AWSAuditManager
updateControlRequest
- ResourceNotFoundException
- The resource that's specified in the request can't be found.ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public UpdateSettingsResult updateSettings(UpdateSettingsRequest request)
Updates Audit Manager settings for the current account.
updateSettings
in interface AWSAuditManager
updateSettingsRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.public ValidateAssessmentReportIntegrityResult validateAssessmentReportIntegrity(ValidateAssessmentReportIntegrityRequest request)
Validates the integrity of an assessment report in Audit Manager.
validateAssessmentReportIntegrity
in interface AWSAuditManager
validateAssessmentReportIntegrityRequest
- ValidationException
- The request has invalid or missing parameters.AccessDeniedException
- Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit
Manager settings page, and try again.InternalServerException
- An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException
- The resource that's specified in the request can't be found.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSAuditManager
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSAuditManager
shutdown
in class AmazonWebServiceClient