PinpointSMSVoiceV2 / Client / set_default_sender_id

set_default_sender_id#

PinpointSMSVoiceV2.Client.set_default_sender_id(**kwargs)#

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

See also: AWS API Documentation

Request Syntax

response = client.set_default_sender_id(
    ConfigurationSetName='string',
    SenderId='string'
)
Parameters:

  • ConfigurationSetName (string) –

    [REQUIRED]

    The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • SenderId (string) –

    [REQUIRED]

    The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as ‘NOTICE’.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'SenderId': 'string'
}

Response Structure

  • (dict) –

    • ConfigurationSetArn (string) –

      The Amazon Resource Name (ARN) of the updated configuration set.

    • ConfigurationSetName (string) –

      The name of the configuration set that was updated.

    • SenderId (string) –

      The default sender ID to set for the ConfigurationSet.

Exceptions

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException