Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SetDefaultMessageType

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 AWS account.

Request Syntax


{
   "ConfigurationSetName": "string",
   "MessageType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConfigurationSetName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

MessageType

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.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

Required: Yes

Response Syntax


{
   "ConfigurationSetArn": "string",
   "ConfigurationSetName": "string",
   "MessageType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfigurationSetArn

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

Type: String

ConfigurationSetName

The name of the configuration set that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

MessageType

The new default message type of the configuration set.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400