Skip to content

UpdateSettingsRequest

Source code in docs_src/capo_auditmanager/types/update_settings_request.py
class UpdateSettingsRequest(TypedDict, closed=True):
    sns_topic: NotRequired["capo_auditmanager.types.sns_arn.SnsArn"]
    """<p> The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to. </p>"""
    default_assessment_reports_destination: NotRequired[
        "capo_auditmanager.types.assessment_reports_destination.AssessmentReportsDestination"
    ]
    """<p> The default S3 destination bucket for storing assessment reports. </p>"""
    default_process_owners: NotRequired["capo_auditmanager.types.roles.Roles"]
    """<p> A list of the default audit owners. </p>"""
    kms_key: NotRequired["capo_auditmanager.types.kms_key.KmsKey"]
    """<p> The KMS key details. </p>"""
    evidence_finder_enabled: NotRequired["capo_auditmanager.types.boolean.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>"""
    deregistration_policy: NotRequired[
        "capo_auditmanager.types.deregistration_policy.DeregistrationPolicy"
    ]
    """<p>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.</p>"""
    default_export_destination: NotRequired[
        "capo_auditmanager.types.default_export_destination.DefaultExportDestination"
    ]
    """<p> The default S3 destination bucket for storing evidence finder exports. </p>"""

default_assessment_reports_destination instance-attribute

default_assessment_reports_destination: NotRequired[AssessmentReportsDestination]

The default S3 destination bucket for storing assessment reports.

default_export_destination instance-attribute

default_export_destination: NotRequired[DefaultExportDestination]

The default S3 destination bucket for storing evidence finder exports.

default_process_owners instance-attribute

default_process_owners: NotRequired[Roles]

A list of the default audit owners.

deregistration_policy instance-attribute

deregistration_policy: NotRequired[DeregistrationPolicy]

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.

evidence_finder_enabled instance-attribute

evidence_finder_enabled: NotRequired[Boolean]

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.

kms_key instance-attribute

kms_key: NotRequired[KmsKey]

The KMS key details.

sns_topic instance-attribute

sns_topic: NotRequired[SnsArn]

The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.