com.amazonaws.services.auditmanager.AWSAuditManager Maven / Gradle / Ivy
Show all versions of aws-java-sdk-auditmanager Show documentation
/*
* Copyright 2016-2021 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 AWS Audit Manager API reference. This guide is for developers who need detailed information about the
* AWS Audit Manager API operations, data types, and errors.
*
*
* AWS Audit Manager is a service that provides automated evidence collection so that you can continuously audit your
* AWS usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.
*
*
* AWS Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance
* standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which 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 unique requirements.
*
*
* Use the following links to get started with the AWS Audit Manager API:
*
*
* -
*
* Actions: An
* alphabetical list of all AWS Audit Manager API operations.
*
*
* -
*
* Data types: An
* alphabetical list of all AWS Audit Manager data types.
*
*
* -
*
* Common parameters:
* Parameters that all Query operations can use.
*
*
* -
*
* Common errors: Client
* and server errors that all operations can return.
*
*
*
*
* If you're new to AWS Audit Manager, we recommend that you review the AWS 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 the specified assessment report in AWS Audit Manager.
*
*
* @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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.AssociateAssessmentReportEvidenceFolder
* @see AWS API Documentation
*/
AssociateAssessmentReportEvidenceFolderResult associateAssessmentReportEvidenceFolder(
AssociateAssessmentReportEvidenceFolderRequest associateAssessmentReportEvidenceFolderRequest);
/**
*
* Associates a list of evidence to an assessment report in an AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.BatchAssociateAssessmentReportEvidence
* @see AWS API Documentation
*/
BatchAssociateAssessmentReportEvidenceResult batchAssociateAssessmentReportEvidence(
BatchAssociateAssessmentReportEvidenceRequest batchAssociateAssessmentReportEvidenceRequest);
/**
*
* Create a batch of delegations for a specified assessment in AWS Audit Manager.
*
*
* @param batchCreateDelegationByAssessmentRequest
* @return Result of the BatchCreateDelegationByAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 the delegations in the specified AWS Audit Manager assessment.
*
*
* @param batchDeleteDelegationByAssessmentRequest
* @return Result of the BatchDeleteDelegationByAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 the specified assessment report in AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.BatchDisassociateAssessmentReportEvidence
* @see AWS API Documentation
*/
BatchDisassociateAssessmentReportEvidenceResult batchDisassociateAssessmentReportEvidence(
BatchDisassociateAssessmentReportEvidenceRequest batchDisassociateAssessmentReportEvidenceRequest);
/**
*
* Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager.
*
*
* @param batchImportEvidenceToAssessmentControlRequest
* @return Result of the BatchImportEvidenceToAssessmentControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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.BatchImportEvidenceToAssessmentControl
* @see AWS API Documentation
*/
BatchImportEvidenceToAssessmentControlResult batchImportEvidenceToAssessmentControl(
BatchImportEvidenceToAssessmentControlRequest batchImportEvidenceToAssessmentControlRequest);
/**
*
* Creates an assessment in AWS Audit Manager.
*
*
* @param createAssessmentRequest
* @return Result of the CreateAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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.CreateAssessment
* @see AWS
* API Documentation
*/
CreateAssessmentResult createAssessment(CreateAssessmentRequest createAssessmentRequest);
/**
*
* Creates a custom framework in AWS Audit Manager.
*
*
* @param createAssessmentFrameworkRequest
* @return Result of the CreateAssessmentFramework operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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.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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.CreateAssessmentReport
* @see AWS API Documentation
*/
CreateAssessmentReportResult createAssessmentReport(CreateAssessmentReportRequest createAssessmentReportRequest);
/**
*
* Creates a new custom control in AWS Audit Manager.
*
*
* @param createControlRequest
* @return Result of the CreateControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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.CreateControl
* @see AWS API
* Documentation
*/
CreateControlResult createControl(CreateControlRequest createControlRequest);
/**
*
* Deletes an assessment in AWS Audit Manager.
*
*
* @param deleteAssessmentRequest
* @return Result of the DeleteAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager.
*
*
* @param deleteAssessmentFrameworkRequest
* @return Result of the DeleteAssessmentFramework operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 an assessment report from an assessment in AWS Audit Manager.
*
*
* @param deleteAssessmentReportRequest
* @return Result of the DeleteAssessmentReport operation returned by the service.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.DeleteAssessmentReport
* @see AWS API Documentation
*/
DeleteAssessmentReportResult deleteAssessmentReport(DeleteAssessmentReportRequest deleteAssessmentReportRequest);
/**
*
* Deletes a custom control in AWS Audit Manager.
*
*
* @param deleteControlRequest
* @return Result of the DeleteControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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.DeleteControl
* @see AWS API
* Documentation
*/
DeleteControlResult deleteControl(DeleteControlRequest deleteControlRequest);
/**
*
* Deregisters an account in AWS Audit Manager.
*
*
* @param deregisterAccountRequest
* @return Result of the DeregisterAccount operation returned by the service.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.DeregisterAccount
* @see AWS
* API Documentation
*/
DeregisterAccountResult deregisterAccount(DeregisterAccountRequest deregisterAccountRequest);
/**
*
* Deregisters the delegated AWS administrator account from the AWS organization.
*
*
* @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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.DeregisterOrganizationAdminAccount
* @see AWS API Documentation
*/
DeregisterOrganizationAdminAccountResult deregisterOrganizationAdminAccount(
DeregisterOrganizationAdminAccountRequest deregisterOrganizationAdminAccountRequest);
/**
*
* Disassociates an evidence folder from the specified assessment report in AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.DisassociateAssessmentReportEvidenceFolder
* @see AWS API Documentation
*/
DisassociateAssessmentReportEvidenceFolderResult disassociateAssessmentReportEvidenceFolder(
DisassociateAssessmentReportEvidenceFolderRequest disassociateAssessmentReportEvidenceFolderRequest);
/**
*
* Returns the registration status of an account in AWS 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);
/**
*
* Returns an assessment from AWS Audit Manager.
*
*
* @param getAssessmentRequest
* @return Result of the GetAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns a framework from AWS Audit Manager.
*
*
* @param getAssessmentFrameworkRequest
* @return Result of the GetAssessmentFramework operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns the URL of a specified assessment report in AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.GetAssessmentReportUrl
* @see AWS API Documentation
*/
GetAssessmentReportUrlResult getAssessmentReportUrl(GetAssessmentReportUrlRequest getAssessmentReportUrlRequest);
/**
*
* Returns a list of changelogs from AWS Audit Manager.
*
*
* @param getChangeLogsRequest
* @return Result of the GetChangeLogs operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* Audit Manager settings page, and try again.
* @throws ResourceNotFoundException
* The resource specified in the request cannot 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);
/**
*
* Returns a control from AWS Audit Manager.
*
*
* @param getControlRequest
* @return Result of the GetControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns evidence from AWS Audit Manager.
*
*
* @param getEvidenceRequest
* @return Result of the GetEvidence operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns all evidence from a specified evidence folder in AWS Audit Manager.
*
*
* @param getEvidenceByEvidenceFolderRequest
* @return Result of the GetEvidenceByEvidenceFolder operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns an evidence folder from the specified assessment in AWS Audit Manager.
*
*
* @param getEvidenceFolderRequest
* @return Result of the GetEvidenceFolder operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns the evidence folders from a specified assessment in AWS Audit Manager.
*
*
* @param getEvidenceFoldersByAssessmentRequest
* @return Result of the GetEvidenceFoldersByAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager.
*
*
* @param getEvidenceFoldersByAssessmentControlRequest
* @return Result of the GetEvidenceFoldersByAssessmentControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns the name of the delegated AWS administrator account for the AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.GetOrganizationAdminAccount
* @see AWS API Documentation
*/
GetOrganizationAdminAccountResult getOrganizationAdminAccount(GetOrganizationAdminAccountRequest getOrganizationAdminAccountRequest);
/**
*
* Returns a list of the in-scope AWS services for the specified assessment.
*
*
* @param getServicesInScopeRequest
* @return Result of the GetServicesInScope operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns the settings for the specified AWS account.
*
*
* @param getSettingsRequest
* @return Result of the GetSettings operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns a list of the frameworks available in the AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager.
*
*
* @param listAssessmentsRequest
* @return Result of the ListAssessments operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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);
/**
*
* Returns a list of controls from AWS Audit Manager.
*
*
* @param listControlsRequest
* @return Result of the ListControls operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 pre-mapped to the specified control data source.
*
*
* @param listKeywordsForDataSourceRequest
* @return Result of the ListKeywordsForDataSource operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager notifications.
*
*
* @param listNotificationsRequest
* @return Result of the ListNotifications operation returned by the service.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS 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 specified in the request cannot be found.
* @sample AWSAuditManager.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Enables AWS Audit Manager for the specified AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.RegisterAccount
* @see AWS
* API Documentation
*/
RegisterAccountResult registerAccount(RegisterAccountRequest registerAccountRequest);
/**
*
* Enables an AWS account within the organization as the delegated administrator for AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot be found.
* @sample AWSAuditManager.RegisterOrganizationAdminAccount
* @see AWS API Documentation
*/
RegisterOrganizationAdminAccountResult registerOrganizationAdminAccount(RegisterOrganizationAdminAccountRequest registerOrganizationAdminAccountRequest);
/**
*
* Tags the specified resource in AWS 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 specified in the request cannot be found.
* @sample AWSAuditManager.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag from a resource in AWS 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 specified in the request cannot be found.
* @sample AWSAuditManager.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Edits an AWS Audit Manager assessment.
*
*
* @param updateAssessmentRequest
* @return Result of the UpdateAssessment operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager.
*
*
* @param updateAssessmentControlRequest
* @return Result of the UpdateAssessmentControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager assessment.
*
*
* @param updateAssessmentControlSetStatusRequest
* @return Result of the UpdateAssessmentControlSetStatus operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager.
*
*
* @param updateAssessmentFrameworkRequest
* @return Result of the UpdateAssessmentFramework operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 the status of an assessment in AWS Audit Manager.
*
*
* @param updateAssessmentStatusRequest
* @return Result of the UpdateAssessmentStatus operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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.UpdateAssessmentStatus
* @see AWS API Documentation
*/
UpdateAssessmentStatusResult updateAssessmentStatus(UpdateAssessmentStatusRequest updateAssessmentStatusRequest);
/**
*
* Updates a custom control in AWS Audit Manager.
*
*
* @param updateControlRequest
* @return Result of the UpdateControl operation returned by the service.
* @throws ResourceNotFoundException
* The resource specified in the request cannot be found.
* @throws ValidationException
* The request has invalid or missing parameters.
* @throws AccessDeniedException
* Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS Audit Manager settings for the current user 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 AWS 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 is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS
* 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 specified in the request cannot 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);
}