Skip to content

update_sender_id

update_sender_id(
    sender_id: SenderIdOrArn,
    iso_country_code: IsoCountryCode,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    deletion_protection_enabled: Optional[bool] = None,
) -> UpdateSenderIdResult

Updates the configuration of an existing sender ID.

Parameters:

  • sender_id (SenderIdOrArn) –

    The sender ID to update.

  • iso_country_code (IsoCountryCode) –

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

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

    By default this is set to false. When set to true the sender ID can't be deleted.

Raises:

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
def update_sender_id(
    self,
    sender_id: "capo_pinpoint_sms_voice_v2.types.sender_id_or_arn.SenderIdOrArn",
    iso_country_code: "capo_pinpoint_sms_voice_v2.types.iso_country_code.IsoCountryCode",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    deletion_protection_enabled: Optional[bool] = None,
) -> (
    "capo_pinpoint_sms_voice_v2.types.update_sender_id_result.UpdateSenderIdResult"
):
    """<p>Updates the configuration of an existing sender ID.</p>

    Args:
        sender_id: <p>The sender ID to update.</p>
        iso_country_code: <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
        deletion_protection_enabled: <p>By default this is set to false. When set to true the sender ID can't be deleted.</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_sender_id_request.UpdateSenderIdRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.update_sender_id_result.UpdateSenderIdResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.update_sender_id

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSenderId")
    )
    input_: capo_pinpoint_sms_voice_v2.types.update_sender_id_request.UpdateSenderIdRequest = {
        "sender_id": sender_id,
        "iso_country_code": iso_country_code,
    }
    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