Skip to content

update_settings async

update_settings(
    *,
    config_overrides: Optional[AsyncAuditManagerClientConfig] = None,
    sns_topic: Optional[SnsArn] = None,
    default_assessment_reports_destination: Optional[
        AssessmentReportsDestination
    ] = None,
    default_process_owners: Optional[Roles] = None,
    kms_key: Optional[KmsKey] = None,
    evidence_finder_enabled: Optional[Boolean] = None,
    deregistration_policy: Optional[DeregistrationPolicy] = None,
    default_export_destination: Optional[DefaultExportDestination] = None,
) -> UpdateSettingsResponse

Updates Audit Manager settings for the current account.

Parameters:

  • sns_topic (Optional[SnsArn], default: None ) –

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

  • default_assessment_reports_destination (Optional[AssessmentReportsDestination], default: None ) –

    The default S3 destination bucket for storing assessment reports.

  • default_process_owners (Optional[Roles], default: None ) –

    A list of the default audit owners.

  • kms_key (Optional[KmsKey], default: None ) –

    The KMS key details.

  • evidence_finder_enabled (Optional[Boolean], default: None ) –

    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.

  • deregistration_policy (Optional[DeregistrationPolicy], default: None ) –

    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.

  • default_export_destination (Optional[DefaultExportDestination], default: None ) –

    The default S3 destination bucket for storing evidence finder exports.

Raises:

  • AccessDeniedException –

    Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

  • InternalServerException –

    An internal service error occurred during the processing of your request. Try again later.

  • ValidationException –

    The request has invalid or missing parameters.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_auditmanager/_services/async_audit_manager.py
async def update_settings(
    self,
    *,
    config_overrides: Optional[AsyncAuditManagerClientConfig] = None,
    sns_topic: Optional["capo_auditmanager.types.sns_arn.SnsArn"] = None,
    default_assessment_reports_destination: Optional[
        "capo_auditmanager.types.assessment_reports_destination.AssessmentReportsDestination"
    ] = None,
    default_process_owners: Optional["capo_auditmanager.types.roles.Roles"] = None,
    kms_key: Optional["capo_auditmanager.types.kms_key.KmsKey"] = None,
    evidence_finder_enabled: Optional[
        "capo_auditmanager.types.boolean.Boolean"
    ] = None,
    deregistration_policy: Optional[
        "capo_auditmanager.types.deregistration_policy.DeregistrationPolicy"
    ] = None,
    default_export_destination: Optional[
        "capo_auditmanager.types.default_export_destination.DefaultExportDestination"
    ] = None,
) -> "capo_auditmanager.types.update_settings_response.UpdateSettingsResponse":
    """<p> Updates Audit Manager settings for the current account. </p>

    Args:
        sns_topic: <p> The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to. </p>
        default_assessment_reports_destination: <p> The default S3 destination bucket for storing assessment reports. </p>
        default_process_owners: <p> A list of the default audit owners. </p>
        kms_key: <p> The KMS key details. </p>
        evidence_finder_enabled: <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: <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: <p> The default S3 destination bucket for storing evidence finder exports. </p>

    Raises:
        capo_auditmanager.errors.access_denied_exception.AccessDeniedException: <p> Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. </p>
        capo_auditmanager.errors.internal_server_exception.InternalServerException: <p> An internal service error occurred during the processing of your request. Try again later. </p>
        capo_auditmanager.errors.validation_exception.ValidationException: <p> The request has invalid or missing parameters. </p>
        capo_auditmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_auditmanager.types.update_settings_request.UpdateSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_auditmanager.types.update_settings_response.UpdateSettingsResponse"
    ]:
        import capo_auditmanager._operations.bedrock_assessment_manager_lambda.update_settings

        (
            output,
            http_response,
        ) = await capo_auditmanager._operations.bedrock_assessment_manager_lambda.update_settings.async_update_settings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_auditmanager.types.update_settings_request.UpdateSettingsRequest",
    ) -> dict[str, Any]:
        import capo_auditmanager.types.update_settings_request

        return capo_auditmanager.types.update_settings_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_auditmanager.types.update_settings_response.UpdateSettingsResponse",
    ) -> dict[str, Any]:
        import capo_auditmanager.types.update_settings_response

        return capo_auditmanager.types.update_settings_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateSettings",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_auditmanager.types.update_settings_request.UpdateSettingsRequest = {}
    if sns_topic is not None:
        input_["sns_topic"] = sns_topic
    if default_assessment_reports_destination is not None:
        input_["default_assessment_reports_destination"] = (
            default_assessment_reports_destination
        )
    if default_process_owners is not None:
        input_["default_process_owners"] = default_process_owners
    if kms_key is not None:
        input_["kms_key"] = kms_key
    if evidence_finder_enabled is not None:
        input_["evidence_finder_enabled"] = evidence_finder_enabled
    if deregistration_policy is not None:
        input_["deregistration_policy"] = deregistration_policy
    if default_export_destination is not None:
        input_["default_export_destination"] = default_export_destination

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output