SetDefaultSenderId
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.
Request Syntax
{
"ConfigurationSetName": "string",
"SenderId": "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 updated with a new default SenderId. 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
- SenderId
-
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'.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 11.
Pattern:
[A-Za-z0-9_-]+Required: Yes
Response Syntax
{
"ConfigurationSetArn": "string",
"ConfigurationSetName": "string",
"SenderId": "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_-]+ - SenderId
-
The default sender ID to set for the ConfigurationSet.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 11.
Pattern:
[A-Za-z0-9_-]+
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
