Файловый менеджер

?? Файловый менеджер

Файловый менеджер - Редактировать - /home/infinitibizsol/testingcrm.infinitibizsol.com/node_modules/aws-sdk/clients/auditmanager.d.ts

Назад
import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class AuditManager extends Service { /** * Constructs a service object. This object has one method for each API operation. / constructor(options?: AuditManager.Types.ClientConfiguration) config: Config & AuditManager.Types.ClientConfiguration; /* * Associates an evidence folder to an assessment report in an Audit Manager assessment. / associateAssessmentReportEvidenceFolder(params: AuditManager.Types.AssociateAssessmentReportEvidenceFolderRequest, callback?: (err: AWSError, data: AuditManager.Types.AssociateAssessmentReportEvidenceFolderResponse) => void): Request<AuditManager.Types.AssociateAssessmentReportEvidenceFolderResponse, AWSError>; /* * Associates an evidence folder to an assessment report in an Audit Manager assessment. / associateAssessmentReportEvidenceFolder(callback?: (err: AWSError, data: AuditManager.Types.AssociateAssessmentReportEvidenceFolderResponse) => void): Request<AuditManager.Types.AssociateAssessmentReportEvidenceFolderResponse, AWSError>; /* * Associates a list of evidence to an assessment report in an Audit Manager assessment. / batchAssociateAssessmentReportEvidence(params: AuditManager.Types.BatchAssociateAssessmentReportEvidenceRequest, callback?: (err: AWSError, data: AuditManager.Types.BatchAssociateAssessmentReportEvidenceResponse) => void): Request<AuditManager.Types.BatchAssociateAssessmentReportEvidenceResponse, AWSError>; /* * Associates a list of evidence to an assessment report in an Audit Manager assessment. / batchAssociateAssessmentReportEvidence(callback?: (err: AWSError, data: AuditManager.Types.BatchAssociateAssessmentReportEvidenceResponse) => void): Request<AuditManager.Types.BatchAssociateAssessmentReportEvidenceResponse, AWSError>; /* * Creates a batch of delegations for an assessment in Audit Manager. / batchCreateDelegationByAssessment(params: AuditManager.Types.BatchCreateDelegationByAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.BatchCreateDelegationByAssessmentResponse) => void): Request<AuditManager.Types.BatchCreateDelegationByAssessmentResponse, AWSError>; /* * Creates a batch of delegations for an assessment in Audit Manager. / batchCreateDelegationByAssessment(callback?: (err: AWSError, data: AuditManager.Types.BatchCreateDelegationByAssessmentResponse) => void): Request<AuditManager.Types.BatchCreateDelegationByAssessmentResponse, AWSError>; /* * Deletes a batch of delegations for an assessment in Audit Manager. / batchDeleteDelegationByAssessment(params: AuditManager.Types.BatchDeleteDelegationByAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.BatchDeleteDelegationByAssessmentResponse) => void): Request<AuditManager.Types.BatchDeleteDelegationByAssessmentResponse, AWSError>; /* * Deletes a batch of delegations for an assessment in Audit Manager. / batchDeleteDelegationByAssessment(callback?: (err: AWSError, data: AuditManager.Types.BatchDeleteDelegationByAssessmentResponse) => void): Request<AuditManager.Types.BatchDeleteDelegationByAssessmentResponse, AWSError>; /* * Disassociates a list of evidence from an assessment report in Audit Manager. / batchDisassociateAssessmentReportEvidence(params: AuditManager.Types.BatchDisassociateAssessmentReportEvidenceRequest, callback?: (err: AWSError, data: AuditManager.Types.BatchDisassociateAssessmentReportEvidenceResponse) => void): Request<AuditManager.Types.BatchDisassociateAssessmentReportEvidenceResponse, AWSError>; /* * Disassociates a list of evidence from an assessment report in Audit Manager. / batchDisassociateAssessmentReportEvidence(callback?: (err: AWSError, data: AuditManager.Types.BatchDisassociateAssessmentReportEvidenceResponse) => void): Request<AuditManager.Types.BatchDisassociateAssessmentReportEvidenceResponse, AWSError>; /* * Adds one or more pieces of evidence to a control in an Audit Manager assessment. You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question. The following restrictions apply to this action: manualEvidence can be only one of the following: evidenceFileName, s3ResourcePath, or textResponse Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager. / batchImportEvidenceToAssessmentControl(params: AuditManager.Types.BatchImportEvidenceToAssessmentControlRequest, callback?: (err: AWSError, data: AuditManager.Types.BatchImportEvidenceToAssessmentControlResponse) => void): Request<AuditManager.Types.BatchImportEvidenceToAssessmentControlResponse, AWSError>; /* * Adds one or more pieces of evidence to a control in an Audit Manager assessment. You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question. The following restrictions apply to this action: manualEvidence can be only one of the following: evidenceFileName, s3ResourcePath, or textResponse Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager. / batchImportEvidenceToAssessmentControl(callback?: (err: AWSError, data: AuditManager.Types.BatchImportEvidenceToAssessmentControlResponse) => void): Request<AuditManager.Types.BatchImportEvidenceToAssessmentControlResponse, AWSError>; /* * Creates an assessment in Audit Manager. / createAssessment(params: AuditManager.Types.CreateAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.CreateAssessmentResponse) => void): Request<AuditManager.Types.CreateAssessmentResponse, AWSError>; /* * Creates an assessment in Audit Manager. / createAssessment(callback?: (err: AWSError, data: AuditManager.Types.CreateAssessmentResponse) => void): Request<AuditManager.Types.CreateAssessmentResponse, AWSError>; /* * Creates a custom framework in Audit Manager. / createAssessmentFramework(params: AuditManager.Types.CreateAssessmentFrameworkRequest, callback?: (err: AWSError, data: AuditManager.Types.CreateAssessmentFrameworkResponse) => void): Request<AuditManager.Types.CreateAssessmentFrameworkResponse, AWSError>; /* * Creates a custom framework in Audit Manager. / createAssessmentFramework(callback?: (err: AWSError, data: AuditManager.Types.CreateAssessmentFrameworkResponse) => void): Request<AuditManager.Types.CreateAssessmentFrameworkResponse, AWSError>; /* * Creates an assessment report for the specified assessment. / createAssessmentReport(params: AuditManager.Types.CreateAssessmentReportRequest, callback?: (err: AWSError, data: AuditManager.Types.CreateAssessmentReportResponse) => void): Request<AuditManager.Types.CreateAssessmentReportResponse, AWSError>; /* * Creates an assessment report for the specified assessment. / createAssessmentReport(callback?: (err: AWSError, data: AuditManager.Types.CreateAssessmentReportResponse) => void): Request<AuditManager.Types.CreateAssessmentReportResponse, AWSError>; /* * Creates a new custom control in Audit Manager. / createControl(params: AuditManager.Types.CreateControlRequest, callback?: (err: AWSError, data: AuditManager.Types.CreateControlResponse) => void): Request<AuditManager.Types.CreateControlResponse, AWSError>; /* * Creates a new custom control in Audit Manager. / createControl(callback?: (err: AWSError, data: AuditManager.Types.CreateControlResponse) => void): Request<AuditManager.Types.CreateControlResponse, AWSError>; /* * Deletes an assessment in Audit Manager. / deleteAssessment(params: AuditManager.Types.DeleteAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentResponse) => void): Request<AuditManager.Types.DeleteAssessmentResponse, AWSError>; /* * Deletes an assessment in Audit Manager. / deleteAssessment(callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentResponse) => void): Request<AuditManager.Types.DeleteAssessmentResponse, AWSError>; /* * Deletes a custom framework in Audit Manager. / deleteAssessmentFramework(params: AuditManager.Types.DeleteAssessmentFrameworkRequest, callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentFrameworkResponse) => void): Request<AuditManager.Types.DeleteAssessmentFrameworkResponse, AWSError>; /* * Deletes a custom framework in Audit Manager. / deleteAssessmentFramework(callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentFrameworkResponse) => void): Request<AuditManager.Types.DeleteAssessmentFrameworkResponse, AWSError>; /* * Deletes a share request for a custom framework in Audit Manager. / deleteAssessmentFrameworkShare(params: AuditManager.Types.DeleteAssessmentFrameworkShareRequest, callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentFrameworkShareResponse) => void): Request<AuditManager.Types.DeleteAssessmentFrameworkShareResponse, AWSError>; /* * Deletes a share request for a custom framework in Audit Manager. / deleteAssessmentFrameworkShare(callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentFrameworkShareResponse) => void): Request<AuditManager.Types.DeleteAssessmentFrameworkShareResponse, AWSError>; /* * Deletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data: The specified assessment report that’s stored in your S3 bucket The associated metadata that’s stored in Audit Manager If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API Reference. / deleteAssessmentReport(params: AuditManager.Types.DeleteAssessmentReportRequest, callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentReportResponse) => void): Request<AuditManager.Types.DeleteAssessmentReportResponse, AWSError>; /* * Deletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data: The specified assessment report that’s stored in your S3 bucket The associated metadata that’s stored in Audit Manager If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. This scenario happens when Audit Manager receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found) error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API Reference. / deleteAssessmentReport(callback?: (err: AWSError, data: AuditManager.Types.DeleteAssessmentReportResponse) => void): Request<AuditManager.Types.DeleteAssessmentReportResponse, AWSError>; /* * Deletes a custom control in Audit Manager. When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control. / deleteControl(params: AuditManager.Types.DeleteControlRequest, callback?: (err: AWSError, data: AuditManager.Types.DeleteControlResponse) => void): Request<AuditManager.Types.DeleteControlResponse, AWSError>; /* * Deletes a custom control in Audit Manager. When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control. / deleteControl(callback?: (err: AWSError, data: AuditManager.Types.DeleteControlResponse) => void): Request<AuditManager.Types.DeleteControlResponse, AWSError>; /* * Deregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection in the Audit Manager User Guide. / deregisterAccount(params: AuditManager.Types.DeregisterAccountRequest, callback?: (err: AWSError, data: AuditManager.Types.DeregisterAccountResponse) => void): Request<AuditManager.Types.DeregisterAccountResponse, AWSError>; /* * Deregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection in the Audit Manager User Guide. / deregisterAccount(callback?: (err: AWSError, data: AuditManager.Types.DeregisterAccountResponse) => void): Request<AuditManager.Types.DeregisterAccountResponse, AWSError>; /* * Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager. When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward. Keep in mind the following cleanup task if you use evidence finder: Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store. This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager ignores an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it. When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions: DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide) DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide) At this time, Audit Manager doesn't provide an option to delete evidence for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration. / deregisterOrganizationAdminAccount(params: AuditManager.Types.DeregisterOrganizationAdminAccountRequest, callback?: (err: AWSError, data: AuditManager.Types.DeregisterOrganizationAdminAccountResponse) => void): Request<AuditManager.Types.DeregisterOrganizationAdminAccountResponse, AWSError>; /* * Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager. When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward. Keep in mind the following cleanup task if you use evidence finder: Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store. This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager ignores an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it. When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. To delete your Audit Manager resource data, see the following instructions: DeleteAssessment (see also: Deleting an assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also: Deleting a custom framework in the Audit Manager User Guide) DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit Manager User Guide) At this time, Audit Manager doesn't provide an option to delete evidence for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration. / deregisterOrganizationAdminAccount(callback?: (err: AWSError, data: AuditManager.Types.DeregisterOrganizationAdminAccountResponse) => void): Request<AuditManager.Types.DeregisterOrganizationAdminAccountResponse, AWSError>; /* * Disassociates an evidence folder from the specified assessment report in Audit Manager. / disassociateAssessmentReportEvidenceFolder(params: AuditManager.Types.DisassociateAssessmentReportEvidenceFolderRequest, callback?: (err: AWSError, data: AuditManager.Types.DisassociateAssessmentReportEvidenceFolderResponse) => void): Request<AuditManager.Types.DisassociateAssessmentReportEvidenceFolderResponse, AWSError>; /* * Disassociates an evidence folder from the specified assessment report in Audit Manager. / disassociateAssessmentReportEvidenceFolder(callback?: (err: AWSError, data: AuditManager.Types.DisassociateAssessmentReportEvidenceFolderResponse) => void): Request<AuditManager.Types.DisassociateAssessmentReportEvidenceFolderResponse, AWSError>; /* * Gets the registration status of an account in Audit Manager. / getAccountStatus(params: AuditManager.Types.GetAccountStatusRequest, callback?: (err: AWSError, data: AuditManager.Types.GetAccountStatusResponse) => void): Request<AuditManager.Types.GetAccountStatusResponse, AWSError>; /* * Gets the registration status of an account in Audit Manager. / getAccountStatus(callback?: (err: AWSError, data: AuditManager.Types.GetAccountStatusResponse) => void): Request<AuditManager.Types.GetAccountStatusResponse, AWSError>; /* * Gets information about a specified assessment. / getAssessment(params: AuditManager.Types.GetAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.GetAssessmentResponse) => void): Request<AuditManager.Types.GetAssessmentResponse, AWSError>; /* * Gets information about a specified assessment. / getAssessment(callback?: (err: AWSError, data: AuditManager.Types.GetAssessmentResponse) => void): Request<AuditManager.Types.GetAssessmentResponse, AWSError>; /* * Gets information about a specified framework. / getAssessmentFramework(params: AuditManager.Types.GetAssessmentFrameworkRequest, callback?: (err: AWSError, data: AuditManager.Types.GetAssessmentFrameworkResponse) => void): Request<AuditManager.Types.GetAssessmentFrameworkResponse, AWSError>; /* * Gets information about a specified framework. / getAssessmentFramework(callback?: (err: AWSError, data: AuditManager.Types.GetAssessmentFrameworkResponse) => void): Request<AuditManager.Types.GetAssessmentFrameworkResponse, AWSError>; /* * Gets the URL of an assessment report in Audit Manager. / getAssessmentReportUrl(params: AuditManager.Types.GetAssessmentReportUrlRequest, callback?: (err: AWSError, data: AuditManager.Types.GetAssessmentReportUrlResponse) => void): Request<AuditManager.Types.GetAssessmentReportUrlResponse, AWSError>; /* * Gets the URL of an assessment report in Audit Manager. / getAssessmentReportUrl(callback?: (err: AWSError, data: AuditManager.Types.GetAssessmentReportUrlResponse) => void): Request<AuditManager.Types.GetAssessmentReportUrlResponse, AWSError>; /* * Gets a list of changelogs from Audit Manager. / getChangeLogs(params: AuditManager.Types.GetChangeLogsRequest, callback?: (err: AWSError, data: AuditManager.Types.GetChangeLogsResponse) => void): Request<AuditManager.Types.GetChangeLogsResponse, AWSError>; /* * Gets a list of changelogs from Audit Manager. / getChangeLogs(callback?: (err: AWSError, data: AuditManager.Types.GetChangeLogsResponse) => void): Request<AuditManager.Types.GetChangeLogsResponse, AWSError>; /* * Gets information about a specified control. / getControl(params: AuditManager.Types.GetControlRequest, callback?: (err: AWSError, data: AuditManager.Types.GetControlResponse) => void): Request<AuditManager.Types.GetControlResponse, AWSError>; /* * Gets information about a specified control. / getControl(callback?: (err: AWSError, data: AuditManager.Types.GetControlResponse) => void): Request<AuditManager.Types.GetControlResponse, AWSError>; /* * Gets a list of delegations from an audit owner to a delegate. / getDelegations(params: AuditManager.Types.GetDelegationsRequest, callback?: (err: AWSError, data: AuditManager.Types.GetDelegationsResponse) => void): Request<AuditManager.Types.GetDelegationsResponse, AWSError>; /* * Gets a list of delegations from an audit owner to a delegate. / getDelegations(callback?: (err: AWSError, data: AuditManager.Types.GetDelegationsResponse) => void): Request<AuditManager.Types.GetDelegationsResponse, AWSError>; /* * Gets information about a specified evidence item. / getEvidence(params: AuditManager.Types.GetEvidenceRequest, callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceResponse) => void): Request<AuditManager.Types.GetEvidenceResponse, AWSError>; /* * Gets information about a specified evidence item. / getEvidence(callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceResponse) => void): Request<AuditManager.Types.GetEvidenceResponse, AWSError>; /* * Gets all evidence from a specified evidence folder in Audit Manager. / getEvidenceByEvidenceFolder(params: AuditManager.Types.GetEvidenceByEvidenceFolderRequest, callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceByEvidenceFolderResponse) => void): Request<AuditManager.Types.GetEvidenceByEvidenceFolderResponse, AWSError>; /* * Gets all evidence from a specified evidence folder in Audit Manager. / getEvidenceByEvidenceFolder(callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceByEvidenceFolderResponse) => void): Request<AuditManager.Types.GetEvidenceByEvidenceFolderResponse, AWSError>; /* * Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide. The following restrictions apply to this operation: Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager. / getEvidenceFileUploadUrl(params: AuditManager.Types.GetEvidenceFileUploadUrlRequest, callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFileUploadUrlResponse) => void): Request<AuditManager.Types.GetEvidenceFileUploadUrlResponse, AWSError>; /* * Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide. The following restrictions apply to this operation: Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit Manager service restrictions, see Quotas and restrictions for Audit Manager. / getEvidenceFileUploadUrl(callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFileUploadUrlResponse) => void): Request<AuditManager.Types.GetEvidenceFileUploadUrlResponse, AWSError>; /* * Gets an evidence folder from a specified assessment in Audit Manager. / getEvidenceFolder(params: AuditManager.Types.GetEvidenceFolderRequest, callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFolderResponse) => void): Request<AuditManager.Types.GetEvidenceFolderResponse, AWSError>; /* * Gets an evidence folder from a specified assessment in Audit Manager. / getEvidenceFolder(callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFolderResponse) => void): Request<AuditManager.Types.GetEvidenceFolderResponse, AWSError>; /* * Gets the evidence folders from a specified assessment in Audit Manager. / getEvidenceFoldersByAssessment(params: AuditManager.Types.GetEvidenceFoldersByAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFoldersByAssessmentResponse) => void): Request<AuditManager.Types.GetEvidenceFoldersByAssessmentResponse, AWSError>; /* * Gets the evidence folders from a specified assessment in Audit Manager. / getEvidenceFoldersByAssessment(callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFoldersByAssessmentResponse) => void): Request<AuditManager.Types.GetEvidenceFoldersByAssessmentResponse, AWSError>; /* * Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment. / getEvidenceFoldersByAssessmentControl(params: AuditManager.Types.GetEvidenceFoldersByAssessmentControlRequest, callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFoldersByAssessmentControlResponse) => void): Request<AuditManager.Types.GetEvidenceFoldersByAssessmentControlResponse, AWSError>; /* * Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment. / getEvidenceFoldersByAssessmentControl(callback?: (err: AWSError, data: AuditManager.Types.GetEvidenceFoldersByAssessmentControlResponse) => void): Request<AuditManager.Types.GetEvidenceFoldersByAssessmentControlResponse, AWSError>; /* * Gets the latest analytics data for all your current active assessments. / getInsights(params: AuditManager.Types.GetInsightsRequest, callback?: (err: AWSError, data: AuditManager.Types.GetInsightsResponse) => void): Request<AuditManager.Types.GetInsightsResponse, AWSError>; /* * Gets the latest analytics data for all your current active assessments. / getInsights(callback?: (err: AWSError, data: AuditManager.Types.GetInsightsResponse) => void): Request<AuditManager.Types.GetInsightsResponse, AWSError>; /* * Gets the latest analytics data for a specific active assessment. / getInsightsByAssessment(params: AuditManager.Types.GetInsightsByAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.GetInsightsByAssessmentResponse) => void): Request<AuditManager.Types.GetInsightsByAssessmentResponse, AWSError>; /* * Gets the latest analytics data for a specific active assessment. / getInsightsByAssessment(callback?: (err: AWSError, data: AuditManager.Types.GetInsightsByAssessmentResponse) => void): Request<AuditManager.Types.GetInsightsByAssessmentResponse, AWSError>; /* * Gets the name of the delegated Amazon Web Services administrator account for a specified organization. / getOrganizationAdminAccount(params: AuditManager.Types.GetOrganizationAdminAccountRequest, callback?: (err: AWSError, data: AuditManager.Types.GetOrganizationAdminAccountResponse) => void): Request<AuditManager.Types.GetOrganizationAdminAccountResponse, AWSError>; /* * Gets the name of the delegated Amazon Web Services administrator account for a specified organization. / getOrganizationAdminAccount(callback?: (err: AWSError, data: AuditManager.Types.GetOrganizationAdminAccountResponse) => void): Request<AuditManager.Types.GetOrganizationAdminAccountResponse, AWSError>; /* * Gets a list of the Amazon Web Services from which Audit Manager can collect evidence. Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list. For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide. / getServicesInScope(params: AuditManager.Types.GetServicesInScopeRequest, callback?: (err: AWSError, data: AuditManager.Types.GetServicesInScopeResponse) => void): Request<AuditManager.Types.GetServicesInScopeResponse, AWSError>; /* * Gets a list of the Amazon Web Services from which Audit Manager can collect evidence. Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list. For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide. / getServicesInScope(callback?: (err: AWSError, data: AuditManager.Types.GetServicesInScopeResponse) => void): Request<AuditManager.Types.GetServicesInScopeResponse, AWSError>; /* * Gets the settings for a specified Amazon Web Services account. / getSettings(params: AuditManager.Types.GetSettingsRequest, callback?: (err: AWSError, data: AuditManager.Types.GetSettingsResponse) => void): Request<AuditManager.Types.GetSettingsResponse, AWSError>; /* * Gets the settings for a specified Amazon Web Services account. / getSettings(callback?: (err: AWSError, data: AuditManager.Types.GetSettingsResponse) => void): Request<AuditManager.Types.GetSettingsResponse, AWSError>; /* * Lists the latest analytics data for controls within a specific control domain and a specific active assessment. Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control. / listAssessmentControlInsightsByControlDomain(params: AuditManager.Types.ListAssessmentControlInsightsByControlDomainRequest, callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentControlInsightsByControlDomainResponse) => void): Request<AuditManager.Types.ListAssessmentControlInsightsByControlDomainResponse, AWSError>; /* * Lists the latest analytics data for controls within a specific control domain and a specific active assessment. Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control. / listAssessmentControlInsightsByControlDomain(callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentControlInsightsByControlDomainResponse) => void): Request<AuditManager.Types.ListAssessmentControlInsightsByControlDomainResponse, AWSError>; /* * Returns a list of sent or received share requests for custom frameworks in Audit Manager. / listAssessmentFrameworkShareRequests(params: AuditManager.Types.ListAssessmentFrameworkShareRequestsRequest, callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentFrameworkShareRequestsResponse) => void): Request<AuditManager.Types.ListAssessmentFrameworkShareRequestsResponse, AWSError>; /* * Returns a list of sent or received share requests for custom frameworks in Audit Manager. / listAssessmentFrameworkShareRequests(callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentFrameworkShareRequestsResponse) => void): Request<AuditManager.Types.ListAssessmentFrameworkShareRequestsResponse, AWSError>; /* * Returns a list of the frameworks that are available in the Audit Manager framework library. / listAssessmentFrameworks(params: AuditManager.Types.ListAssessmentFrameworksRequest, callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentFrameworksResponse) => void): Request<AuditManager.Types.ListAssessmentFrameworksResponse, AWSError>; /* * Returns a list of the frameworks that are available in the Audit Manager framework library. / listAssessmentFrameworks(callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentFrameworksResponse) => void): Request<AuditManager.Types.ListAssessmentFrameworksResponse, AWSError>; /* * Returns a list of assessment reports created in Audit Manager. / listAssessmentReports(params: AuditManager.Types.ListAssessmentReportsRequest, callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentReportsResponse) => void): Request<AuditManager.Types.ListAssessmentReportsResponse, AWSError>; /* * Returns a list of assessment reports created in Audit Manager. / listAssessmentReports(callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentReportsResponse) => void): Request<AuditManager.Types.ListAssessmentReportsResponse, AWSError>; /* * Returns a list of current and past assessments from Audit Manager. / listAssessments(params: AuditManager.Types.ListAssessmentsRequest, callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentsResponse) => void): Request<AuditManager.Types.ListAssessmentsResponse, AWSError>; /* * Returns a list of current and past assessments from Audit Manager. / listAssessments(callback?: (err: AWSError, data: AuditManager.Types.ListAssessmentsResponse) => void): Request<AuditManager.Types.ListAssessmentsResponse, AWSError>; /* * Lists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain. / listControlDomainInsights(params: AuditManager.Types.ListControlDomainInsightsRequest, callback?: (err: AWSError, data: AuditManager.Types.ListControlDomainInsightsResponse) => void): Request<AuditManager.Types.ListControlDomainInsightsResponse, AWSError>; /* * Lists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain. / listControlDomainInsights(callback?: (err: AWSError, data: AuditManager.Types.ListControlDomainInsightsResponse) => void): Request<AuditManager.Types.ListControlDomainInsightsResponse, AWSError>; /* * Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain. / listControlDomainInsightsByAssessment(params: AuditManager.Types.ListControlDomainInsightsByAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.ListControlDomainInsightsByAssessmentResponse) => void): Request<AuditManager.Types.ListControlDomainInsightsByAssessmentResponse, AWSError>; /* * Lists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain. / listControlDomainInsightsByAssessment(callback?: (err: AWSError, data: AuditManager.Types.ListControlDomainInsightsByAssessmentResponse) => void): Request<AuditManager.Types.ListControlDomainInsightsByAssessmentResponse, AWSError>; /* * Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control. / listControlInsightsByControlDomain(params: AuditManager.Types.ListControlInsightsByControlDomainRequest, callback?: (err: AWSError, data: AuditManager.Types.ListControlInsightsByControlDomainResponse) => void): Request<AuditManager.Types.ListControlInsightsByControlDomainResponse, AWSError>; /* * Lists the latest analytics data for controls within a specific control domain across all active assessments. Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control. / listControlInsightsByControlDomain(callback?: (err: AWSError, data: AuditManager.Types.ListControlInsightsByControlDomainResponse) => void): Request<AuditManager.Types.ListControlInsightsByControlDomainResponse, AWSError>; /* * Returns a list of controls from Audit Manager. / listControls(params: AuditManager.Types.ListControlsRequest, callback?: (err: AWSError, data: AuditManager.Types.ListControlsResponse) => void): Request<AuditManager.Types.ListControlsResponse, AWSError>; /* * Returns a list of controls from Audit Manager. / listControls(callback?: (err: AWSError, data: AuditManager.Types.ListControlsResponse) => void): Request<AuditManager.Types.ListControlsResponse, AWSError>; /* * Returns a list of keywords that are pre-mapped to the specified control data source. / listKeywordsForDataSource(params: AuditManager.Types.ListKeywordsForDataSourceRequest, callback?: (err: AWSError, data: AuditManager.Types.ListKeywordsForDataSourceResponse) => void): Request<AuditManager.Types.ListKeywordsForDataSourceResponse, AWSError>; /* * Returns a list of keywords that are pre-mapped to the specified control data source. / listKeywordsForDataSource(callback?: (err: AWSError, data: AuditManager.Types.ListKeywordsForDataSourceResponse) => void): Request<AuditManager.Types.ListKeywordsForDataSourceResponse, AWSError>; /* * Returns a list of all Audit Manager notifications. / listNotifications(params: AuditManager.Types.ListNotificationsRequest, callback?: (err: AWSError, data: AuditManager.Types.ListNotificationsResponse) => void): Request<AuditManager.Types.ListNotificationsResponse, AWSError>; /* * Returns a list of all Audit Manager notifications. / listNotifications(callback?: (err: AWSError, data: AuditManager.Types.ListNotificationsResponse) => void): Request<AuditManager.Types.ListNotificationsResponse, AWSError>; /* * Returns a list of tags for the specified resource in Audit Manager. / listTagsForResource(params: AuditManager.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AuditManager.Types.ListTagsForResourceResponse) => void): Request<AuditManager.Types.ListTagsForResourceResponse, AWSError>; /* * Returns a list of tags for the specified resource in Audit Manager. / listTagsForResource(callback?: (err: AWSError, data: AuditManager.Types.ListTagsForResourceResponse) => void): Request<AuditManager.Types.ListTagsForResourceResponse, AWSError>; /* * Enables Audit Manager for the specified Amazon Web Services account. / registerAccount(params: AuditManager.Types.RegisterAccountRequest, callback?: (err: AWSError, data: AuditManager.Types.RegisterAccountResponse) => void): Request<AuditManager.Types.RegisterAccountResponse, AWSError>; /* * Enables Audit Manager for the specified Amazon Web Services account. / registerAccount(callback?: (err: AWSError, data: AuditManager.Types.RegisterAccountResponse) => void): Request<AuditManager.Types.RegisterAccountResponse, AWSError>; /* * Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. / registerOrganizationAdminAccount(params: AuditManager.Types.RegisterOrganizationAdminAccountRequest, callback?: (err: AWSError, data: AuditManager.Types.RegisterOrganizationAdminAccountResponse) => void): Request<AuditManager.Types.RegisterOrganizationAdminAccountResponse, AWSError>; /* * Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. / registerOrganizationAdminAccount(callback?: (err: AWSError, data: AuditManager.Types.RegisterOrganizationAdminAccountResponse) => void): Request<AuditManager.Types.RegisterOrganizationAdminAccountResponse, AWSError>; /* * Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs: The sender revokes the share request. The recipient declines the share request. The recipient encounters an error and doesn't successfully accept the share request. The share request expires before the recipient responds to the request. When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide. / startAssessmentFrameworkShare(params: AuditManager.Types.StartAssessmentFrameworkShareRequest, callback?: (err: AWSError, data: AuditManager.Types.StartAssessmentFrameworkShareResponse) => void): Request<AuditManager.Types.StartAssessmentFrameworkShareResponse, AWSError>; /* * Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs: The sender revokes the share request. The recipient declines the share request. The recipient encounters an error and doesn't successfully accept the share request. The share request expires before the recipient responds to the request. When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide. / startAssessmentFrameworkShare(callback?: (err: AWSError, data: AuditManager.Types.StartAssessmentFrameworkShareResponse) => void): Request<AuditManager.Types.StartAssessmentFrameworkShareResponse, AWSError>; /* * Tags the specified resource in Audit Manager. / tagResource(params: AuditManager.Types.TagResourceRequest, callback?: (err: AWSError, data: AuditManager.Types.TagResourceResponse) => void): Request<AuditManager.Types.TagResourceResponse, AWSError>; /* * Tags the specified resource in Audit Manager. / tagResource(callback?: (err: AWSError, data: AuditManager.Types.TagResourceResponse) => void): Request<AuditManager.Types.TagResourceResponse, AWSError>; /* * Removes a tag from a resource in Audit Manager. / untagResource(params: AuditManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: AuditManager.Types.UntagResourceResponse) => void): Request<AuditManager.Types.UntagResourceResponse, AWSError>; /* * Removes a tag from a resource in Audit Manager. / untagResource(callback?: (err: AWSError, data: AuditManager.Types.UntagResourceResponse) => void): Request<AuditManager.Types.UntagResourceResponse, AWSError>; /* * Edits an Audit Manager assessment. / updateAssessment(params: AuditManager.Types.UpdateAssessmentRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentResponse) => void): Request<AuditManager.Types.UpdateAssessmentResponse, AWSError>; /* * Edits an Audit Manager assessment. / updateAssessment(callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentResponse) => void): Request<AuditManager.Types.UpdateAssessmentResponse, AWSError>; /* * Updates a control within an assessment in Audit Manager. / updateAssessmentControl(params: AuditManager.Types.UpdateAssessmentControlRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentControlResponse) => void): Request<AuditManager.Types.UpdateAssessmentControlResponse, AWSError>; /* * Updates a control within an assessment in Audit Manager. / updateAssessmentControl(callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentControlResponse) => void): Request<AuditManager.Types.UpdateAssessmentControlResponse, AWSError>; /* * Updates the status of a control set in an Audit Manager assessment. / updateAssessmentControlSetStatus(params: AuditManager.Types.UpdateAssessmentControlSetStatusRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentControlSetStatusResponse) => void): Request<AuditManager.Types.UpdateAssessmentControlSetStatusResponse, AWSError>; /* * Updates the status of a control set in an Audit Manager assessment. / updateAssessmentControlSetStatus(callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentControlSetStatusResponse) => void): Request<AuditManager.Types.UpdateAssessmentControlSetStatusResponse, AWSError>; /* * Updates a custom framework in Audit Manager. / updateAssessmentFramework(params: AuditManager.Types.UpdateAssessmentFrameworkRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentFrameworkResponse) => void): Request<AuditManager.Types.UpdateAssessmentFrameworkResponse, AWSError>; /* * Updates a custom framework in Audit Manager. / updateAssessmentFramework(callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentFrameworkResponse) => void): Request<AuditManager.Types.UpdateAssessmentFrameworkResponse, AWSError>; /* * Updates a share request for a custom framework in Audit Manager. / updateAssessmentFrameworkShare(params: AuditManager.Types.UpdateAssessmentFrameworkShareRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentFrameworkShareResponse) => void): Request<AuditManager.Types.UpdateAssessmentFrameworkShareResponse, AWSError>; /* * Updates a share request for a custom framework in Audit Manager. / updateAssessmentFrameworkShare(callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentFrameworkShareResponse) => void): Request<AuditManager.Types.UpdateAssessmentFrameworkShareResponse, AWSError>; /* * Updates the status of an assessment in Audit Manager. / updateAssessmentStatus(params: AuditManager.Types.UpdateAssessmentStatusRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentStatusResponse) => void): Request<AuditManager.Types.UpdateAssessmentStatusResponse, AWSError>; /* * Updates the status of an assessment in Audit Manager. / updateAssessmentStatus(callback?: (err: AWSError, data: AuditManager.Types.UpdateAssessmentStatusResponse) => void): Request<AuditManager.Types.UpdateAssessmentStatusResponse, AWSError>; /* * Updates a custom control in Audit Manager. / updateControl(params: AuditManager.Types.UpdateControlRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateControlResponse) => void): Request<AuditManager.Types.UpdateControlResponse, AWSError>; /* * Updates a custom control in Audit Manager. / updateControl(callback?: (err: AWSError, data: AuditManager.Types.UpdateControlResponse) => void): Request<AuditManager.Types.UpdateControlResponse, AWSError>; /* * Updates Audit Manager settings for the current account. / updateSettings(params: AuditManager.Types.UpdateSettingsRequest, callback?: (err: AWSError, data: AuditManager.Types.UpdateSettingsResponse) => void): Request<AuditManager.Types.UpdateSettingsResponse, AWSError>; /* * Updates Audit Manager settings for the current account. / updateSettings(callback?: (err: AWSError, data: AuditManager.Types.UpdateSettingsResponse) => void): Request<AuditManager.Types.UpdateSettingsResponse, AWSError>; /* * Validates the integrity of an assessment report in Audit Manager. / validateAssessmentReportIntegrity(params: AuditManager.Types.ValidateAssessmentReportIntegrityRequest, callback?: (err: AWSError, data: AuditManager.Types.ValidateAssessmentReportIntegrityResponse) => void): Request<AuditManager.Types.ValidateAssessmentReportIntegrityResponse, AWSError>; /* * Validates the integrity of an assessment report in Audit Manager. / validateAssessmentReportIntegrity(callback?: (err: AWSError, data: AuditManager.Types.ValidateAssessmentReportIntegrityResponse) => void): Request<AuditManager.Types.ValidateAssessmentReportIntegrityResponse, AWSError>; } declare namespace AuditManager { export interface AWSAccount { /* * The identifier for the Amazon Web Services account. / id?: AccountId; /* * The email address that's associated with the Amazon Web Services account. / emailAddress?: EmailAddress; /* * The name of the Amazon Web Services account. / name?: AccountName; } export type AWSAccounts = AWSAccount[]; export interface AWSService { /* * The name of the Amazon Web Service. / serviceName?: AWSServiceName; } export type AWSServiceName = string; export type AWSServices = AWSService[]; export type AccountId = string; export type AccountName = string; export type AccountStatus = "ACTIVE"\|"INACTIVE"\|"PENDING_ACTIVATION"\|string; export type ActionEnum = "CREATE"\|"UPDATE_METADATA"\|"ACTIVE"\|"INACTIVE"\|"DELETE"\|"UNDER_REVIEW"\|"REVIEWED"\|"IMPORT_EVIDENCE"\|string; export type ActionPlanInstructions = string; export type ActionPlanTitle = string; export interface Assessment { /* * The Amazon Resource Name (ARN) of the assessment. / arn?: AuditManagerArn; /* * The Amazon Web Services account that's associated with the assessment. / awsAccount?: AWSAccount; /* * The metadata for the assessment. / metadata?: AssessmentMetadata; /* * The framework that the assessment was created from. / framework?: AssessmentFramework; /* * The tags that are associated with the assessment. / tags?: TagMap; } export interface AssessmentControl { /* * The identifier for the control. / id?: UUID; /* * The name of the control. / name?: ControlName; /* * The description of the control. / description?: ControlDescription; /* * The status of the control. / status?: ControlStatus; /* * The response of the control. / response?: ControlResponse; /* * The list of comments that's attached to the control. / comments?: ControlComments; /* * The list of data sources for the evidence. / evidenceSources?: EvidenceSources; /* * The amount of evidence that's collected for the control. / evidenceCount?: Integer; /* * The amount of evidence in the assessment report. / assessmentReportEvidenceCount?: Integer; } export interface AssessmentControlSet { /* * The identifier of the control set in the assessment. This is the control set name in a plain string format. / id?: ControlSetId; /* * The description for the control set. / description?: NonEmptyString; /* * The current status of the control set. / status?: ControlSetStatus; /* * The roles that are associated with the control set. / roles?: Roles; /* * The list of controls that's contained with the control set. / controls?: AssessmentControls; /* * The delegations that are associated with the control set. / delegations?: Delegations; /* * The total number of evidence objects that are retrieved automatically for the control set. / systemEvidenceCount?: Integer; /* * The total number of evidence objects that are uploaded manually to the control set. / manualEvidenceCount?: Integer; } export type AssessmentControlSets = AssessmentControlSet[]; export type AssessmentControls = AssessmentControl[]; export type AssessmentDescription = string; export interface AssessmentEvidenceFolder { /* * The name of the evidence folder. / name?: AssessmentEvidenceFolderName; /* * The date when the first evidence was added to the evidence folder. / date?: Timestamp; /* * The identifier for the assessment. / assessmentId?: UUID; /* * The identifier for the control set. / controlSetId?: ControlSetId; /* * The unique identifier for the control. / controlId?: UUID; /* * The identifier for the folder that the evidence is stored in. / id?: UUID; /* * The Amazon Web Service that the evidence was collected from. / dataSource?: String; /* * The name of the user who created the evidence folder. / author?: String; /* * The total amount of evidence in the evidence folder. / totalEvidence?: Integer; /* * The total count of evidence that's included in the assessment report. / assessmentReportSelectionCount?: Integer; /* * The name of the control. / controlName?: ControlName; /* * The amount of evidence that's included in the evidence folder. / evidenceResourcesIncludedCount?: Integer; /* * The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM. / evidenceByTypeConfigurationDataCount?: Integer; /* * The number of evidence that falls under the manual category. This evidence is imported manually. / evidenceByTypeManualCount?: Integer; /* * The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub. / evidenceByTypeComplianceCheckCount?: Integer; /* * The total number of issues that were reported directly from Security Hub, Config, or both. / evidenceByTypeComplianceCheckIssuesCount?: Integer; /* * The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs. / evidenceByTypeUserActivityCount?: Integer; /* * The total number of Amazon Web Services resources that were assessed to generate the evidence. / evidenceAwsServiceSourceCount?: Integer; } export type AssessmentEvidenceFolderName = string; export type AssessmentEvidenceFolders = AssessmentEvidenceFolder[]; export interface AssessmentFramework { /* * The unique identifier for the framework. / id?: UUID; /* * The Amazon Resource Name (ARN) of the framework. / arn?: AuditManagerArn; metadata?: FrameworkMetadata; /* * The control sets that are associated with the framework. / controlSets?: AssessmentControlSets; } export type AssessmentFrameworkDescription = string; export interface AssessmentFrameworkMetadata { /* * The Amazon Resource Name (ARN) of the framework. / arn?: AuditManagerArn; /* * The unique identifier for the framework. / id?: UUID; /* * The framework type, such as a standard framework or a custom framework. / type?: FrameworkType; /* * The name of the framework. / name?: FrameworkName; /* * The description of the framework. / description?: FrameworkDescription; /* * The logo that's associated with the framework. / logo?: Filename; /* * The compliance type that the new custom framework supports, such as CIS or HIPAA. / complianceType?: ComplianceType; /* * The number of controls that are associated with the framework. / controlsCount?: ControlsCount; /* * The number of control sets that are associated with the framework. / controlSetsCount?: ControlSetsCount; /* * The time when the framework was created. / createdAt?: Timestamp; /* * The time when the framework was most recently updated. / lastUpdatedAt?: Timestamp; } export interface AssessmentFrameworkShareRequest { /* * The unique identifier for the share request. / id?: UUID; /* * The unique identifier for the shared custom framework. / frameworkId?: UUID; /* * The name of the custom framework that the share request is for. / frameworkName?: FrameworkName; /* * The description of the shared custom framework. / frameworkDescription?: FrameworkDescription; /* * The status of the share request. / status?: ShareRequestStatus; /* * The Amazon Web Services account of the sender. / sourceAccount?: AccountId; /* * The Amazon Web Services account of the recipient. / destinationAccount?: AccountId; /* * The Amazon Web Services Region of the recipient. / destinationRegion?: Region; /* * The time when the share request expires. / expirationTime?: Timestamp; /* * The time when the share request was created. / creationTime?: Timestamp; /* * Specifies when the share request was last updated. / lastUpdated?: Timestamp; /* * An optional comment from the sender about the share request. / comment?: ShareRequestComment; /* * The number of standard controls that are part of the shared custom framework. / standardControlsCount?: NullableInteger; /* * The number of custom controls that are part of the shared custom framework. / customControlsCount?: NullableInteger; /* * The compliance type that the shared custom framework supports, such as CIS or HIPAA. / complianceType?: ComplianceType; } export type AssessmentFrameworkShareRequestList = AssessmentFrameworkShareRequest[]; export interface AssessmentMetadata { /* * The name of the assessment. / name?: AssessmentName; /* * The unique identifier for the assessment. / id?: UUID; /* * The description of the assessment. / description?: AssessmentDescription; /* * The name of the compliance standard that's related to the assessment, such as PCI-DSS. / complianceType?: ComplianceType; /* * The overall status of the assessment. / status?: AssessmentStatus; /* * The destination that evidence reports are stored in for the assessment. / assessmentReportsDestination?: AssessmentReportsDestination; /* * The wrapper of Amazon Web Services accounts and services that are in scope for the assessment. / scope?: Scope; /* * The roles that are associated with the assessment. / roles?: Roles; /* * The delegations that are associated with the assessment. / delegations?: Delegations; /* * Specifies when the assessment was created. / creationTime?: Timestamp; /* * The time of the most recent update. / lastUpdated?: Timestamp; } export interface AssessmentMetadataItem { /* * The name of the assessment. / name?: AssessmentName; /* * The unique identifier for the assessment. / id?: UUID; /* * The name of the compliance standard that's related to the assessment, such as PCI-DSS. / complianceType?: ComplianceType; /* * The current status of the assessment. / status?: AssessmentStatus; /* * The roles that are associated with the assessment. / roles?: Roles; /* * The delegations that are associated with the assessment. / delegations?: Delegations; /* * Specifies when the assessment was created. / creationTime?: Timestamp; /* * The time of the most recent update. / lastUpdated?: Timestamp; } export type AssessmentName = string; export interface AssessmentReport { /* * The unique identifier for the assessment report. / id?: UUID; /* * The name that's given to the assessment report. / name?: AssessmentReportName; /* * The description of the specified assessment report. / description?: AssessmentReportDescription; /* * The identifier for the specified Amazon Web Services account. / awsAccountId?: AccountId; /* * The identifier for the specified assessment. / assessmentId?: UUID; /* * The name of the associated assessment. / assessmentName?: AssessmentName; /* * The name of the user who created the assessment report. / author?: Username; /* * The current status of the specified assessment report. / status?: AssessmentReportStatus; /* * Specifies when the assessment report was created. / creationTime?: Timestamp; } export type AssessmentReportDescription = string; export type AssessmentReportDestinationType = "S3"\|string; export interface AssessmentReportEvidenceError { /* * The identifier for the evidence. / evidenceId?: UUID; /* * The error code that was returned. / errorCode?: ErrorCode; /* * The error message that was returned. / errorMessage?: ErrorMessage; } export type AssessmentReportEvidenceErrors = AssessmentReportEvidenceError[]; export interface AssessmentReportMetadata { /* * The unique identifier for the assessment report. / id?: UUID; /* * The name of the assessment report. / name?: AssessmentReportName; /* * The description of the assessment report. / description?: AssessmentReportDescription; /* * The unique identifier for the associated assessment. / assessmentId?: UUID; /* * The name of the associated assessment. / assessmentName?: AssessmentName; /* * The name of the user who created the assessment report. / author?: Username; /* * The current status of the assessment report. / status?: AssessmentReportStatus; /* * Specifies when the assessment report was created. / creationTime?: Timestamp; } export type AssessmentReportName = string; export type AssessmentReportStatus = "COMPLETE"\|"IN_PROGRESS"\|"FAILED"\|string; export interface AssessmentReportsDestination { /* * The destination type, such as Amazon S3. / destinationType?: AssessmentReportDestinationType; /* * The destination bucket where Audit Manager stores assessment reports. / destination?: S3Url; } export type AssessmentReportsMetadata = AssessmentReportMetadata[]; export type AssessmentStatus = "ACTIVE"\|"INACTIVE"\|string; export interface AssociateAssessmentReportEvidenceFolderRequest { /* * The identifier for the assessment. / assessmentId: UUID; /* * The identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; } export interface AssociateAssessmentReportEvidenceFolderResponse { } export type AuditManagerArn = string; export interface BatchAssociateAssessmentReportEvidenceRequest { /* * The identifier for the assessment. / assessmentId: UUID; /* * The identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; /* * The list of evidence identifiers. / evidenceIds: EvidenceIds; } export interface BatchAssociateAssessmentReportEvidenceResponse { /* * The list of evidence identifiers. / evidenceIds?: EvidenceIds; /* * A list of errors that the BatchAssociateAssessmentReportEvidence API returned. / errors?: AssessmentReportEvidenceErrors; } export interface BatchCreateDelegationByAssessmentError { /* * The API request to batch create delegations in Audit Manager. / createDelegationRequest?: CreateDelegationRequest; /* * The error code that the BatchCreateDelegationByAssessment API returned. / errorCode?: ErrorCode; /* * The error message that the BatchCreateDelegationByAssessment API returned. / errorMessage?: ErrorMessage; } export type BatchCreateDelegationByAssessmentErrors = BatchCreateDelegationByAssessmentError[]; export interface BatchCreateDelegationByAssessmentRequest { /* * The API request to batch create delegations in Audit Manager. / createDelegationRequests: CreateDelegationRequests; /* * The identifier for the assessment. / assessmentId: UUID; } export interface BatchCreateDelegationByAssessmentResponse { /* * The delegations that are associated with the assessment. / delegations?: Delegations; /* * A list of errors that the BatchCreateDelegationByAssessment API returned. / errors?: BatchCreateDelegationByAssessmentErrors; } export interface BatchDeleteDelegationByAssessmentError { /* * The identifier for the delegation. / delegationId?: UUID; /* * The error code that the BatchDeleteDelegationByAssessment API returned. / errorCode?: ErrorCode; /* * The error message that the BatchDeleteDelegationByAssessment API returned. / errorMessage?: ErrorMessage; } export type BatchDeleteDelegationByAssessmentErrors = BatchDeleteDelegationByAssessmentError[]; export interface BatchDeleteDelegationByAssessmentRequest { /* * The identifiers for the delegations. / delegationIds: DelegationIds; /* * The identifier for the assessment. / assessmentId: UUID; } export interface BatchDeleteDelegationByAssessmentResponse { /* * A list of errors that the BatchDeleteDelegationByAssessment API returned. / errors?: BatchDeleteDelegationByAssessmentErrors; } export interface BatchDisassociateAssessmentReportEvidenceRequest { /* * The identifier for the assessment. / assessmentId: UUID; /* * The identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; /* * The list of evidence identifiers. / evidenceIds: EvidenceIds; } export interface BatchDisassociateAssessmentReportEvidenceResponse { /* * The identifier for the evidence. / evidenceIds?: EvidenceIds; /* * A list of errors that the BatchDisassociateAssessmentReportEvidence API returned. / errors?: AssessmentReportEvidenceErrors; } export interface BatchImportEvidenceToAssessmentControlError { /* * Manual evidence that can't be collected automatically by Audit Manager. / manualEvidence?: ManualEvidence; /* * The error code that the BatchImportEvidenceToAssessmentControl API returned. / errorCode?: ErrorCode; /* * The error message that the BatchImportEvidenceToAssessmentControl API returned. / errorMessage?: ErrorMessage; } export type BatchImportEvidenceToAssessmentControlErrors = BatchImportEvidenceToAssessmentControlError[]; export interface BatchImportEvidenceToAssessmentControlRequest { /* * The identifier for the assessment. / assessmentId: UUID; /* * The identifier for the control set. / controlSetId: ControlSetId; /* * The identifier for the control. / controlId: UUID; /* * The list of manual evidence objects. / manualEvidence: ManualEvidenceList; } export interface BatchImportEvidenceToAssessmentControlResponse { /* * A list of errors that the BatchImportEvidenceToAssessmentControl API returned. / errors?: BatchImportEvidenceToAssessmentControlErrors; } export type Boolean = boolean; export interface ChangeLog { /* * The object that was changed, such as an assessment, control, or control set. / objectType?: ObjectTypeEnum; /* * The name of the object that changed. This could be the name of an assessment, control, or control set. / objectName?: NonEmptyString; /* * The action that was performed. / action?: ActionEnum; /* * The time when the action was performed and the changelog record was created. / createdAt?: Timestamp; /* * The user or role that performed the action. / createdBy?: IamArn; } export type ChangeLogs = ChangeLog[]; export type CloudTrailArn = string; export type ComplianceType = string; export interface Control { /* * The Amazon Resource Name (ARN) of the control. / arn?: AuditManagerArn; /* * The unique identifier for the control. / id?: UUID; /* * Specifies whether the control is a standard control or a custom control. / type?: ControlType; /* * The name of the control. / name?: ControlName; /* * The description of the control. / description?: ControlDescription; /* * The steps that you should follow to determine if the control has been satisfied. / testingInformation?: TestingInformation; /* * The title of the action plan for remediating the control. / actionPlanTitle?: ActionPlanTitle; /* * The recommended actions to carry out if the control isn't fulfilled. / actionPlanInstructions?: ActionPlanInstructions; /* * The data source types that determine where Audit Manager collects evidence from for the control. / controlSources?: ControlSources; /* * The data mapping sources for the control. / controlMappingSources?: ControlMappingSources; /* * The time when the control was created. / createdAt?: Timestamp; /* * The time when the control was most recently updated. / lastUpdatedAt?: Timestamp; /* * The user or role that created the control. / createdBy?: CreatedBy; /* * The user or role that most recently updated the control. / lastUpdatedBy?: LastUpdatedBy; /* * The tags associated with the control. / tags?: TagMap; /* * The state of the control. The END_OF_SUPPORT state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control. / state?: ControlState; } export type ControlCatalogId = string; export interface ControlComment { /* * The name of the user who authored the comment. / authorName?: Username; /* * The body text of a control comment. / commentBody?: ControlCommentBody; /* * The time when the comment was posted. / postedDate?: Timestamp; } export type ControlCommentBody = string; export type ControlComments = ControlComment[]; export type ControlDescription = string; export type ControlDomainId = string; export interface ControlDomainInsights { /* * The name of the control domain. / name?: String; /* * The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. / id?: ControlDomainId; /* * The number of controls in the control domain that collected non-compliant evidence on the lastUpdated date. / controlsCountByNoncompliantEvidence?: NullableInteger; /* * The total number of controls in the control domain. / totalControlsCount?: NullableInteger; /* * A breakdown of the compliance check status for the evidence that’s associated with the control domain. / evidenceInsights?: EvidenceInsights; /* * The time when the control domain insights were last updated. / lastUpdated?: Timestamp; } export type ControlDomainInsightsList = ControlDomainInsights[]; export type ControlInsightsMetadata = ControlInsightsMetadataItem[]; export type ControlInsightsMetadataByAssessment = ControlInsightsMetadataByAssessmentItem[]; export interface ControlInsightsMetadataByAssessmentItem { /* * The name of the assessment control. / name?: String; /* * The unique identifier for the assessment control. / id?: ControlDomainId; /* * A breakdown of the compliance check status for the evidence that’s associated with the assessment control. / evidenceInsights?: EvidenceInsights; /* * The name of the control set that the assessment control belongs to. / controlSetName?: NonEmptyString; /* * The time when the assessment control insights were last updated. / lastUpdated?: Timestamp; } export interface ControlInsightsMetadataItem { /* * The name of the control. / name?: String; /* * The unique identifier for the control. / id?: ControlDomainId; /* * A breakdown of the compliance check status for the evidence that’s associated with the control. / evidenceInsights?: EvidenceInsights; /* * The time when the control insights were last updated. / lastUpdated?: Timestamp; } export interface ControlMappingSource { /* * The unique identifier for the source. / sourceId?: UUID; /* * The name of the source. / sourceName?: SourceName; /* * The description of the source. / sourceDescription?: SourceDescription; /* * The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for sourceSetUpOption, Audit Manager automatically infers and populates the correct value based on the sourceType that you specify. / sourceSetUpOption?: SourceSetUpOption; /* * Specifies which type of data source is used to collect evidence. The source can be an individual data source type, such as AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, or MANUAL. The source can also be a managed grouping of data sources, such as a Core_Control or a Common_Control. / sourceType?: SourceType; sourceKeyword?: SourceKeyword; /* * Specifies how often evidence is collected from the control mapping source. / sourceFrequency?: SourceFrequency; /* * The instructions for troubleshooting the control. / troubleshootingText?: TroubleshootingText; } export type ControlMappingSources = ControlMappingSource[]; export interface ControlMetadata { /* * The Amazon Resource Name (ARN) of the control. / arn?: AuditManagerArn; /* * The unique identifier for the control. / id?: UUID; /* * The name of the control. / name?: ControlName; /* * The data source that determines where Audit Manager collects evidence from for the control. / controlSources?: ControlSources; /* * The time when the control was created. / createdAt?: Timestamp; /* * The time when the control was most recently updated. / lastUpdatedAt?: Timestamp; } export type ControlMetadataList = ControlMetadata[]; export type ControlName = string; export type ControlResponse = "MANUAL"\|"AUTOMATE"\|"DEFER"\|"IGNORE"\|string; export interface ControlSet { /* * The identifier of the control set in the assessment. This is the control set name in a plain string format. / id?: UUID; /* * The name of the control set. / name?: ControlSetName; /* * The list of controls within the control set. / controls?: Controls; } export type ControlSetId = string; export type ControlSetName = string; export type ControlSetStatus = "ACTIVE"\|"UNDER_REVIEW"\|"REVIEWED"\|string; export type ControlSets = ControlSet[]; export type ControlSetsCount = number; export type ControlSources = string; export type ControlState = "ACTIVE"\|"END_OF_SUPPORT"\|string; export type ControlStatus = "UNDER_REVIEW"\|"REVIEWED"\|"INACTIVE"\|string; export type ControlType = "Standard"\|"Custom"\|"Core"\|string; export type Controls = Control[]; export type ControlsCount = number; export interface CreateAssessmentFrameworkControl { /* * The unique identifier of the control. / id: UUID; } export interface CreateAssessmentFrameworkControlSet { /* * The name of the control set. / name: ControlSetName; /* * The list of controls within the control set. This doesn't contain the control set ID. / controls?: CreateAssessmentFrameworkControls; } export type CreateAssessmentFrameworkControlSets = CreateAssessmentFrameworkControlSet[]; export type CreateAssessmentFrameworkControls = CreateAssessmentFrameworkControl[]; export interface CreateAssessmentFrameworkRequest { /* * The name of the new custom framework. / name: FrameworkName; /* * An optional description for the new custom framework. / description?: FrameworkDescription; /* * The compliance type that the new custom framework supports, such as CIS or HIPAA. / complianceType?: ComplianceType; /* * The control sets that are associated with the framework. / controlSets: CreateAssessmentFrameworkControlSets; /* * The tags that are associated with the framework. / tags?: TagMap; } export interface CreateAssessmentFrameworkResponse { /* * The name of the new framework that the CreateAssessmentFramework API returned. / framework?: Framework; } export interface CreateAssessmentReportRequest { /* * The name of the new assessment report. / name: AssessmentReportName; /* * The description of the assessment report. / description?: AssessmentReportDescription; /* * The identifier for the assessment. / assessmentId: UUID; /* * A SQL statement that represents an evidence finder query. Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API. To use this parameter, the enablementStatus of evidence finder must be ENABLED. For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide. / queryStatement?: QueryStatement; } export interface CreateAssessmentReportResponse { /* * The new assessment report that the CreateAssessmentReport API returned. / assessmentReport?: AssessmentReport; } export interface CreateAssessmentRequest { /* * The name of the assessment to be created. / name: AssessmentName; /* * The optional description of the assessment to be created. / description?: AssessmentDescription; /* * The assessment report storage destination for the assessment that's being created. / assessmentReportsDestination: AssessmentReportsDestination; scope: Scope; /* * The list of roles for the assessment. / roles: Roles; /* * The identifier for the framework that the assessment will be created from. / frameworkId: UUID; /* * The tags that are associated with the assessment. / tags?: TagMap; } export interface CreateAssessmentResponse { assessment?: Assessment; } export interface CreateControlMappingSource { /* * The name of the control mapping data source. / sourceName?: SourceName; /* * The description of the data source that determines where Audit Manager collects evidence from for the control. / sourceDescription?: SourceDescription; /* * The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for sourceSetUpOption, Audit Manager automatically infers and populates the correct value based on the sourceType that you specify. / sourceSetUpOption?: SourceSetUpOption; /* * Specifies which type of data source is used to collect evidence. The source can be an individual data source type, such as AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call, or MANUAL. The source can also be a managed grouping of data sources, such as a Core_Control or a Common_Control. / sourceType?: SourceType; sourceKeyword?: SourceKeyword; /* * Specifies how often evidence is collected from the control mapping source. / sourceFrequency?: SourceFrequency; /* * The instructions for troubleshooting the control. / troubleshootingText?: TroubleshootingText; } export type CreateControlMappingSources = CreateControlMappingSource[]; export interface CreateControlRequest { /* * The name of the control. / name: ControlName; /* * The description of the control. / description?: ControlDescription; /* * The steps to follow to determine if the control is satisfied. / testingInformation?: TestingInformation; /* * The title of the action plan for remediating the control. / actionPlanTitle?: ActionPlanTitle; /* * The recommended actions to carry out if the control isn't fulfilled. / actionPlanInstructions?: ActionPlanInstructions; /* * The data mapping sources for the control. / controlMappingSources: CreateControlMappingSources; /* * The tags that are associated with the control. / tags?: TagMap; } export interface CreateControlResponse { /* * The new control that the CreateControl API returned. / control?: Control; } export interface CreateDelegationRequest { /* * A comment that's related to the delegation request. / comment?: DelegationComment; /* * The unique identifier for the control set. / controlSetId?: ControlSetId; /* * The Amazon Resource Name (ARN) of the IAM role. / roleArn?: IamArn; /* * The type of customer persona. In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER. / roleType?: RoleType; } export type CreateDelegationRequests = CreateDelegationRequest[]; export type CreatedBy = string; export type DataSourceType = "AWS_Cloudtrail"\|"AWS_Config"\|"AWS_Security_Hub"\|"AWS_API_Call"\|"MANUAL"\|string; export interface DefaultExportDestination { /* * The destination type, such as Amazon S3. / destinationType?: ExportDestinationType; /* * The destination bucket where Audit Manager stores exported files. / destination?: S3Url; } export interface Delegation { /* * The unique identifier for the delegation. / id?: UUID; /* * The name of the assessment that's associated with the delegation. / assessmentName?: AssessmentName; /* * The identifier for the assessment that's associated with the delegation. / assessmentId?: UUID; /* * The status of the delegation. / status?: DelegationStatus; /* * The Amazon Resource Name (ARN) of the IAM role. / roleArn?: IamArn; /* * The type of customer persona. In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER. / roleType?: RoleType; /* * Specifies when the delegation was created. / creationTime?: Timestamp; /* * Specifies when the delegation was last updated. / lastUpdated?: Timestamp; /* * The identifier for the control set that's associated with the delegation. / controlSetId?: ControlSetId; /* * The comment that's related to the delegation. / comment?: DelegationComment; /* * The user or role that created the delegation. / createdBy?: CreatedBy; } export type DelegationComment = string; export type DelegationIds = UUID[]; export interface DelegationMetadata { /* * The unique identifier for the delegation. / id?: UUID; /* * The name of the associated assessment. / assessmentName?: AssessmentName; /* * The unique identifier for the assessment. / assessmentId?: UUID; /* * The current status of the delegation. / status?: DelegationStatus; /* * The Amazon Resource Name (ARN) of the IAM role. / roleArn?: IamArn; /* * Specifies when the delegation was created. / creationTime?: Timestamp; /* * Specifies the name of the control set that was delegated for review. / controlSetName?: NonEmptyString; } export type DelegationMetadataList = DelegationMetadata[]; export type DelegationStatus = "IN_PROGRESS"\|"UNDER_REVIEW"\|"COMPLETE"\|string; export type Delegations = Delegation[]; export interface DeleteAssessmentFrameworkRequest { /* * The identifier for the custom framework. / frameworkId: UUID; } export interface DeleteAssessmentFrameworkResponse { } export interface DeleteAssessmentFrameworkShareRequest { /* * The unique identifier for the share request to be deleted. / requestId: UUID; /* * Specifies whether the share request is a sent request or a received request. / requestType: ShareRequestType; } export interface DeleteAssessmentFrameworkShareResponse { } export interface DeleteAssessmentReportRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the assessment report. / assessmentReportId: UUID; } export interface DeleteAssessmentReportResponse { } export interface DeleteAssessmentRequest { /* * The identifier for the assessment. / assessmentId: UUID; } export interface DeleteAssessmentResponse { } export interface DeleteControlRequest { /* * The unique identifier for the control. / controlId: UUID; } export interface DeleteControlResponse { } export type DeleteResources = "ALL"\|"DEFAULT"\|string; export interface DeregisterAccountRequest { } export interface DeregisterAccountResponse { /* * The registration status of the account. / status?: AccountStatus; } export interface DeregisterOrganizationAdminAccountRequest { /* * The identifier for the administrator account. / adminAccountId?: AccountId; } export interface DeregisterOrganizationAdminAccountResponse { } export interface DeregistrationPolicy { /* * Specifies which Audit Manager data will be deleted when you deregister Audit Manager. If you set the value to ALL, all of your data is deleted within seven days of deregistration. If you set the value to DEFAULT, none of your data is deleted at the time of deregistration. However, keep in mind that the Audit Manager data retention policy still applies. As a result, any evidence data will be deleted two years after its creation date. Your other Audit Manager resources will continue to exist indefinitely. / deleteResources?: DeleteResources; } export interface DisassociateAssessmentReportEvidenceFolderRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; } export interface DisassociateAssessmentReportEvidenceFolderResponse { } export type EmailAddress = string; export type ErrorCode = string; export type ErrorMessage = string; export type EventName = string; export interface Evidence { /* * The data source where the evidence was collected from. / dataSource?: String; /* * The identifier for the Amazon Web Services account. / evidenceAwsAccountId?: AccountId; /* * The timestamp that represents when the evidence was collected. / time?: Timestamp; /* * The Amazon Web Service that the evidence is collected from. / eventSource?: AWSServiceName; /* * The name of the evidence event. / eventName?: EventName; /* * The type of automated evidence. / evidenceByType?: String; /* * The list of resources that are assessed to generate the evidence. / resourcesIncluded?: Resources; /* * The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false). / attributes?: EvidenceAttributes; /* * The unique identifier for the user or role that's associated with the evidence. / iamId?: IamArn; /* * The evaluation status for automated evidence that falls under the compliance check category. Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). / complianceCheck?: String; /* * The Amazon Web Services account that the evidence is collected from, and its organization path. / awsOrganization?: String; /* * The identifier for the Amazon Web Services account. / awsAccountId?: AccountId; /* * The identifier for the folder that the evidence is stored in. / evidenceFolderId?: UUID; /* * The identifier for the evidence. / id?: UUID; /* * Specifies whether the evidence is included in the assessment report. / assessmentReportSelection?: String; } export type EvidenceAttributeKey = string; export type EvidenceAttributeValue = string; export type EvidenceAttributes = {[key: string]: EvidenceAttributeValue}; export type EvidenceFinderBackfillStatus = "NOT_STARTED"\|"IN_PROGRESS"\|"COMPLETED"\|string; export interface EvidenceFinderEnablement { /* * The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder. The event data store is the lake of evidence data that evidence finder runs queries against. / eventDataStoreArn?: CloudTrailArn; /* * The current status of the evidence finder feature and the related event data store. ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries. ENABLED means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete. DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store. DISABLED means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point. / enablementStatus?: EvidenceFinderEnablementStatus; /* * The current status of the evidence data backfill process. The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried. NOT_STARTED means that the backfill hasn’t started yet. IN_PROGRESS means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data. COMPLETED means that the backfill is complete. All of your past evidence is now queryable. / backfillStatus?: EvidenceFinderBackfillStatus; /* * Represents any errors that occurred when enabling or disabling evidence finder. / error?: ErrorMessage; } export type EvidenceFinderEnablementStatus = "ENABLED"\|"DISABLED"\|"ENABLE_IN_PROGRESS"\|"DISABLE_IN_PROGRESS"\|string; export type EvidenceIds = UUID[]; export interface EvidenceInsights { /* * The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling. / noncompliantEvidenceCount?: NullableInteger; /* * The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling. / compliantEvidenceCount?: NullableInteger; /* * The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data. / inconclusiveEvidenceCount?: NullableInteger; } export type EvidenceList = Evidence[]; export type EvidenceSources = NonEmptyString[]; export type ExportDestinationType = "S3"\|string; export type Filename = string; export interface Framework { /* * The Amazon Resource Name (ARN) of the framework. / arn?: AuditManagerArn; /* * The unique identifier for the framework. / id?: UUID; /* * The name of the framework. / name?: FrameworkName; /* * Specifies whether the framework is a standard framework or a custom framework. / type?: FrameworkType; /* * The compliance type that the framework supports, such as CIS or HIPAA. / complianceType?: ComplianceType; /* * The description of the framework. / description?: FrameworkDescription; /* * The logo that's associated with the framework. / logo?: Filename; /* * The control data sources where Audit Manager collects evidence from. / controlSources?: ControlSources; /* * The control sets that are associated with the framework. / controlSets?: ControlSets; /* * The time when the framework was created. / createdAt?: Timestamp; /* * The time when the framework was most recently updated. / lastUpdatedAt?: Timestamp; /* * The user or role that created the framework. / createdBy?: CreatedBy; /* * The user or role that most recently updated the framework. / lastUpdatedBy?: LastUpdatedBy; /* * The tags that are associated with the framework. / tags?: TagMap; } export type FrameworkDescription = string; export interface FrameworkMetadata { /* * The name of the framework. / name?: AssessmentName; /* * The description of the framework. / description?: AssessmentFrameworkDescription; /* * The logo that's associated with the framework. / logo?: Filename; /* * The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA. / complianceType?: ComplianceType; } export type FrameworkMetadataList = AssessmentFrameworkMetadata[]; export type FrameworkName = string; export type FrameworkType = "Standard"\|"Custom"\|string; export type GenericArn = string; export interface GetAccountStatusRequest { } export interface GetAccountStatusResponse { /* * The status of the Amazon Web Services account. / status?: AccountStatus; } export interface GetAssessmentFrameworkRequest { /* * The identifier for the framework. / frameworkId: UUID; } export interface GetAssessmentFrameworkResponse { /* * The framework that the GetAssessmentFramework API returned. / framework?: Framework; } export interface GetAssessmentReportUrlRequest { /* * The unique identifier for the assessment report. / assessmentReportId: UUID; /* * The unique identifier for the assessment. / assessmentId: UUID; } export interface GetAssessmentReportUrlResponse { preSignedUrl?: URL; } export interface GetAssessmentRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; } export interface GetAssessmentResponse { assessment?: Assessment; userRole?: Role; } export interface GetChangeLogsRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the control set. / controlSetId?: ControlSetId; /* * The unique identifier for the control. / controlId?: UUID; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface GetChangeLogsResponse { /* * The list of user activity for the control. / changeLogs?: ChangeLogs; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface GetControlRequest { /* * The identifier for the control. / controlId: UUID; } export interface GetControlResponse { /* * The details of the control that the GetControl API returned. / control?: Control; } export interface GetDelegationsRequest { /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface GetDelegationsResponse { /* * The list of delegations that the GetDelegations API returned. / delegations?: DelegationMetadataList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface GetEvidenceByEvidenceFolderRequest { /* * The identifier for the assessment. / assessmentId: UUID; /* * The identifier for the control set. / controlSetId: ControlSetId; /* * The unique identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface GetEvidenceByEvidenceFolderResponse { /* * The list of evidence that the GetEvidenceByEvidenceFolder API returned. / evidence?: EvidenceList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface GetEvidenceFileUploadUrlRequest { /* * The file that you want to upload. For a list of supported file formats, see Supported file types for manual evidence in the Audit Manager User Guide. / fileName: ManualEvidenceLocalFileName; } export interface GetEvidenceFileUploadUrlResponse { /* * The name of the uploaded manual evidence file that the presigned URL was generated for. / evidenceFileName?: NonEmptyString; /* * The presigned URL that was generated. / uploadUrl?: NonEmptyString; } export interface GetEvidenceFolderRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the control set. / controlSetId: ControlSetId; /* * The unique identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; } export interface GetEvidenceFolderResponse { /* * The folder that the evidence is stored in. / evidenceFolder?: AssessmentEvidenceFolder; } export interface GetEvidenceFoldersByAssessmentControlRequest { /* * The identifier for the assessment. / assessmentId: UUID; /* * The identifier for the control set. / controlSetId: ControlSetId; /* * The identifier for the control. / controlId: UUID; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface GetEvidenceFoldersByAssessmentControlResponse { /* * The list of evidence folders that the GetEvidenceFoldersByAssessmentControl API returned. / evidenceFolders?: AssessmentEvidenceFolders; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface GetEvidenceFoldersByAssessmentRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface GetEvidenceFoldersByAssessmentResponse { /* * The list of evidence folders that the GetEvidenceFoldersByAssessment API returned. / evidenceFolders?: AssessmentEvidenceFolders; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface GetEvidenceRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the control set. / controlSetId: ControlSetId; /* * The unique identifier for the folder that the evidence is stored in. / evidenceFolderId: UUID; /* * The unique identifier for the evidence. / evidenceId: UUID; } export interface GetEvidenceResponse { /* * The evidence that the GetEvidence API returned. / evidence?: Evidence; } export interface GetInsightsByAssessmentRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; } export interface GetInsightsByAssessmentResponse { /* * The assessment analytics data that the GetInsightsByAssessment API returned. / insights?: InsightsByAssessment; } export interface GetInsightsRequest { } export interface GetInsightsResponse { /* * The analytics data that the GetInsights API returned. / insights?: Insights; } export interface GetOrganizationAdminAccountRequest { } export interface GetOrganizationAdminAccountResponse { /* * The identifier for the administrator account. / adminAccountId?: AccountId; /* * The identifier for the organization. / organizationId?: organizationId; } export interface GetServicesInScopeRequest { } export interface GetServicesInScopeResponse { /* * The metadata that's associated with the Amazon Web Service. / serviceMetadata?: ServiceMetadataList; } export interface GetSettingsRequest { /* * The list of setting attribute enum values. / attribute: SettingAttribute; } export interface GetSettingsResponse { /* * The settings object that holds all supported Audit Manager settings. / settings?: Settings; } export type HyperlinkName = string; export type IamArn = string; export interface Insights { /* * The number of active assessments in Audit Manager. / activeAssessmentsCount?: NullableInteger; /* * The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling. / noncompliantEvidenceCount?: NullableInteger; /* * The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling. / compliantEvidenceCount?: NullableInteger; /* * The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data. / inconclusiveEvidenceCount?: NullableInteger; /* * The number of assessment controls that collected non-compliant evidence on the lastUpdated date. / assessmentControlsCountByNoncompliantEvidence?: NullableInteger; /* * The total number of controls across all active assessments. / totalAssessmentControlsCount?: NullableInteger; /* * The time when the cross-assessment insights were last updated. / lastUpdated?: Timestamp; } export interface InsightsByAssessment { /* * The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling. / noncompliantEvidenceCount?: NullableInteger; /* * The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling. / compliantEvidenceCount?: NullableInteger; /* * The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data. / inconclusiveEvidenceCount?: NullableInteger; /* * The number of assessment controls that collected non-compliant evidence on the lastUpdated date. / assessmentControlsCountByNoncompliantEvidence?: NullableInteger; /* * The total number of controls in the assessment. / totalAssessmentControlsCount?: NullableInteger; /* * The time when the assessment insights were last updated. / lastUpdated?: Timestamp; } export type Integer = number; export type KeywordInputType = "SELECT_FROM_LIST"\|"UPLOAD_FILE"\|"INPUT_TEXT"\|string; export type KeywordValue = string; export type Keywords = KeywordValue[]; export type KmsKey = string; export type LastUpdatedBy = string; export interface ListAssessmentControlInsightsByControlDomainRequest { /* * The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. / controlDomainId: ControlDomainId; /* * The unique identifier for the active assessment. / assessmentId: UUID; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListAssessmentControlInsightsByControlDomainResponse { /* * The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned. / controlInsightsByAssessment?: ControlInsightsMetadataByAssessment; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListAssessmentFrameworkShareRequestsRequest { /* * Specifies whether the share request is a sent request or a received request. / requestType: ShareRequestType; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListAssessmentFrameworkShareRequestsResponse { /* * The list of share requests that the ListAssessmentFrameworkShareRequests API returned. / assessmentFrameworkShareRequests?: AssessmentFrameworkShareRequestList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListAssessmentFrameworksRequest { /* * The type of framework, such as a standard framework or a custom framework. / frameworkType: FrameworkType; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListAssessmentFrameworksResponse { /* * A list of metadata that the ListAssessmentFrameworks API returns for each framework. / frameworkMetadataList?: FrameworkMetadataList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export type ListAssessmentMetadata = AssessmentMetadataItem[]; export interface ListAssessmentReportsRequest { /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListAssessmentReportsResponse { /* * The list of assessment reports that the ListAssessmentReports API returned. / assessmentReports?: AssessmentReportsMetadata; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListAssessmentsRequest { /* * The current status of the assessment. / status?: AssessmentStatus; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListAssessmentsResponse { /* * The metadata that the ListAssessments API returns for each assessment. / assessmentMetadata?: ListAssessmentMetadata; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListControlDomainInsightsByAssessmentRequest { /* * The unique identifier for the active assessment. / assessmentId: UUID; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListControlDomainInsightsByAssessmentResponse { /* * The control domain analytics data that the ListControlDomainInsightsByAssessment API returned. / controlDomainInsights?: ControlDomainInsightsList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListControlDomainInsightsRequest { /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListControlDomainInsightsResponse { /* * The control domain analytics data that the ListControlDomainInsights API returned. / controlDomainInsights?: ControlDomainInsightsList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListControlInsightsByControlDomainRequest { /* * The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. / controlDomainId: ControlDomainId; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListControlInsightsByControlDomainResponse { /* * The control analytics data that the ListControlInsightsByControlDomain API returned. / controlInsightsMetadata?: ControlInsightsMetadata; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListControlsRequest { /* * A filter that narrows the list of controls to a specific type. / controlType: ControlType; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * The maximum number of results on a page or for an API request call. / maxResults?: MaxResults; /* * A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog. To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see ListDomains , ListObjectives , and ListCommonControls . You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the ListControls operation separately for each ARN. Alternatively, specify UNCATEGORIZED to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective. / controlCatalogId?: ControlCatalogId; } export interface ListControlsResponse { /* * A list of metadata that the ListControls API returns for each control. / controlMetadataList?: ControlMetadataList; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListKeywordsForDataSourceRequest { /* * The control mapping data source that the keywords apply to. / source: DataSourceType; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListKeywordsForDataSourceResponse { /* * The list of keywords for the control mapping source. / keywords?: Keywords; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListNotificationsRequest { /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; /* * Represents the maximum number of results on a page or for an API request call. / maxResults?: MaxResults; } export interface ListNotificationsResponse { /* * The returned list of notifications. / notifications?: Notifications; /* * The pagination token that's used to fetch the next set of results. / nextToken?: Token; } export interface ListTagsForResourceRequest { /* * The Amazon Resource Name (ARN) of the resource. / resourceArn: AuditManagerArn; } export interface ListTagsForResourceResponse { /* * The list of tags that the ListTagsForResource API returned. / tags?: TagMap; } export interface ManualEvidence { /* * The S3 URL of the object that's imported as manual evidence. / s3ResourcePath?: S3Url; /* * The plain text response that's entered and saved as manual evidence. / textResponse?: ManualEvidenceTextResponse; /* * The name of the file that's uploaded as manual evidence. This name is populated using the evidenceFileName value from the GetEvidenceFileUploadUrl API response. / evidenceFileName?: ManualEvidenceLocalFileName; } export type ManualEvidenceList = ManualEvidence[]; export type ManualEvidenceLocalFileName = string; export type ManualEvidenceTextResponse = string; export type MaxResults = number; export type NonEmptyString = string; export interface Notification { /* * The unique identifier for the notification. / id?: TimestampUUID; /* * The identifier for the assessment. / assessmentId?: UUID; /* * The name of the related assessment. / assessmentName?: AssessmentName; /* * The identifier for the control set. / controlSetId?: ControlSetId; /* * Specifies the name of the control set that the notification is about. / controlSetName?: NonEmptyString; /* * The description of the notification. / description?: NonEmptyString; /* * The time when the notification was sent. / eventTime?: Timestamp; /* * The sender of the notification. / source?: NonEmptyString; } export type Notifications = Notification[]; export type NullableInteger = number; export type ObjectTypeEnum = "ASSESSMENT"\|"CONTROL_SET"\|"CONTROL"\|"DELEGATION"\|"ASSESSMENT_REPORT"\|string; export type QueryStatement = string; export type Region = string; export interface RegisterAccountRequest { /* * The KMS key details. / kmsKey?: KmsKey; /* * The delegated administrator account for Audit Manager. / delegatedAdminAccount?: AccountId; } export interface RegisterAccountResponse { /* * The status of the account registration request. / status?: AccountStatus; } export interface RegisterOrganizationAdminAccountRequest { /* * The identifier for the delegated administrator account. / adminAccountId: AccountId; } export interface RegisterOrganizationAdminAccountResponse { /* * The identifier for the delegated administrator account. / adminAccountId?: AccountId; /* * The identifier for the organization. / organizationId?: organizationId; } export interface Resource { /* * The Amazon Resource Name (ARN) for the resource. / arn?: GenericArn; /* * The value of the resource. / value?: String; /* * The evaluation status for a resource that was assessed when collecting compliance check evidence. Audit Manager classes the resource as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result. Audit Manager classes the resource as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result. If a compliance check isn't available or applicable, then no compliance evaluation can be made for that resource. This is the case if a resource assessment uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the resource assessment uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). / complianceCheck?: String; } export type Resources = Resource[]; export interface Role { /* * The type of customer persona. In CreateAssessment, roleType can only be PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER. / roleType: RoleType; /* * The Amazon Resource Name (ARN) of the IAM role. / roleArn: IamArn; } export type RoleType = "PROCESS_OWNER"\|"RESOURCE_OWNER"\|string; export type Roles = Role[]; export type S3Url = string; export type SNSTopic = string; export interface Scope { /* * The Amazon Web Services accounts that are included in the scope of the assessment. / awsAccounts?: AWSAccounts; /* * The Amazon Web Services services that are included in the scope of the assessment. This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services, Audit Manager ignores this input. Instead, the value for awsServices will show as empty. / awsServices?: AWSServices; } export interface ServiceMetadata { /* * The name of the Amazon Web Service. / name?: AWSServiceName; /* * The display name of the Amazon Web Service. / displayName?: NonEmptyString; /* * The description of the Amazon Web Service. / description?: NonEmptyString; /* * The category that the Amazon Web Service belongs to, such as compute, storage, or database. / category?: NonEmptyString; } export type ServiceMetadataList = ServiceMetadata[]; export type SettingAttribute = "ALL"\|"IS_AWS_ORG_ENABLED"\|"SNS_TOPIC"\|"DEFAULT_ASSESSMENT_REPORTS_DESTINATION"\|"DEFAULT_PROCESS_OWNERS"\|"EVIDENCE_FINDER_ENABLEMENT"\|"DEREGISTRATION_POLICY"\|"DEFAULT_EXPORT_DESTINATION"\|string; export interface Settings { /* * Specifies whether Organizations is enabled. / isAwsOrgEnabled?: Boolean; /* * The designated Amazon Simple Notification Service (Amazon SNS) topic. / snsTopic?: SNSTopic; /* * The default S3 destination bucket for storing assessment reports. / defaultAssessmentReportsDestination?: AssessmentReportsDestination; /* * The designated default audit owners. / defaultProcessOwners?: Roles; /* * The KMS key details. / kmsKey?: KmsKey; /* * The current evidence finder status and event data store details. / evidenceFinderEnablement?: EvidenceFinderEnablement; /* * The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager. / deregistrationPolicy?: DeregistrationPolicy; /* * The default S3 destination bucket for storing evidence finder exports. / defaultExportDestination?: DefaultExportDestination; } export type ShareRequestAction = "ACCEPT"\|"DECLINE"\|"REVOKE"\|string; export type ShareRequestComment = string; export type ShareRequestStatus = "ACTIVE"\|"REPLICATING"\|"SHARED"\|"EXPIRING"\|"FAILED"\|"EXPIRED"\|"DECLINED"\|"REVOKED"\|string; export type ShareRequestType = "SENT"\|"RECEIVED"\|string; export type SnsArn = string; export type SourceDescription = string; export type SourceFrequency = "DAILY"\|"WEEKLY"\|"MONTHLY"\|string; export interface SourceKeyword { /* * The input method for the keyword. SELECT_FROM_LIST is used when mapping a data source for automated evidence. When keywordInputType is SELECT_FROM_LIST, a keyword must be selected to collect automated evidence. For example, this keyword can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. UPLOAD_FILE and INPUT_TEXT are only used when mapping a data source for manual evidence. When keywordInputType is UPLOAD_FILE, a file must be uploaded as manual evidence. When keywordInputType is INPUT_TEXT, text must be entered as manual evidence. / keywordInputType?: KeywordInputType; /* * The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule: For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name. Keyword example for managed rules: Managed rule name: s3-bucket-acl-prohibited keywordValue: S3_BUCKET_ACL_PROHIBITED For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule. Keyword example for custom rules: Custom rule name: my-custom-config-rule keywordValue: Custom_my-custom-config-rule For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name. Keyword examples for service-linked rules: Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue: Custom_CustomRuleForAccount-conformance-pack Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled The keywordValue is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not successfully collect evidence from that data source as intended. Keep in mind the following requirements, depending on the data source type that you're using. For Config: For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules. For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name. For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls. For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls. For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Service prefix and action names in the Service Authorization Reference. / keywordValue?: KeywordValue; } export type SourceName = string; export type SourceSetUpOption = "System_Controls_Mapping"\|"Procedural_Controls_Mapping"\|string; export type SourceType = "AWS_Cloudtrail"\|"AWS_Config"\|"AWS_Security_Hub"\|"AWS_API_Call"\|"MANUAL"\|"Common_Control"\|"Core_Control"\|string; export interface StartAssessmentFrameworkShareRequest { /* * The unique identifier for the custom framework to be shared. / frameworkId: UUID; /* * The Amazon Web Services account of the recipient. / destinationAccount: AccountId; /* * The Amazon Web Services Region of the recipient. / destinationRegion: Region; /* * An optional comment from the sender about the share request. / comment?: ShareRequestComment; } export interface StartAssessmentFrameworkShareResponse { /* * The share request that's created by the StartAssessmentFrameworkShare API. / assessmentFrameworkShareRequest?: AssessmentFrameworkShareRequest; } export type String = string; export type TagKey = string; export type TagKeyList = TagKey[]; export type TagMap = {[key: string]: TagValue}; export interface TagResourceRequest { /* * The Amazon Resource Name (ARN) of the resource. / resourceArn: AuditManagerArn; /* * The tags that are associated with the resource. / tags: TagMap; } export interface TagResourceResponse { } export type TagValue = string; export type TestingInformation = string; export type Timestamp = Date; export type TimestampUUID = string; export type Token = string; export type TroubleshootingText = string; export interface URL { /* * The name or word that's used as a hyperlink to the URL. / hyperlinkName?: HyperlinkName; /* * The unique identifier for the internet resource. / link?: UrlLink; } export type UUID = string; export interface UntagResourceRequest { /* * The Amazon Resource Name (ARN) of the specified resource. / resourceArn: AuditManagerArn; /* * The name or key of the tag. / tagKeys: TagKeyList; } export interface UntagResourceResponse { } export interface UpdateAssessmentControlRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the control set. / controlSetId: ControlSetId; /* * The unique identifier for the control. / controlId: UUID; /* * The status of the control. / controlStatus?: ControlStatus; /* * The comment body text for the control. / commentBody?: ControlCommentBody; } export interface UpdateAssessmentControlResponse { /* * The name of the updated control set that the UpdateAssessmentControl API returned. / control?: AssessmentControl; } export interface UpdateAssessmentControlSetStatusRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The unique identifier for the control set. / controlSetId: String; /* * The status of the control set that's being updated. / status: ControlSetStatus; /* * The comment that's related to the status update. / comment: DelegationComment; } export interface UpdateAssessmentControlSetStatusResponse { /* * The name of the updated control set that the UpdateAssessmentControlSetStatus API returned. / controlSet?: AssessmentControlSet; } export interface UpdateAssessmentFrameworkControlSet { /* * The unique identifier for the control set. / id?: ControlSetName; /* * The name of the control set. / name: ControlSetName; /* * The list of controls that are contained within the control set. / controls: CreateAssessmentFrameworkControls; } export type UpdateAssessmentFrameworkControlSets = UpdateAssessmentFrameworkControlSet[]; export interface UpdateAssessmentFrameworkRequest { /* * The unique identifier for the framework. / frameworkId: UUID; /* * The name of the framework to be updated. / name: FrameworkName; /* * The description of the updated framework. / description?: FrameworkDescription; /* * The compliance type that the new custom framework supports, such as CIS or HIPAA. / complianceType?: ComplianceType; /* * The control sets that are associated with the framework. / controlSets: UpdateAssessmentFrameworkControlSets; } export interface UpdateAssessmentFrameworkResponse { /* * The name of the framework. / framework?: Framework; } export interface UpdateAssessmentFrameworkShareRequest { /* * The unique identifier for the share request. / requestId: UUID; /* * Specifies whether the share request is a sent request or a received request. / requestType: ShareRequestType; /* * Specifies the update action for the share request. / action: ShareRequestAction; } export interface UpdateAssessmentFrameworkShareResponse { /* * The updated share request that's returned by the UpdateAssessmentFrameworkShare operation. / assessmentFrameworkShareRequest?: AssessmentFrameworkShareRequest; } export interface UpdateAssessmentRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The name of the assessment to be updated. / assessmentName?: AssessmentName; /* * The description of the assessment. / assessmentDescription?: AssessmentDescription; /* * The scope of the assessment. / scope: Scope; /* * The assessment report storage destination for the assessment that's being updated. / assessmentReportsDestination?: AssessmentReportsDestination; /* * The list of roles for the assessment. / roles?: Roles; } export interface UpdateAssessmentResponse { /* * The response object for the UpdateAssessment API. This is the name of the updated assessment. / assessment?: Assessment; } export interface UpdateAssessmentStatusRequest { /* * The unique identifier for the assessment. / assessmentId: UUID; /* * The current status of the assessment. / status: AssessmentStatus; } export interface UpdateAssessmentStatusResponse { /* * The name of the updated assessment that the UpdateAssessmentStatus API returned. / assessment?: Assessment; } export interface UpdateControlRequest { /* * The identifier for the control. / controlId: UUID; /* * The name of the updated control. / name: ControlName; /* * The optional description of the control. / description?: ControlDescription; /* * The steps that you should follow to determine if the control is met. / testingInformation?: TestingInformation; /* * The title of the action plan for remediating the control. / actionPlanTitle?: ActionPlanTitle; /* * The recommended actions to carry out if the control isn't fulfilled. / actionPlanInstructions?: ActionPlanInstructions; /* * The data mapping sources for the control. / controlMappingSources: ControlMappingSources; } export interface UpdateControlResponse { /* * The name of the updated control set that the UpdateControl API returned. / control?: Control; } export interface UpdateSettingsRequest { /* * The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to. / snsTopic?: SnsArn; /* * The default S3 destination bucket for storing assessment reports. / defaultAssessmentReportsDestination?: AssessmentReportsDestination; /* * A list of the default audit owners. / defaultProcessOwners?: Roles; /* * The KMS key details. / kmsKey?: KmsKey; /* * Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder. When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager. / evidenceFinderEnabled?: Boolean; /* * The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager. / deregistrationPolicy?: DeregistrationPolicy; /* * The default S3 destination bucket for storing evidence finder exports. / defaultExportDestination?: DefaultExportDestination; } export interface UpdateSettingsResponse { /* * The current list of settings. / settings?: Settings; } export type UrlLink = string; export type Username = string; export interface ValidateAssessmentReportIntegrityRequest { /* * The relative path of the Amazon S3 bucket that the assessment report is stored in. / s3RelativePath: S3Url; } export interface ValidateAssessmentReportIntegrityResponse { /* * Specifies whether the signature key is valid. / signatureValid?: Boolean; /* * The signature algorithm that's used to code sign the assessment report file. / signatureAlgorithm?: String; /* * The date and time signature that specifies when the assessment report was created. / signatureDateTime?: String; /* * The unique identifier for the validation signature key. / signatureKeyId?: String; /* * Represents any errors that occurred when validating the assessment report. / validationErrors?: ValidationErrors; } export type ValidationErrors = NonEmptyString[]; export type organizationId = string; /* * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. / export type apiVersion = "2017-07-25"\|"latest"\|string; export interface ClientApiVersions { /* * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. / apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /* * Contains interfaces for use with the AuditManager client. */ export import Types = AuditManager; } export = AuditManager;