/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.auditmanager; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.auditmanager.model.*; /** * Interface for accessing AWS Audit Manager. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.auditmanager.AbstractAWSAuditManager} instead. *
**
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSAuditManager { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "auditmanager"; /** ** Associates an evidence folder to an assessment report in an Audit Manager assessment. *
* * @param associateAssessmentReportEvidenceFolderRequest * @return Result of the AssociateAssessmentReportEvidenceFolder operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.AssociateAssessmentReportEvidenceFolder * @see AWS API Documentation */ AssociateAssessmentReportEvidenceFolderResult associateAssessmentReportEvidenceFolder( AssociateAssessmentReportEvidenceFolderRequest associateAssessmentReportEvidenceFolderRequest); /** ** Associates a list of evidence to an assessment report in an Audit Manager assessment. *
* * @param batchAssociateAssessmentReportEvidenceRequest * @return Result of the BatchAssociateAssessmentReportEvidence operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.BatchAssociateAssessmentReportEvidence * @see AWS API Documentation */ BatchAssociateAssessmentReportEvidenceResult batchAssociateAssessmentReportEvidence( BatchAssociateAssessmentReportEvidenceRequest batchAssociateAssessmentReportEvidenceRequest); /** ** Creates a batch of delegations for an assessment in Audit Manager. *
* * @param batchCreateDelegationByAssessmentRequest * @return Result of the BatchCreateDelegationByAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.BatchCreateDelegationByAssessment * @see AWS API Documentation */ BatchCreateDelegationByAssessmentResult batchCreateDelegationByAssessment(BatchCreateDelegationByAssessmentRequest batchCreateDelegationByAssessmentRequest); /** ** Deletes a batch of delegations for an assessment in Audit Manager. *
* * @param batchDeleteDelegationByAssessmentRequest * @return Result of the BatchDeleteDelegationByAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.BatchDeleteDelegationByAssessment * @see AWS API Documentation */ BatchDeleteDelegationByAssessmentResult batchDeleteDelegationByAssessment(BatchDeleteDelegationByAssessmentRequest batchDeleteDelegationByAssessmentRequest); /** ** Disassociates a list of evidence from an assessment report in Audit Manager. *
* * @param batchDisassociateAssessmentReportEvidenceRequest * @return Result of the BatchDisassociateAssessmentReportEvidence operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.BatchDisassociateAssessmentReportEvidence * @see AWS API Documentation */ BatchDisassociateAssessmentReportEvidenceResult batchDisassociateAssessmentReportEvidence( BatchDisassociateAssessmentReportEvidenceRequest batchDisassociateAssessmentReportEvidenceRequest); /** ** 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. *
* * @param batchImportEvidenceToAssessmentControlRequest * @return Result of the BatchImportEvidenceToAssessmentControl operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSAuditManager.BatchImportEvidenceToAssessmentControl * @see AWS API Documentation */ BatchImportEvidenceToAssessmentControlResult batchImportEvidenceToAssessmentControl( BatchImportEvidenceToAssessmentControlRequest batchImportEvidenceToAssessmentControlRequest); /** ** Creates an assessment in Audit Manager. *
* * @param createAssessmentRequest * @return Result of the CreateAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws 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. * @sample AWSAuditManager.CreateAssessment * @see AWS * API Documentation */ CreateAssessmentResult createAssessment(CreateAssessmentRequest createAssessmentRequest); /** ** Creates a custom framework in Audit Manager. *
* * @param createAssessmentFrameworkRequest * @return Result of the CreateAssessmentFramework operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws 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. * @sample AWSAuditManager.CreateAssessmentFramework * @see AWS API Documentation */ CreateAssessmentFrameworkResult createAssessmentFramework(CreateAssessmentFrameworkRequest createAssessmentFrameworkRequest); /** ** Creates an assessment report for the specified assessment. *
* * @param createAssessmentReportRequest * @return Result of the CreateAssessmentReport operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.CreateAssessmentReport * @see AWS API Documentation */ CreateAssessmentReportResult createAssessmentReport(CreateAssessmentReportRequest createAssessmentReportRequest); /** ** Creates a new custom control in Audit Manager. *
* * @param createControlRequest * @return Result of the CreateControl operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws 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. * @sample AWSAuditManager.CreateControl * @see AWS API * Documentation */ CreateControlResult createControl(CreateControlRequest createControlRequest); /** ** Deletes an assessment in Audit Manager. *
* * @param deleteAssessmentRequest * @return Result of the DeleteAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.DeleteAssessment * @see AWS * API Documentation */ DeleteAssessmentResult deleteAssessment(DeleteAssessmentRequest deleteAssessmentRequest); /** ** Deletes a custom framework in Audit Manager. *
* * @param deleteAssessmentFrameworkRequest * @return Result of the DeleteAssessmentFramework operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.DeleteAssessmentFramework * @see AWS API Documentation */ DeleteAssessmentFrameworkResult deleteAssessmentFramework(DeleteAssessmentFrameworkRequest deleteAssessmentFrameworkRequest); /** ** Deletes a share request for a custom framework in Audit Manager. *
* * @param deleteAssessmentFrameworkShareRequest * @return Result of the DeleteAssessmentFrameworkShare operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.DeleteAssessmentFrameworkShare * @see AWS API Documentation */ DeleteAssessmentFrameworkShareResult deleteAssessmentFrameworkShare(DeleteAssessmentFrameworkShareRequest deleteAssessmentFrameworkShareRequest); /** ** 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.
*
* 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. *
** 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. *
** 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. *
* * @param deregisterOrganizationAdminAccountRequest * @return Result of the DeregisterOrganizationAdminAccount operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.DeregisterOrganizationAdminAccount * @see AWS API Documentation */ DeregisterOrganizationAdminAccountResult deregisterOrganizationAdminAccount( DeregisterOrganizationAdminAccountRequest deregisterOrganizationAdminAccountRequest); /** ** Disassociates an evidence folder from the specified assessment report in Audit Manager. *
* * @param disassociateAssessmentReportEvidenceFolderRequest * @return Result of the DisassociateAssessmentReportEvidenceFolder operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.DisassociateAssessmentReportEvidenceFolder * @see AWS API Documentation */ DisassociateAssessmentReportEvidenceFolderResult disassociateAssessmentReportEvidenceFolder( DisassociateAssessmentReportEvidenceFolderRequest disassociateAssessmentReportEvidenceFolderRequest); /** ** Gets the registration status of an account in Audit Manager. *
* * @param getAccountStatusRequest * @return Result of the GetAccountStatus operation returned by the service. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetAccountStatus * @see AWS * API Documentation */ GetAccountStatusResult getAccountStatus(GetAccountStatusRequest getAccountStatusRequest); /** ** Gets information about a specified assessment. *
* * @param getAssessmentRequest * @return Result of the GetAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetAssessment * @see AWS API * Documentation */ GetAssessmentResult getAssessment(GetAssessmentRequest getAssessmentRequest); /** ** Gets information about a specified framework. *
* * @param getAssessmentFrameworkRequest * @return Result of the GetAssessmentFramework operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetAssessmentFramework * @see AWS API Documentation */ GetAssessmentFrameworkResult getAssessmentFramework(GetAssessmentFrameworkRequest getAssessmentFrameworkRequest); /** ** Gets the URL of an assessment report in Audit Manager. *
* * @param getAssessmentReportUrlRequest * @return Result of the GetAssessmentReportUrl operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.GetAssessmentReportUrl * @see AWS API Documentation */ GetAssessmentReportUrlResult getAssessmentReportUrl(GetAssessmentReportUrlRequest getAssessmentReportUrlRequest); /** ** Gets a list of changelogs from Audit Manager. *
* * @param getChangeLogsRequest * @return Result of the GetChangeLogs operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetChangeLogs * @see AWS API * Documentation */ GetChangeLogsResult getChangeLogs(GetChangeLogsRequest getChangeLogsRequest); /** ** Gets information about a specified control. *
* * @param getControlRequest * @return Result of the GetControl operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetControl * @see AWS API * Documentation */ GetControlResult getControl(GetControlRequest getControlRequest); /** ** Gets a list of delegations from an audit owner to a delegate. *
* * @param getDelegationsRequest * @return Result of the GetDelegations operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetDelegations * @see AWS * API Documentation */ GetDelegationsResult getDelegations(GetDelegationsRequest getDelegationsRequest); /** ** Gets information about a specified evidence item. *
* * @param getEvidenceRequest * @return Result of the GetEvidence operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetEvidence * @see AWS API * Documentation */ GetEvidenceResult getEvidence(GetEvidenceRequest getEvidenceRequest); /** ** Gets all evidence from a specified evidence folder in Audit Manager. *
* * @param getEvidenceByEvidenceFolderRequest * @return Result of the GetEvidenceByEvidenceFolder operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetEvidenceByEvidenceFolder * @see AWS API Documentation */ GetEvidenceByEvidenceFolderResult getEvidenceByEvidenceFolder(GetEvidenceByEvidenceFolderRequest getEvidenceByEvidenceFolderRequest); /** ** 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. *
* * @param getEvidenceFileUploadUrlRequest * @return Result of the GetEvidenceFileUploadUrl operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSAuditManager.GetEvidenceFileUploadUrl * @see AWS API Documentation */ GetEvidenceFileUploadUrlResult getEvidenceFileUploadUrl(GetEvidenceFileUploadUrlRequest getEvidenceFileUploadUrlRequest); /** ** Gets an evidence folder from a specified assessment in Audit Manager. *
* * @param getEvidenceFolderRequest * @return Result of the GetEvidenceFolder operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetEvidenceFolder * @see AWS * API Documentation */ GetEvidenceFolderResult getEvidenceFolder(GetEvidenceFolderRequest getEvidenceFolderRequest); /** ** Gets the evidence folders from a specified assessment in Audit Manager. *
* * @param getEvidenceFoldersByAssessmentRequest * @return Result of the GetEvidenceFoldersByAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetEvidenceFoldersByAssessment * @see AWS API Documentation */ GetEvidenceFoldersByAssessmentResult getEvidenceFoldersByAssessment(GetEvidenceFoldersByAssessmentRequest getEvidenceFoldersByAssessmentRequest); /** ** Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment. *
* * @param getEvidenceFoldersByAssessmentControlRequest * @return Result of the GetEvidenceFoldersByAssessmentControl operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetEvidenceFoldersByAssessmentControl * @see AWS API Documentation */ GetEvidenceFoldersByAssessmentControlResult getEvidenceFoldersByAssessmentControl( GetEvidenceFoldersByAssessmentControlRequest getEvidenceFoldersByAssessmentControlRequest); /** ** Gets the latest analytics data for all your current active assessments. *
* * @param getInsightsRequest * @return Result of the GetInsights operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetInsights * @see AWS API * Documentation */ GetInsightsResult getInsights(GetInsightsRequest getInsightsRequest); /** ** Gets the latest analytics data for a specific active assessment. *
* * @param getInsightsByAssessmentRequest * @return Result of the GetInsightsByAssessment operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetInsightsByAssessment * @see AWS API Documentation */ GetInsightsByAssessmentResult getInsightsByAssessment(GetInsightsByAssessmentRequest getInsightsByAssessmentRequest); /** ** Gets the name of the delegated Amazon Web Services administrator account for a specified organization. *
* * @param getOrganizationAdminAccountRequest * @return Result of the GetOrganizationAdminAccount operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.GetOrganizationAdminAccount * @see AWS API Documentation */ GetOrganizationAdminAccountResult getOrganizationAdminAccount(GetOrganizationAdminAccountRequest getOrganizationAdminAccountRequest); /** ** Gets a list of all of the Amazon Web Services that you can choose to include in your assessment. When you create an * assessment, specify which of these services you want to include to narrow the assessment's scope. *
* * @param getServicesInScopeRequest * @return Result of the GetServicesInScope operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetServicesInScope * @see AWS API Documentation */ GetServicesInScopeResult getServicesInScope(GetServicesInScopeRequest getServicesInScopeRequest); /** ** Gets the settings for a specified Amazon Web Services account. *
* * @param getSettingsRequest * @return Result of the GetSettings operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.GetSettings * @see AWS API * Documentation */ GetSettingsResult getSettings(GetSettingsRequest getSettingsRequest); /** ** 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.
*
* Returns a list of sent or received share requests for custom frameworks in Audit Manager. *
* * @param listAssessmentFrameworkShareRequestsRequest * @return Result of the ListAssessmentFrameworkShareRequests operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListAssessmentFrameworkShareRequests * @see AWS API Documentation */ ListAssessmentFrameworkShareRequestsResult listAssessmentFrameworkShareRequests( ListAssessmentFrameworkShareRequestsRequest listAssessmentFrameworkShareRequestsRequest); /** ** Returns a list of the frameworks that are available in the Audit Manager framework library. *
* * @param listAssessmentFrameworksRequest * @return Result of the ListAssessmentFrameworks operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListAssessmentFrameworks * @see AWS API Documentation */ ListAssessmentFrameworksResult listAssessmentFrameworks(ListAssessmentFrameworksRequest listAssessmentFrameworksRequest); /** ** Returns a list of assessment reports created in Audit Manager. *
* * @param listAssessmentReportsRequest * @return Result of the ListAssessmentReports operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListAssessmentReports * @see AWS API Documentation */ ListAssessmentReportsResult listAssessmentReports(ListAssessmentReportsRequest listAssessmentReportsRequest); /** ** Returns a list of current and past assessments from Audit Manager. *
* * @param listAssessmentsRequest * @return Result of the ListAssessments operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListAssessments * @see AWS * API Documentation */ ListAssessmentsResult listAssessments(ListAssessmentsRequest listAssessmentsRequest); /** ** Lists the latest analytics data for control domains across all of your active assessments. *
*
* 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.
*
* Lists analytics data for control domains within a specified active assessment. *
*
* 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.
*
* 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.
*
* Returns a list of controls from Audit Manager. *
* * @param listControlsRequest * @return Result of the ListControls operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListControls * @see AWS API * Documentation */ ListControlsResult listControls(ListControlsRequest listControlsRequest); /** ** Returns a list of keywords that are pre-mapped to the specified control data source. *
* * @param listKeywordsForDataSourceRequest * @return Result of the ListKeywordsForDataSource operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListKeywordsForDataSource * @see AWS API Documentation */ ListKeywordsForDataSourceResult listKeywordsForDataSource(ListKeywordsForDataSourceRequest listKeywordsForDataSourceRequest); /** ** Returns a list of all Audit Manager notifications. *
* * @param listNotificationsRequest * @return Result of the ListNotifications operation returned by the service. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws ValidationException * The request has invalid or missing parameters. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.ListNotifications * @see AWS * API Documentation */ ListNotificationsResult listNotifications(ListNotificationsRequest listNotificationsRequest); /** ** Returns a list of tags for the specified resource in Audit Manager. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ValidationException * The request has invalid or missing parameters. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** Enables Audit Manager for the specified Amazon Web Services account. *
* * @param registerAccountRequest * @return Result of the RegisterAccount operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ThrottlingException * The request was denied due to request throttling. * @sample AWSAuditManager.RegisterAccount * @see AWS * API Documentation */ RegisterAccountResult registerAccount(RegisterAccountRequest registerAccountRequest); /** ** Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. *
* * @param registerOrganizationAdminAccountRequest * @return Result of the RegisterOrganizationAdminAccount operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.RegisterOrganizationAdminAccount * @see AWS API Documentation */ RegisterOrganizationAdminAccountResult registerOrganizationAdminAccount(RegisterOrganizationAdminAccountRequest registerOrganizationAdminAccountRequest); /** ** 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.
*
* Tags the specified resource in Audit Manager. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ValidationException * The request has invalid or missing parameters. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Removes a tag from a resource in Audit Manager. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ValidationException * The request has invalid or missing parameters. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** Edits an Audit Manager assessment. *
* * @param updateAssessmentRequest * @return Result of the UpdateAssessment operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.UpdateAssessment * @see AWS * API Documentation */ UpdateAssessmentResult updateAssessment(UpdateAssessmentRequest updateAssessmentRequest); /** ** Updates a control within an assessment in Audit Manager. *
* * @param updateAssessmentControlRequest * @return Result of the UpdateAssessmentControl operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.UpdateAssessmentControl * @see AWS API Documentation */ UpdateAssessmentControlResult updateAssessmentControl(UpdateAssessmentControlRequest updateAssessmentControlRequest); /** ** Updates the status of a control set in an Audit Manager assessment. *
* * @param updateAssessmentControlSetStatusRequest * @return Result of the UpdateAssessmentControlSetStatus operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.UpdateAssessmentControlSetStatus * @see AWS API Documentation */ UpdateAssessmentControlSetStatusResult updateAssessmentControlSetStatus(UpdateAssessmentControlSetStatusRequest updateAssessmentControlSetStatusRequest); /** ** Updates a custom framework in Audit Manager. *
* * @param updateAssessmentFrameworkRequest * @return Result of the UpdateAssessmentFramework operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.UpdateAssessmentFramework * @see AWS API Documentation */ UpdateAssessmentFrameworkResult updateAssessmentFramework(UpdateAssessmentFrameworkRequest updateAssessmentFrameworkRequest); /** ** Updates a share request for a custom framework in Audit Manager. *
* * @param updateAssessmentFrameworkShareRequest * @return Result of the UpdateAssessmentFrameworkShare operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws 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. * @sample AWSAuditManager.UpdateAssessmentFrameworkShare * @see AWS API Documentation */ UpdateAssessmentFrameworkShareResult updateAssessmentFrameworkShare(UpdateAssessmentFrameworkShareRequest updateAssessmentFrameworkShareRequest); /** ** Updates the status of an assessment in Audit Manager. *
* * @param updateAssessmentStatusRequest * @return Result of the UpdateAssessmentStatus operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws 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. * @sample AWSAuditManager.UpdateAssessmentStatus * @see AWS API Documentation */ UpdateAssessmentStatusResult updateAssessmentStatus(UpdateAssessmentStatusRequest updateAssessmentStatusRequest); /** ** Updates a custom control in Audit Manager. *
* * @param updateControlRequest * @return Result of the UpdateControl operation returned by the service. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.UpdateControl * @see AWS API * Documentation */ UpdateControlResult updateControl(UpdateControlRequest updateControlRequest); /** ** Updates Audit Manager settings for the current account. *
* * @param updateSettingsRequest * @return Result of the UpdateSettings operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @sample AWSAuditManager.UpdateSettings * @see AWS * API Documentation */ UpdateSettingsResult updateSettings(UpdateSettingsRequest updateSettingsRequest); /** ** Validates the integrity of an assessment report in Audit Manager. *
* * @param validateAssessmentReportIntegrityRequest * @return Result of the ValidateAssessmentReportIntegrity operation returned by the service. * @throws ValidationException * The request has invalid or missing parameters. * @throws AccessDeniedException * Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit * Manager settings page, and try again. * @throws InternalServerException * An internal service error occurred during the processing of your request. Try again later. * @throws ResourceNotFoundException * The resource that's specified in the request can't be found. * @sample AWSAuditManager.ValidateAssessmentReportIntegrity * @see AWS API Documentation */ ValidateAssessmentReportIntegrityResult validateAssessmentReportIntegrity(ValidateAssessmentReportIntegrityRequest validateAssessmentReportIntegrityRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. ** 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 a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }