PinpointSMSVoiceV2 / Client / set_default_message_type

set_default_message_type#

PinpointSMSVoiceV2.Client.set_default_message_type(**kwargs)#

Sets the default message type on a configuration set.

Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.set_default_message_type(
    ConfigurationSetName='string',
    MessageType='TRANSACTIONAL'|'PROMOTIONAL'
)
Parameters:
  • ConfigurationSetName (string) –

    [REQUIRED]

    The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • MessageType (string) –

    [REQUIRED]

    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationSetArn': 'string',
    'ConfigurationSetName': 'string',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL'
}

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.

    • MessageType (string) –

      The new default message type of the configuration set.

Exceptions

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException