PinpointSMSVoiceV2 / Client / delete_default_sender_id

delete_default_sender_id#

PinpointSMSVoiceV2.Client.delete_default_sender_id(**kwargs)#

Deletes an existing default sender ID on a configuration set.

A default sender ID is the identity that appears on recipients’ devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

Request Syntax

response = client.delete_default_sender_id(
    ConfigurationSetName='string'
)

Parameters:

ConfigurationSetName (string) –

[REQUIRED]

The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- ConfigurationSetArn (string) –
  
  The Amazon Resource Name (ARN) of the configuration set.
- ConfigurationSetName (string) –
  
  The name of the configuration set.
- SenderId (string) –
  
  The current sender ID for the configuration set.

Exceptions

PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException