Skip to content

Commit ddca6cf

Browse files
author
awstools
committed
docs(client-auditmanager): This release adds documentation updates for Audit Manager. The updates provide data deletion guidance when a customer deregisters Audit Manager or deregisters a delegated administrator.
1 parent f7d75a0 commit ddca6cf

File tree

4 files changed

+8131
-7973
lines changed

4 files changed

+8131
-7973
lines changed

‎clients/client-auditmanager/src/AuditManager.ts‎

Lines changed: 82 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,45 @@ export class AuditManager extends AuditManagerClient {
822822

823823
/**
824824
* <p> Deregisters an account in Audit Manager. </p>
825+
* <note>
826+
* <p>When you deregister your account from Audit Manager, your data isn’t deleted. If you want
827+
* to delete your resource data, you must perform that task separately before you
828+
* deregister your account. Either, you can do this in the Audit Manager console. Or,
829+
* you can use one of the delete API operations that are provided by Audit Manager. </p>
830+
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
831+
* <ul>
832+
* <li>
833+
* <p>
834+
* <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
835+
* assessment</a> in the <i>Audit Manager User
836+
* Guide</i>)</p>
837+
* </li>
838+
* <li>
839+
* <p>
840+
* <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
841+
* custom framework</a> in the <i>Audit Manager User
842+
* Guide</i>)</p>
843+
* </li>
844+
* <li>
845+
* <p>
846+
* <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
847+
* Guide</i>)</p>
848+
* </li>
849+
* <li>
850+
* <p>
851+
* <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
852+
* User Guide</i>)</p>
853+
* </li>
854+
* <li>
855+
* <p>
856+
* <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
857+
* control</a> in the <i>Audit Manager User
858+
* Guide</i>)</p>
859+
* </li>
860+
* </ul>
861+
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
862+
* available delete operations are listed above.</p>
863+
* </note>
825864
*/
826865
public deregisterAccount(
827866
args: DeregisterAccountCommandInput,
@@ -853,15 +892,55 @@ export class AuditManager extends AuditManagerClient {
853892
}
854893

855894
/**
856-
* <p>Removes the specified member Amazon Web Services account as a delegated administrator for
857-
* Audit Manager. </p>
895+
* <p>Removes the specified Amazon Web Services account as a delegated administrator for
896+
* Audit Manager. </p>
858897
* <important>
859898
* <p>When you remove a delegated administrator from your Audit Manager settings, you
860899
* continue to have access to the evidence that you previously collected under that
861900
* account. This is also the case when you deregister a delegated administrator from
862-
* Audit Manager. However, Audit Manager will stop collecting and attaching
901+
* Organizations. However, Audit Manager will stop collecting and attaching
863902
* evidence to that delegated administrator account moving forward.</p>
864903
* </important>
904+
* <note>
905+
* <p>When you deregister a delegated administrator account for Audit Manager, the data for that
906+
* account isn’t deleted. If you want to delete resource data for a delegated administrator
907+
* account, you must perform that task separately before you deregister the account.
908+
* Either, you can do this in the Audit Manager console. Or, you can use one of the
909+
* delete API operations that are provided by Audit Manager. </p>
910+
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
911+
* <ul>
912+
* <li>
913+
* <p>
914+
* <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
915+
* assessment</a> in the <i>Audit Manager User
916+
* Guide</i>)</p>
917+
* </li>
918+
* <li>
919+
* <p>
920+
* <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
921+
* custom framework</a> in the <i>Audit Manager User
922+
* Guide</i>)</p>
923+
* </li>
924+
* <li>
925+
* <p>
926+
* <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
927+
* Guide</i>)</p>
928+
* </li>
929+
* <li>
930+
* <p>
931+
* <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
932+
* User Guide</i>)</p>
933+
* </li>
934+
* <li>
935+
* <p>
936+
* <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
937+
* control</a> in the <i>Audit Manager User
938+
* Guide</i>)</p>
939+
* </li>
940+
* </ul>
941+
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
942+
* available delete operations are listed above.</p>
943+
* </note>
865944
*/
866945
public deregisterOrganizationAdminAccount(
867946
args: DeregisterOrganizationAdminAccountCommandInput,

‎clients/client-auditmanager/src/commands/DeregisterAccountCommand.ts‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,45 @@ export interface DeregisterAccountCommandOutput extends DeregisterAccountRespons
2323

2424
/**
2525
* <p> Deregisters an account in Audit Manager. </p>
26+
* <note>
27+
* <p>When you deregister your account from Audit Manager, your data isn’t deleted. If you want
28+
* to delete your resource data, you must perform that task separately before you
29+
* deregister your account. Either, you can do this in the Audit Manager console. Or,
30+
* you can use one of the delete API operations that are provided by Audit Manager. </p>
31+
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
32+
* <ul>
33+
* <li>
34+
* <p>
35+
* <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
36+
* assessment</a> in the <i>Audit Manager User
37+
* Guide</i>)</p>
38+
* </li>
39+
* <li>
40+
* <p>
41+
* <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
42+
* custom framework</a> in the <i>Audit Manager User
43+
* Guide</i>)</p>
44+
* </li>
45+
* <li>
46+
* <p>
47+
* <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
48+
* Guide</i>)</p>
49+
* </li>
50+
* <li>
51+
* <p>
52+
* <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
53+
* User Guide</i>)</p>
54+
* </li>
55+
* <li>
56+
* <p>
57+
* <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
58+
* control</a> in the <i>Audit Manager User
59+
* Guide</i>)</p>
60+
* </li>
61+
* </ul>
62+
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
63+
* available delete operations are listed above.</p>
64+
* </note>
2665
* @example
2766
* Use a bare-bones client and the command you need to make an API call.
2867
* ```javascript

‎clients/client-auditmanager/src/commands/DeregisterOrganizationAdminAccountCommand.ts‎

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,55 @@ export interface DeregisterOrganizationAdminAccountCommandOutput
2727
__MetadataBearer {}
2828

2929
/**
30-
* <p>Removes the specified member Amazon Web Services account as a delegated administrator for
31-
* Audit Manager. </p>
30+
* <p>Removes the specified Amazon Web Services account as a delegated administrator for
31+
* Audit Manager. </p>
3232
* <important>
3333
* <p>When you remove a delegated administrator from your Audit Manager settings, you
3434
* continue to have access to the evidence that you previously collected under that
3535
* account. This is also the case when you deregister a delegated administrator from
36-
* Audit Manager. However, Audit Manager will stop collecting and attaching
36+
* Organizations. However, Audit Manager will stop collecting and attaching
3737
* evidence to that delegated administrator account moving forward.</p>
3838
* </important>
39+
* <note>
40+
* <p>When you deregister a delegated administrator account for Audit Manager, the data for that
41+
* account isn’t deleted. If you want to delete resource data for a delegated administrator
42+
* account, you must perform that task separately before you deregister the account.
43+
* Either, you can do this in the Audit Manager console. Or, you can use one of the
44+
* delete API operations that are provided by Audit Manager. </p>
45+
* <p>To delete your Audit Manager resource data, see the following instructions: </p>
46+
* <ul>
47+
* <li>
48+
* <p>
49+
* <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
50+
* assessment</a> in the <i>Audit Manager User
51+
* Guide</i>)</p>
52+
* </li>
53+
* <li>
54+
* <p>
55+
* <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
56+
* custom framework</a> in the <i>Audit Manager User
57+
* Guide</i>)</p>
58+
* </li>
59+
* <li>
60+
* <p>
61+
* <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
62+
* Guide</i>)</p>
63+
* </li>
64+
* <li>
65+
* <p>
66+
* <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
67+
* User Guide</i>)</p>
68+
* </li>
69+
* <li>
70+
* <p>
71+
* <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
72+
* control</a> in the <i>Audit Manager User
73+
* Guide</i>)</p>
74+
* </li>
75+
* </ul>
76+
* <p>At this time, Audit Manager doesn't provide an option to delete evidence. All
77+
* available delete operations are listed above.</p>
78+
* </note>
3979
* @example
4080
* Use a bare-bones client and the command you need to make an API call.
4181
* ```javascript

0 commit comments

Comments
 (0)