AuditManager

import { AuditManager } from "https://aws-api.deno.dev/v0.3/services/auditmanager.ts?docs=full";

class AuditManager {

constructor(apiFactory: client.ApiFactory);

async associateAssessmentReportEvidenceFolder(params: AssociateAssessmentReportEvidenceFolderRequest, opts?: client.RequestOptions): Promise<void>;

async batchAssociateAssessmentReportEvidence(params: BatchAssociateAssessmentReportEvidenceRequest, opts?: client.RequestOptions): Promise<BatchAssociateAssessmentReportEvidenceResponse>;

async batchCreateDelegationByAssessment(params: BatchCreateDelegationByAssessmentRequest, opts?: client.RequestOptions): Promise<BatchCreateDelegationByAssessmentResponse>;

async batchDeleteDelegationByAssessment(params: BatchDeleteDelegationByAssessmentRequest, opts?: client.RequestOptions): Promise<BatchDeleteDelegationByAssessmentResponse>;

async batchDisassociateAssessmentReportEvidence(params: BatchDisassociateAssessmentReportEvidenceRequest, opts?: client.RequestOptions): Promise<BatchDisassociateAssessmentReportEvidenceResponse>;

async batchImportEvidenceToAssessmentControl(params: BatchImportEvidenceToAssessmentControlRequest, opts?: client.RequestOptions): Promise<BatchImportEvidenceToAssessmentControlResponse>;

async createAssessment(params: CreateAssessmentRequest, opts?: client.RequestOptions): Promise<CreateAssessmentResponse>;

async createAssessmentFramework(params: CreateAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<CreateAssessmentFrameworkResponse>;

async createAssessmentReport(params: CreateAssessmentReportRequest, opts?: client.RequestOptions): Promise<CreateAssessmentReportResponse>;

async createControl(params: CreateControlRequest, opts?: client.RequestOptions): Promise<CreateControlResponse>;

async deleteAssessment(params: DeleteAssessmentRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAssessmentFramework(params: DeleteAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAssessmentFrameworkShare(params: DeleteAssessmentFrameworkShareRequest, opts?: client.RequestOptions): Promise<void>;

async deleteAssessmentReport(params: DeleteAssessmentReportRequest, opts?: client.RequestOptions): Promise<void>;

async deleteControl(params: DeleteControlRequest, opts?: client.RequestOptions): Promise<void>;

async deregisterAccount(opts?: client.RequestOptions): Promise<DeregisterAccountResponse>;

async deregisterOrganizationAdminAccount(params?: DeregisterOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>;

async disassociateAssessmentReportEvidenceFolder(params: DisassociateAssessmentReportEvidenceFolderRequest, opts?: client.RequestOptions): Promise<void>;

async getAccountStatus(opts?: client.RequestOptions): Promise<GetAccountStatusResponse>;

async getAssessment(params: GetAssessmentRequest, opts?: client.RequestOptions): Promise<GetAssessmentResponse>;

async getAssessmentFramework(params: GetAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<GetAssessmentFrameworkResponse>;

async getAssessmentReportUrl(params: GetAssessmentReportUrlRequest, opts?: client.RequestOptions): Promise<GetAssessmentReportUrlResponse>;

async getChangeLogs(params: GetChangeLogsRequest, opts?: client.RequestOptions): Promise<GetChangeLogsResponse>;

async getControl(params: GetControlRequest, opts?: client.RequestOptions): Promise<GetControlResponse>;

async getDelegations(params?: GetDelegationsRequest, opts?: client.RequestOptions): Promise<GetDelegationsResponse>;

async getEvidence(params: GetEvidenceRequest, opts?: client.RequestOptions): Promise<GetEvidenceResponse>;

async getEvidenceByEvidenceFolder(params: GetEvidenceByEvidenceFolderRequest, opts?: client.RequestOptions): Promise<GetEvidenceByEvidenceFolderResponse>;

async getEvidenceFolder(params: GetEvidenceFolderRequest, opts?: client.RequestOptions): Promise<GetEvidenceFolderResponse>;

async getEvidenceFoldersByAssessment(params: GetEvidenceFoldersByAssessmentRequest, opts?: client.RequestOptions): Promise<GetEvidenceFoldersByAssessmentResponse>;

async getEvidenceFoldersByAssessmentControl(params: GetEvidenceFoldersByAssessmentControlRequest, opts?: client.RequestOptions): Promise<GetEvidenceFoldersByAssessmentControlResponse>;

async getInsights(opts?: client.RequestOptions): Promise<GetInsightsResponse>;

async getInsightsByAssessment(params: GetInsightsByAssessmentRequest, opts?: client.RequestOptions): Promise<GetInsightsByAssessmentResponse>;

async getOrganizationAdminAccount(opts?: client.RequestOptions): Promise<GetOrganizationAdminAccountResponse>;

async getServicesInScope(opts?: client.RequestOptions): Promise<GetServicesInScopeResponse>;

async getSettings(params: GetSettingsRequest, opts?: client.RequestOptions): Promise<GetSettingsResponse>;

async listAssessmentControlInsightsByControlDomain(params: ListAssessmentControlInsightsByControlDomainRequest, opts?: client.RequestOptions): Promise<ListAssessmentControlInsightsByControlDomainResponse>;

async listAssessmentFrameworks(params: ListAssessmentFrameworksRequest, opts?: client.RequestOptions): Promise<ListAssessmentFrameworksResponse>;

async listAssessmentFrameworkShareRequests(params: ListAssessmentFrameworkShareRequestsRequest, opts?: client.RequestOptions): Promise<ListAssessmentFrameworkShareRequestsResponse>;

async listAssessmentReports(params?: ListAssessmentReportsRequest, opts?: client.RequestOptions): Promise<ListAssessmentReportsResponse>;

async listAssessments(params?: ListAssessmentsRequest, opts?: client.RequestOptions): Promise<ListAssessmentsResponse>;

async listControlDomainInsights(params?: ListControlDomainInsightsRequest, opts?: client.RequestOptions): Promise<ListControlDomainInsightsResponse>;

async listControlDomainInsightsByAssessment(params: ListControlDomainInsightsByAssessmentRequest, opts?: client.RequestOptions): Promise<ListControlDomainInsightsByAssessmentResponse>;

async listControlInsightsByControlDomain(params: ListControlInsightsByControlDomainRequest, opts?: client.RequestOptions): Promise<ListControlInsightsByControlDomainResponse>;

async listControls(params: ListControlsRequest, opts?: client.RequestOptions): Promise<ListControlsResponse>;

async listKeywordsForDataSource(params: ListKeywordsForDataSourceRequest, opts?: client.RequestOptions): Promise<ListKeywordsForDataSourceResponse>;

async listNotifications(params?: ListNotificationsRequest, opts?: client.RequestOptions): Promise<ListNotificationsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async registerAccount(params?: RegisterAccountRequest, opts?: client.RequestOptions): Promise<RegisterAccountResponse>;

async registerOrganizationAdminAccount(params: RegisterOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<RegisterOrganizationAdminAccountResponse>;

async startAssessmentFrameworkShare(params: StartAssessmentFrameworkShareRequest, opts?: client.RequestOptions): Promise<StartAssessmentFrameworkShareResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAssessment(params: UpdateAssessmentRequest, opts?: client.RequestOptions): Promise<UpdateAssessmentResponse>;

async updateAssessmentControl(params: UpdateAssessmentControlRequest, opts?: client.RequestOptions): Promise<UpdateAssessmentControlResponse>;

async updateAssessmentControlSetStatus(params: UpdateAssessmentControlSetStatusRequest, opts?: client.RequestOptions): Promise<UpdateAssessmentControlSetStatusResponse>;

async updateAssessmentFramework(params: UpdateAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<UpdateAssessmentFrameworkResponse>;

async updateAssessmentFrameworkShare(params: UpdateAssessmentFrameworkShareRequest, opts?: client.RequestOptions): Promise<UpdateAssessmentFrameworkShareResponse>;

async updateAssessmentStatus(params: UpdateAssessmentStatusRequest, opts?: client.RequestOptions): Promise<UpdateAssessmentStatusResponse>;

async updateControl(params: UpdateControlRequest, opts?: client.RequestOptions): Promise<UpdateControlResponse>;

async updateSettings(params?: UpdateSettingsRequest, opts?: client.RequestOptions): Promise<UpdateSettingsResponse>;

async validateAssessmentReportIntegrity(params: ValidateAssessmentReportIntegrityRequest, opts?: client.RequestOptions): Promise<ValidateAssessmentReportIntegrityResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new AuditManager(apiFactory: client.ApiFactory)

[src]

§Methods

associateAssessmentReportEvidenceFolder(params: AssociateAssessmentReportEvidenceFolderRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

batchAssociateAssessmentReportEvidence(params: BatchAssociateAssessmentReportEvidenceRequest, opts?: client.RequestOptions): Promise<BatchAssociateAssessmentReportEvidenceResponse>

[src]

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

batchCreateDelegationByAssessment(params: BatchCreateDelegationByAssessmentRequest, opts?: client.RequestOptions): Promise<BatchCreateDelegationByAssessmentResponse>

[src]

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

batchDeleteDelegationByAssessment(params: BatchDeleteDelegationByAssessmentRequest, opts?: client.RequestOptions): Promise<BatchDeleteDelegationByAssessmentResponse>

[src]

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

batchDisassociateAssessmentReportEvidence(params: BatchDisassociateAssessmentReportEvidenceRequest, opts?: client.RequestOptions): Promise<BatchDisassociateAssessmentReportEvidenceResponse>

[src]

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

batchImportEvidenceToAssessmentControl(params: BatchImportEvidenceToAssessmentControlRequest, opts?: client.RequestOptions): Promise<BatchImportEvidenceToAssessmentControlResponse>

[src]

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

createAssessment(params: CreateAssessmentRequest, opts?: client.RequestOptions): Promise<CreateAssessmentResponse>

[src]

Creates an assessment in Audit Manager.

createAssessmentFramework(params: CreateAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<CreateAssessmentFrameworkResponse>

[src]

Creates a custom framework in Audit Manager.

createAssessmentReport(params: CreateAssessmentReportRequest, opts?: client.RequestOptions): Promise<CreateAssessmentReportResponse>

[src]

Creates an assessment report for the specified assessment.

createControl(params: CreateControlRequest, opts?: client.RequestOptions): Promise<CreateControlResponse>

[src]

Creates a new custom control in Audit Manager.

deleteAssessment(params: DeleteAssessmentRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an assessment in Audit Manager.

deleteAssessmentFramework(params: DeleteAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a custom framework in Audit Manager.

deleteAssessmentFrameworkShare(params: DeleteAssessmentFrameworkShareRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteAssessmentReport(params: DeleteAssessmentReportRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes an assessment report from an assessment in Audit Manager.

deleteControl(params: DeleteControlRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a custom control in Audit Manager.

deregisterAccount(opts?: client.RequestOptions): Promise<DeregisterAccountResponse>

[src]

Deregisters an account in Audit Manager.

deregisterOrganizationAdminAccount(params?: DeregisterOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

! IMPORTANT: ! 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 Audit Manager. ! However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward.

disassociateAssessmentReportEvidenceFolder(params: DisassociateAssessmentReportEvidenceFolderRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

getAccountStatus(opts?: client.RequestOptions): Promise<GetAccountStatusResponse>

[src]

Returns the registration status of an account in Audit Manager.

getAssessment(params: GetAssessmentRequest, opts?: client.RequestOptions): Promise<GetAssessmentResponse>

[src]

Returns an assessment from Audit Manager.

getAssessmentFramework(params: GetAssessmentFrameworkRequest, opts?: client.RequestOptions): Promise<GetAssessmentFrameworkResponse>

[src]

Returns a framework from Audit Manager.

getAssessmentReportUrl(params: GetAssessmentReportUrlRequest, opts?: client.RequestOptions): Promise<GetAssessmentReportUrlResponse>

[src]

Returns the URL of an assessment report in Audit Manager.

getChangeLogs(params: GetChangeLogsRequest, opts?: client.RequestOptions): Promise<GetChangeLogsResponse>

[src]

Returns a list of changelogs from Audit Manager.

getControl(params: GetControlRequest, opts?: client.RequestOptions): Promise<GetControlResponse>

[src]

Returns a control from Audit Manager.

getDelegations(params?: GetDelegationsRequest, opts?: client.RequestOptions): Promise<GetDelegationsResponse>

[src]

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

getEvidence(params: GetEvidenceRequest, opts?: client.RequestOptions): Promise<GetEvidenceResponse>

[src]

Returns evidence from Audit Manager.

getEvidenceByEvidenceFolder(params: GetEvidenceByEvidenceFolderRequest, opts?: client.RequestOptions): Promise<GetEvidenceByEvidenceFolderResponse>

[src]

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

getEvidenceFolder(params: GetEvidenceFolderRequest, opts?: client.RequestOptions): Promise<GetEvidenceFolderResponse>

[src]

Returns an evidence folder from the specified assessment in Audit Manager.

getEvidenceFoldersByAssessment(params: GetEvidenceFoldersByAssessmentRequest, opts?: client.RequestOptions): Promise<GetEvidenceFoldersByAssessmentResponse>

[src]

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

getEvidenceFoldersByAssessmentControl(params: GetEvidenceFoldersByAssessmentControlRequest, opts?: client.RequestOptions): Promise<GetEvidenceFoldersByAssessmentControlResponse>

[src]

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

getInsights(opts?: client.RequestOptions): Promise<GetInsightsResponse>

[src]

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

getInsightsByAssessment(params: GetInsightsByAssessmentRequest, opts?: client.RequestOptions): Promise<GetInsightsByAssessmentResponse>

[src]

Gets the latest analytics data for a specific active assessment.

getOrganizationAdminAccount(opts?: client.RequestOptions): Promise<GetOrganizationAdminAccountResponse>

[src]

Returns the name of the delegated Amazon Web Services administrator account for the organization.

getServicesInScope(opts?: client.RequestOptions): Promise<GetServicesInScopeResponse>

[src]

Returns a list of the in-scope Amazon Web Services services for the specified assessment.

getSettings(params: GetSettingsRequest, opts?: client.RequestOptions): Promise<GetSettingsResponse>

[src]

Returns the settings for the specified Amazon Web Services account.

listAssessmentControlInsightsByControlDomain(params: ListAssessmentControlInsightsByControlDomainRequest, opts?: client.RequestOptions): Promise<ListAssessmentControlInsightsByControlDomainResponse>

[src]

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

Note: 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.

listAssessmentFrameworks(params: ListAssessmentFrameworksRequest, opts?: client.RequestOptions): Promise<ListAssessmentFrameworksResponse>

[src]

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

listAssessmentFrameworkShareRequests(params: ListAssessmentFrameworkShareRequestsRequest, opts?: client.RequestOptions): Promise<ListAssessmentFrameworkShareRequestsResponse>

[src]

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

listAssessmentReports(params?: ListAssessmentReportsRequest, opts?: client.RequestOptions): Promise<ListAssessmentReportsResponse>

[src]

Returns a list of assessment reports created in Audit Manager.

listAssessments(params?: ListAssessmentsRequest, opts?: client.RequestOptions): Promise<ListAssessmentsResponse>

[src]

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

listControlDomainInsights(params?: ListControlDomainInsightsRequest, opts?: client.RequestOptions): Promise<ListControlDomainInsightsResponse>

[src]

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

Note: 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.

listControlDomainInsightsByAssessment(params: ListControlDomainInsightsByAssessmentRequest, opts?: client.RequestOptions): Promise<ListControlDomainInsightsByAssessmentResponse>

[src]

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

listControlInsightsByControlDomain(params: ListControlInsightsByControlDomainRequest, opts?: client.RequestOptions): Promise<ListControlInsightsByControlDomainResponse>

[src]

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

Note: 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.

listControls(params: ListControlsRequest, opts?: client.RequestOptions): Promise<ListControlsResponse>

[src]

Returns a list of controls from Audit Manager.

listKeywordsForDataSource(params: ListKeywordsForDataSourceRequest, opts?: client.RequestOptions): Promise<ListKeywordsForDataSourceResponse>

[src]

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

listNotifications(params?: ListNotificationsRequest, opts?: client.RequestOptions): Promise<ListNotificationsResponse>

[src]

Returns a list of all Audit Manager notifications.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

registerAccount(params?: RegisterAccountRequest, opts?: client.RequestOptions): Promise<RegisterAccountResponse>

[src]

Enables Audit Manager for the specified Amazon Web Services account.

registerOrganizationAdminAccount(params: RegisterOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<RegisterOrganizationAdminAccountResponse>

[src]

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

startAssessmentFrameworkShare(params: StartAssessmentFrameworkShareRequest, opts?: client.RequestOptions): Promise<StartAssessmentFrameworkShareResponse>

[src]

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.

! IMPORTANT: ! 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.