Skip to content

update_reveal_configuration async

update_reveal_configuration(
    *,
    config_overrides: Optional[AsyncMacie2ClientConfig] = None,
    configuration: Optional[RevealConfiguration] = None,
    retrieval_configuration: Optional[UpdateRetrievalConfiguration] = None,
) -> UpdateRevealConfigurationResponse

Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

Parameters:

  • configuration (Optional[RevealConfiguration], default: None ) –

    The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.

  • retrieval_configuration (Optional[UpdateRetrievalConfiguration], default: None ) –

    The access method and settings to use when retrieving the sensitive data.

Raises:

  • AccessDeniedException –

    Provides information about an error that occurred due to insufficient access to a specified resource.

  • InternalServerException –

    Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

  • ThrottlingException –

    Provides information about an error that occurred because too many requests were sent during a certain amount of time.

  • ValidationException –

    Provides information about an error that occurred due to a syntax error in a request.

  • UnknownServiceError –

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

Source code in docs_src/capo_macie2/_services/async_macie2.py
async def update_reveal_configuration(
    self,
    *,
    config_overrides: Optional[AsyncMacie2ClientConfig] = None,
    configuration: Optional[
        "capo_macie2.types.reveal_configuration.RevealConfiguration"
    ] = None,
    retrieval_configuration: Optional[
        "capo_macie2.types.update_retrieval_configuration.UpdateRetrievalConfiguration"
    ] = None,
) -> "capo_macie2.types.update_reveal_configuration_response.UpdateRevealConfigurationResponse":
    """<p>Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.</p>

    Args:
        configuration: <p>The KMS key to use to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.</p>
        retrieval_configuration: <p>The access method and settings to use when retrieving the sensitive data.</p>

    Raises:
        capo_macie2.errors.access_denied_exception.AccessDeniedException: <p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>
        capo_macie2.errors.internal_server_exception.InternalServerException: <p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>
        capo_macie2.errors.throttling_exception.ThrottlingException: <p>Provides information about an error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_macie2.errors.validation_exception.ValidationException: <p>Provides information about an error that occurred due to a syntax error in a request.</p>
        capo_macie2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_macie2.types.update_reveal_configuration_request.UpdateRevealConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_macie2.types.update_reveal_configuration_response.UpdateRevealConfigurationResponse"
    ]:
        import capo_macie2._operations.macie2.update_reveal_configuration

        (
            output,
            http_response,
        ) = await capo_macie2._operations.macie2.update_reveal_configuration.async_update_reveal_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRevealConfiguration")
    )
    input_: capo_macie2.types.update_reveal_configuration_request.UpdateRevealConfigurationRequest = {}
    if configuration is not None:
        input_["configuration"] = configuration
    if retrieval_configuration is not None:
        input_["retrieval_configuration"] = retrieval_configuration

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