---
title: "PUT /settings"
method: PUT
path: "/settings"
---

# PUT /settings

`PUT /settings`

Updates Audit Manager settings for the current account.

## Request body

- object
  - `snsTopic` string — The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.
  - `defaultAssessmentReportsDestination` object — The location where Audit Manager saves assessment reports for the given assessment.
    - `destinationType` 'S3' — The destination type, such as Amazon S3.
    - `destination` string — The destination of the assessment report.
  - `defaultProcessOwners` Role[] — A list of the default audit owners.
    - `roleType` 'PROCESS_OWNER' | 'RESOURCE_OWNER', required — <p> The type of customer persona. </p> <note> <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>. </p> <p>In <code>UpdateSettings</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>.</p> <p>In <code>BatchCreateDelegationByAssessment</code>, <code>roleType</code> can only be <code>RESOURCE_OWNER</code>.</p> </note>
    - `roleArn` string, required — The Amazon Resource Name (ARN) of the IAM role.
  - `kmsKey` string — The KMS key details.
  - `evidenceFinderEnabled` boolean — <p>Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.</p> <important> <p>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 <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html">deregister</a> and then <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html">re-register</a> Audit Manager. </p> </important>
  - `deregistrationPolicy` object — <p>The deregistration policy for the data that's stored in Audit Manager. You can use this attribute to determine how your data is handled when you <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html">deregister Audit Manager</a>.</p> <p>By default, Audit Manager retains evidence data for two years from the time of its creation. Other Audit Manager resources (including assessments, custom controls, and custom frameworks) remain in Audit Manager indefinitely, and are available if you <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html">re-register Audit Manager</a> in the future. For more information about data retention, see <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html">Data Protection</a> in the <i>Audit Manager User Guide</i>.</p> <important> <p>If you choose to delete all data, this action permanently deletes all evidence data in your account within seven days. It also deletes all of the Audit Manager resources that you created, including assessments, custom controls, and custom frameworks. Your data will not be available if you re-register Audit Manager in the future.</p> </important>
    - `deleteResources` 'ALL' | 'DEFAULT' — <p>Specifies which Audit Manager data will be deleted when you deregister Audit Manager.</p> <ul> <li> <p>If you set the value to <code>ALL</code>, all of your data is deleted within seven days of deregistration.</p> </li> <li> <p>If you set the value to <code>DEFAULT</code>, 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.</p> </li> </ul>

## Response `200`

Success

- UpdateSettingsResponse
  - `settings` object — The current list of settings.
    - `isAwsOrgEnabled` boolean — Specifies whether Organizations is enabled.
    - `snsTopic` string — The designated Amazon Simple Notification Service (Amazon SNS) topic.
    - `defaultAssessmentReportsDestination` object — The default storage destination for assessment reports.
      - `destinationType` 'S3' — The destination type, such as Amazon S3.
      - `destination` string — The destination of the assessment report.
    - `defaultProcessOwners` Role[] — The designated default audit owners.
      - `roleType` 'PROCESS_OWNER' | 'RESOURCE_OWNER', required — <p> The type of customer persona. </p> <note> <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>. </p> <p>In <code>UpdateSettings</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>.</p> <p>In <code>BatchCreateDelegationByAssessment</code>, <code>roleType</code> can only be <code>RESOURCE_OWNER</code>.</p> </note>
      - `roleArn` string, required — The Amazon Resource Name (ARN) of the IAM role.
    - `kmsKey` string — The KMS key details.
    - `evidenceFinderEnablement` object — The current evidence finder status and event data store details.
      - `eventDataStoreArn` string — 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.
      - `enablementStatus` 'ENABLED' | 'DISABLED' | 'ENABLE_IN_PROGRESS' | 'DISABLE_IN_PROGRESS' — <p>The current status of the evidence finder feature and the related event data store. </p> <ul> <li> <p> <code>ENABLE_IN_PROGRESS</code> means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.</p> </li> <li> <p> <code>ENABLED</code> 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.</p> </li> <li> <p> <code>DISABLE_IN_PROGRESS</code> means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.</p> </li> <li> <p> <code>DISABLED</code> 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.</p> </li> </ul>
      - `backfillStatus` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' — <p>The current status of the evidence data backfill process. </p> <p>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.</p> <ul> <li> <p> <code>NOT_STARTED</code> means that the backfill hasn’t started yet. </p> </li> <li> <p> <code>IN_PROGRESS</code> means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data. </p> </li> <li> <p> <code>COMPLETED</code> means that the backfill is complete. All of your past evidence is now queryable. </p> </li> </ul>
      - `error` string — Represents any errors that occurred when enabling or disabling evidence finder.
    - `deregistrationPolicy` object — 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.
      - `deleteResources` 'ALL' | 'DEFAULT' — <p>Specifies which Audit Manager data will be deleted when you deregister Audit Manager.</p> <ul> <li> <p>If you set the value to <code>ALL</code>, all of your data is deleted within seven days of deregistration.</p> </li> <li> <p>If you set the value to <code>DEFAULT</code>, 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.</p> </li> </ul>

## Other responses

- `480` — ValidationException
- `481` — AccessDeniedException
- `482` — InternalServerException

---

[API](https://skmtc.net/aws/apis/auditmanager.md) · [All operations](https://skmtc.net/aws/apis/auditmanager/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/auditmanager/versions/27a1388d0f2a/schema)