Skip to content

Commit

Permalink
docs(client-auditmanager): This release adds documentation updates fo…
Browse files Browse the repository at this point in the history 
…r Audit Manager. The updates provide data deletion guidance when a customer deregisters Audit Manager or deregisters a delegated administrator.
  • Loading branch information
awstools committed Mar 31, 2022
1 parent f7d75a0 commit ddca6cf
Show file tree
Hide file tree
Showing 4 changed files with 8,131 additions and 7,973 deletions.
85 changes: 82 additions & 3 deletions clients/client-auditmanager/src/AuditManager.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -822,6 +822,45 @@ export class AuditManager extends AuditManagerClient {

/**
* <p> Deregisters an account in Audit Manager. </p>
* <note>
* <p>When you deregister your account from Audit Manager, your data isn’t deleted. If you want
* to delete your resource data, you must perform that task separately before you
* deregister your 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. </p>
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html">DeleteAssessment</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html">Deleting an
* assessment</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html">DeleteAssessmentFramework</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html">Deleting a
* custom framework</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html">DeleteAssessmentFrameworkShare</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html">Deleting a share request</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html">DeleteAssessmentReport</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps">Deleting an assessment report</a> in the <i>Audit Manager
* User Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html">DeleteControl</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html">Deleting a custom
* control</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* </ul>
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
* available delete operations are listed above.</p>
* </note>
*/
public deregisterAccount(
args: DeregisterAccountCommandInput,
Expand Down Expand Up @@ -853,15 +892,55 @@ export class AuditManager extends AuditManagerClient {
}

/**
* <p>Removes the specified member Amazon Web Services account as a delegated administrator for
* Audit Manager. </p>
* <p>Removes the specified Amazon Web Services account as a delegated administrator for
* Audit Manager. </p>
* <important>
* <p>When you remove a delegated administrator from your Audit Manager settings, you
* continue to have access to the evidence that you previously collected under that
* account. This is also the case when you deregister a delegated administrator from
* Audit Manager. However, Audit Manager will stop collecting and attaching
* Organizations. However, Audit Manager will stop collecting and attaching
* evidence to that delegated administrator account moving forward.</p>
* </important>
* <note>
* <p>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. </p>
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html">DeleteAssessment</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html">Deleting an
* assessment</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html">DeleteAssessmentFramework</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html">Deleting a
* custom framework</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html">DeleteAssessmentFrameworkShare</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html">Deleting a share request</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html">DeleteAssessmentReport</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps">Deleting an assessment report</a> in the <i>Audit Manager
* User Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html">DeleteControl</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html">Deleting a custom
* control</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* </ul>
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
* available delete operations are listed above.</p>
* </note>
*/
public deregisterOrganizationAdminAccount(
args: DeregisterOrganizationAdminAccountCommandInput,
Expand Down
39 changes: 39 additions & 0 deletions clients/client-auditmanager/src/commands/DeregisterAccountCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,45 @@ export interface DeregisterAccountCommandOutput extends DeregisterAccountRespons

/**
* <p> Deregisters an account in Audit Manager. </p>
* <note>
* <p>When you deregister your account from Audit Manager, your data isn’t deleted. If you want
* to delete your resource data, you must perform that task separately before you
* deregister your 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. </p>
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html">DeleteAssessment</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html">Deleting an
* assessment</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html">DeleteAssessmentFramework</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html">Deleting a
* custom framework</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html">DeleteAssessmentFrameworkShare</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html">Deleting a share request</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html">DeleteAssessmentReport</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps">Deleting an assessment report</a> in the <i>Audit Manager
* User Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html">DeleteControl</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html">Deleting a custom
* control</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* </ul>
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
* available delete operations are listed above.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
46 changes: 43 additions & 3 deletions clients/client-auditmanager/src/commands/DeregisterOrganizationAdminAccountCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,55 @@ export interface DeregisterOrganizationAdminAccountCommandOutput
__MetadataBearer {}

/**
* <p>Removes the specified member Amazon Web Services account as a delegated administrator for
* Audit Manager. </p>
* <p>Removes the specified Amazon Web Services account as a delegated administrator for
* Audit Manager. </p>
* <important>
* <p>When you remove a delegated administrator from your Audit Manager settings, you
* continue to have access to the evidence that you previously collected under that
* account. This is also the case when you deregister a delegated administrator from
* Audit Manager. However, Audit Manager will stop collecting and attaching
* Organizations. However, Audit Manager will stop collecting and attaching
* evidence to that delegated administrator account moving forward.</p>
* </important>
* <note>
* <p>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. </p>
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html">DeleteAssessment</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html">Deleting an
* assessment</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html">DeleteAssessmentFramework</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html">Deleting a
* custom framework</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html">DeleteAssessmentFrameworkShare</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html">Deleting a share request</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html">DeleteAssessmentReport</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps">Deleting an assessment report</a> in the <i>Audit Manager
* User Guide</i>)</p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html">DeleteControl</a> (see also: <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html">Deleting a custom
* control</a> in the <i>Audit Manager User
* Guide</i>)</p>
* </li>
* </ul>
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
* available delete operations are listed above.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down

0 comments on commit ddca6cf

Please sign in to comment.