Skip to content

update_protect_configuration

update_protect_configuration(
    protect_configuration_id: ProtectConfigurationIdOrArn,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    deletion_protection_enabled: Optional[bool] = None,
) -> UpdateProtectConfigurationResult

Update the setting for an existing protect configuration.

Parameters:

  • protect_configuration_id (ProtectConfigurationIdOrArn) –

    The unique identifier for the protect configuration.

  • deletion_protection_enabled (Optional[bool], default: None ) –

    When set to true deletion protection is enabled. By default this is set to false.

Raises:

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
def update_protect_configuration(
    self,
    protect_configuration_id: "capo_pinpoint_sms_voice_v2.types.protect_configuration_id_or_arn.ProtectConfigurationIdOrArn",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    deletion_protection_enabled: Optional[bool] = None,
) -> "capo_pinpoint_sms_voice_v2.types.update_protect_configuration_result.UpdateProtectConfigurationResult":
    """<p>Update the setting for an existing protect configuration.</p>

    Args:
        protect_configuration_id: <p>The unique identifier for the protect configuration.</p>
        deletion_protection_enabled: <p>When set to true deletion protection is enabled. By default this is set to false. </p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.update_protect_configuration_request.UpdateProtectConfigurationRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.update_protect_configuration_result.UpdateProtectConfigurationResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.update_protect_configuration

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.update_protect_configuration.update_protect_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateProtectConfiguration")
    )
    input_: capo_pinpoint_sms_voice_v2.types.update_protect_configuration_request.UpdateProtectConfigurationRequest = {
        "protect_configuration_id": protect_configuration_id
    }
    if deletion_protection_enabled is not None:
        input_["deletion_protection_enabled"] = deletion_protection_enabled

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output