auditmanager/aws.sdk.kotlin.services.auditmanager

Package-level declarations

Types

interface AuditManagerClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateAssessmentReportEvidenceFolder

inline suspend fun AuditManagerClient.associateAssessmentReportEvidenceFolder(crossinline block: AssociateAssessmentReportEvidenceFolderRequest.Builder.() -> Unit): AssociateAssessmentReportEvidenceFolderResponse

Associates an evidence folder to an assessment report in an Audit Manager assessment.

batchAssociateAssessmentReportEvidence

inline suspend fun AuditManagerClient.batchAssociateAssessmentReportEvidence(crossinline block: BatchAssociateAssessmentReportEvidenceRequest.Builder.() -> Unit): BatchAssociateAssessmentReportEvidenceResponse

Associates a list of evidence to an assessment report in an Audit Manager assessment.

batchCreateDelegationByAssessment

inline suspend fun AuditManagerClient.batchCreateDelegationByAssessment(crossinline block: BatchCreateDelegationByAssessmentRequest.Builder.() -> Unit): BatchCreateDelegationByAssessmentResponse

Creates a batch of delegations for an assessment in Audit Manager.

batchDeleteDelegationByAssessment

inline suspend fun AuditManagerClient.batchDeleteDelegationByAssessment(crossinline block: BatchDeleteDelegationByAssessmentRequest.Builder.() -> Unit): BatchDeleteDelegationByAssessmentResponse

Deletes a batch of delegations for an assessment in Audit Manager.

batchDisassociateAssessmentReportEvidence

inline suspend fun AuditManagerClient.batchDisassociateAssessmentReportEvidence(crossinline block: BatchDisassociateAssessmentReportEvidenceRequest.Builder.() -> Unit): BatchDisassociateAssessmentReportEvidenceResponse

Disassociates a list of evidence from an assessment report in Audit Manager.

batchImportEvidenceToAssessmentControl

inline suspend fun AuditManagerClient.batchImportEvidenceToAssessmentControl(crossinline block: BatchImportEvidenceToAssessmentControlRequest.Builder.() -> Unit): BatchImportEvidenceToAssessmentControlResponse

Adds one or more pieces of evidence to a control in an Audit Manager assessment.

createAssessment

inline suspend fun AuditManagerClient.createAssessment(crossinline block: CreateAssessmentRequest.Builder.() -> Unit): CreateAssessmentResponse

Creates an assessment in Audit Manager.

createAssessmentFramework

inline suspend fun AuditManagerClient.createAssessmentFramework(crossinline block: CreateAssessmentFrameworkRequest.Builder.() -> Unit): CreateAssessmentFrameworkResponse

Creates a custom framework in Audit Manager.

createAssessmentReport

inline suspend fun AuditManagerClient.createAssessmentReport(crossinline block: CreateAssessmentReportRequest.Builder.() -> Unit): CreateAssessmentReportResponse

Creates an assessment report for the specified assessment.

createControl

inline suspend fun AuditManagerClient.createControl(crossinline block: CreateControlRequest.Builder.() -> Unit): CreateControlResponse

Creates a new custom control in Audit Manager.

deleteAssessment

inline suspend fun AuditManagerClient.deleteAssessment(crossinline block: DeleteAssessmentRequest.Builder.() -> Unit): DeleteAssessmentResponse

Deletes an assessment in Audit Manager.

deleteAssessmentFramework

inline suspend fun AuditManagerClient.deleteAssessmentFramework(crossinline block: DeleteAssessmentFrameworkRequest.Builder.() -> Unit): DeleteAssessmentFrameworkResponse

Deletes a custom framework in Audit Manager.

deleteAssessmentFrameworkShare

inline suspend fun AuditManagerClient.deleteAssessmentFrameworkShare(crossinline block: DeleteAssessmentFrameworkShareRequest.Builder.() -> Unit): DeleteAssessmentFrameworkShareResponse

Deletes a share request for a custom framework in Audit Manager.

deleteAssessmentReport

inline suspend fun AuditManagerClient.deleteAssessmentReport(crossinline block: DeleteAssessmentReportRequest.Builder.() -> Unit): DeleteAssessmentReportResponse

Deletes an assessment report in Audit Manager.

deleteControl

inline suspend fun AuditManagerClient.deleteControl(crossinline block: DeleteControlRequest.Builder.() -> Unit): DeleteControlResponse

Deletes a custom control in Audit Manager.

deregisterAccount

inline suspend fun AuditManagerClient.deregisterAccount(crossinline block: DeregisterAccountRequest.Builder.() -> Unit): DeregisterAccountResponse

Deregisters an account in Audit Manager.

deregisterOrganizationAdminAccount

inline suspend fun AuditManagerClient.deregisterOrganizationAdminAccount(crossinline block: DeregisterOrganizationAdminAccountRequest.Builder.() -> Unit): DeregisterOrganizationAdminAccountResponse

Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.

disassociateAssessmentReportEvidenceFolder

inline suspend fun AuditManagerClient.disassociateAssessmentReportEvidenceFolder(crossinline block: DisassociateAssessmentReportEvidenceFolderRequest.Builder.() -> Unit): DisassociateAssessmentReportEvidenceFolderResponse

Disassociates an evidence folder from the specified assessment report in Audit Manager.

getAccountStatus

inline suspend fun AuditManagerClient.getAccountStatus(crossinline block: GetAccountStatusRequest.Builder.() -> Unit): GetAccountStatusResponse

Gets the registration status of an account in Audit Manager.

getAssessment

inline suspend fun AuditManagerClient.getAssessment(crossinline block: GetAssessmentRequest.Builder.() -> Unit): GetAssessmentResponse

Gets information about a specified assessment.

getAssessmentFramework

inline suspend fun AuditManagerClient.getAssessmentFramework(crossinline block: GetAssessmentFrameworkRequest.Builder.() -> Unit): GetAssessmentFrameworkResponse

Gets information about a specified framework.

getAssessmentReportUrl

inline suspend fun AuditManagerClient.getAssessmentReportUrl(crossinline block: GetAssessmentReportUrlRequest.Builder.() -> Unit): GetAssessmentReportUrlResponse

Gets the URL of an assessment report in Audit Manager.

getChangeLogs

inline suspend fun AuditManagerClient.getChangeLogs(crossinline block: GetChangeLogsRequest.Builder.() -> Unit): GetChangeLogsResponse

Gets a list of changelogs from Audit Manager.

getControl

inline suspend fun AuditManagerClient.getControl(crossinline block: GetControlRequest.Builder.() -> Unit): GetControlResponse

Gets information about a specified control.

getDelegations

inline suspend fun AuditManagerClient.getDelegations(crossinline block: GetDelegationsRequest.Builder.() -> Unit): GetDelegationsResponse

Gets a list of delegations from an audit owner to a delegate.

getEvidence

inline suspend fun AuditManagerClient.getEvidence(crossinline block: GetEvidenceRequest.Builder.() -> Unit): GetEvidenceResponse

Gets information about a specified evidence item.

getEvidenceByEvidenceFolder

inline suspend fun AuditManagerClient.getEvidenceByEvidenceFolder(crossinline block: GetEvidenceByEvidenceFolderRequest.Builder.() -> Unit): GetEvidenceByEvidenceFolderResponse

Gets all evidence from a specified evidence folder in Audit Manager.

getEvidenceFileUploadUrl

inline suspend fun AuditManagerClient.getEvidenceFileUploadUrl(crossinline block: GetEvidenceFileUploadUrlRequest.Builder.() -> Unit): GetEvidenceFileUploadUrlResponse

Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide.

getEvidenceFolder

inline suspend fun AuditManagerClient.getEvidenceFolder(crossinline block: GetEvidenceFolderRequest.Builder.() -> Unit): GetEvidenceFolderResponse

Gets an evidence folder from a specified assessment in Audit Manager.

getEvidenceFoldersByAssessment

inline suspend fun AuditManagerClient.getEvidenceFoldersByAssessment(crossinline block: GetEvidenceFoldersByAssessmentRequest.Builder.() -> Unit): GetEvidenceFoldersByAssessmentResponse

Gets the evidence folders from a specified assessment in Audit Manager.

getEvidenceFoldersByAssessmentControl

inline suspend fun AuditManagerClient.getEvidenceFoldersByAssessmentControl(crossinline block: GetEvidenceFoldersByAssessmentControlRequest.Builder.() -> Unit): GetEvidenceFoldersByAssessmentControlResponse

Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.

getInsights

inline suspend fun AuditManagerClient.getInsights(crossinline block: GetInsightsRequest.Builder.() -> Unit): GetInsightsResponse

Gets the latest analytics data for all your current active assessments.

getInsightsByAssessment

inline suspend fun AuditManagerClient.getInsightsByAssessment(crossinline block: GetInsightsByAssessmentRequest.Builder.() -> Unit): GetInsightsByAssessmentResponse

Gets the latest analytics data for a specific active assessment.

getOrganizationAdminAccount

inline suspend fun AuditManagerClient.getOrganizationAdminAccount(crossinline block: GetOrganizationAdminAccountRequest.Builder.() -> Unit): GetOrganizationAdminAccountResponse

Gets the name of the delegated Amazon Web Services administrator account for a specified organization.

getServicesInScope

inline suspend fun AuditManagerClient.getServicesInScope(crossinline block: GetServicesInScopeRequest.Builder.() -> Unit): GetServicesInScopeResponse

Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.

getSettings

inline suspend fun AuditManagerClient.getSettings(crossinline block: GetSettingsRequest.Builder.() -> Unit): GetSettingsResponse

Gets the settings for a specified Amazon Web Services account.

listAssessmentControlInsightsByControlDomain

inline suspend fun AuditManagerClient.listAssessmentControlInsightsByControlDomain(crossinline block: ListAssessmentControlInsightsByControlDomainRequest.Builder.() -> Unit): ListAssessmentControlInsightsByControlDomainResponse

Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

listAssessmentFrameworks

inline suspend fun AuditManagerClient.listAssessmentFrameworks(crossinline block: ListAssessmentFrameworksRequest.Builder.() -> Unit): ListAssessmentFrameworksResponse

Returns a list of the frameworks that are available in the Audit Manager framework library.

listAssessmentFrameworkShareRequests

inline suspend fun AuditManagerClient.listAssessmentFrameworkShareRequests(crossinline block: ListAssessmentFrameworkShareRequestsRequest.Builder.() -> Unit): ListAssessmentFrameworkShareRequestsResponse

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

listAssessmentReports

inline suspend fun AuditManagerClient.listAssessmentReports(crossinline block: ListAssessmentReportsRequest.Builder.() -> Unit): ListAssessmentReportsResponse

Returns a list of assessment reports created in Audit Manager.

listAssessments

inline suspend fun AuditManagerClient.listAssessments(crossinline block: ListAssessmentsRequest.Builder.() -> Unit): ListAssessmentsResponse

Returns a list of current and past assessments from Audit Manager.

listControlDomainInsights

inline suspend fun AuditManagerClient.listControlDomainInsights(crossinline block: ListControlDomainInsightsRequest.Builder.() -> Unit): ListControlDomainInsightsResponse

Lists the latest analytics data for control domains across all of your active assessments.

listControlDomainInsightsByAssessment

inline suspend fun AuditManagerClient.listControlDomainInsightsByAssessment(crossinline block: ListControlDomainInsightsByAssessmentRequest.Builder.() -> Unit): ListControlDomainInsightsByAssessmentResponse

Lists analytics data for control domains within a specified active assessment.

listControlInsightsByControlDomain

inline suspend fun AuditManagerClient.listControlInsightsByControlDomain(crossinline block: ListControlInsightsByControlDomainRequest.Builder.() -> Unit): ListControlInsightsByControlDomainResponse

Lists the latest analytics data for controls within a specific control domain across all active assessments.

listControls

inline suspend fun AuditManagerClient.listControls(crossinline block: ListControlsRequest.Builder.() -> Unit): ListControlsResponse

Returns a list of controls from Audit Manager.

listKeywordsForDataSource

inline suspend fun AuditManagerClient.listKeywordsForDataSource(crossinline block: ListKeywordsForDataSourceRequest.Builder.() -> Unit): ListKeywordsForDataSourceResponse

Returns a list of keywords that are pre-mapped to the specified control data source.

listNotifications

inline suspend fun AuditManagerClient.listNotifications(crossinline block: ListNotificationsRequest.Builder.() -> Unit): ListNotificationsResponse

Returns a list of all Audit Manager notifications.

listTagsForResource

inline suspend fun AuditManagerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags for the specified resource in Audit Manager.

registerAccount

inline suspend fun AuditManagerClient.registerAccount(crossinline block: RegisterAccountRequest.Builder.() -> Unit): RegisterAccountResponse

Enables Audit Manager for the specified Amazon Web Services account.

registerOrganizationAdminAccount

inline suspend fun AuditManagerClient.registerOrganizationAdminAccount(crossinline block: RegisterOrganizationAdminAccountRequest.Builder.() -> Unit): RegisterOrganizationAdminAccountResponse

Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.

startAssessmentFrameworkShare

inline suspend fun AuditManagerClient.startAssessmentFrameworkShare(crossinline block: StartAssessmentFrameworkShareRequest.Builder.() -> Unit): StartAssessmentFrameworkShareResponse

Creates a share request for a custom framework in Audit Manager.

tagResource

inline suspend fun AuditManagerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags the specified resource in Audit Manager.

untagResource

inline suspend fun AuditManagerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag from a resource in Audit Manager.

updateAssessment

inline suspend fun AuditManagerClient.updateAssessment(crossinline block: UpdateAssessmentRequest.Builder.() -> Unit): UpdateAssessmentResponse

Edits an Audit Manager assessment.

updateAssessmentControl

inline suspend fun AuditManagerClient.updateAssessmentControl(crossinline block: UpdateAssessmentControlRequest.Builder.() -> Unit): UpdateAssessmentControlResponse

Updates a control within an assessment in Audit Manager.

updateAssessmentControlSetStatus

inline suspend fun AuditManagerClient.updateAssessmentControlSetStatus(crossinline block: UpdateAssessmentControlSetStatusRequest.Builder.() -> Unit): UpdateAssessmentControlSetStatusResponse

Updates the status of a control set in an Audit Manager assessment.

updateAssessmentFramework

inline suspend fun AuditManagerClient.updateAssessmentFramework(crossinline block: UpdateAssessmentFrameworkRequest.Builder.() -> Unit): UpdateAssessmentFrameworkResponse

Updates a custom framework in Audit Manager.

updateAssessmentFrameworkShare

inline suspend fun AuditManagerClient.updateAssessmentFrameworkShare(crossinline block: UpdateAssessmentFrameworkShareRequest.Builder.() -> Unit): UpdateAssessmentFrameworkShareResponse

Updates a share request for a custom framework in Audit Manager.

updateAssessmentStatus

inline suspend fun AuditManagerClient.updateAssessmentStatus(crossinline block: UpdateAssessmentStatusRequest.Builder.() -> Unit): UpdateAssessmentStatusResponse

Updates the status of an assessment in Audit Manager.

updateControl

inline suspend fun AuditManagerClient.updateControl(crossinline block: UpdateControlRequest.Builder.() -> Unit): UpdateControlResponse

Updates a custom control in Audit Manager.

updateSettings

inline suspend fun AuditManagerClient.updateSettings(crossinline block: UpdateSettingsRequest.Builder.() -> Unit): UpdateSettingsResponse

Updates Audit Manager settings for the current account.

validateAssessmentReportIntegrity

inline suspend fun AuditManagerClient.validateAssessmentReportIntegrity(crossinline block: ValidateAssessmentReportIntegrityRequest.Builder.() -> Unit): ValidateAssessmentReportIntegrityResponse

Validates the integrity of an assessment report in Audit Manager.

withConfig

fun AuditManagerClient.withConfig(block: AuditManagerClient.Config.Builder.() -> Unit): AuditManagerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.