UpdateSenderId
Updates the configuration of an existing sender ID.
Request Syntax
{
"DeletionProtectionEnabled": boolean,
"IsoCountryCode": "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.
- DeletionProtectionEnabled
-
By default this is set to false. When set to true the sender ID can't be deleted.
Type: Boolean
Required: No
- IsoCountryCode
-
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
Type: String
Length Constraints: Fixed length of 2.
Pattern:
[A-Z]{2}Required: Yes
- SenderId
-
The sender ID to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: Yes
Response Syntax
{
"DeletionProtectionEnabled": boolean,
"IsoCountryCode": "string",
"MessageTypes": [ "string" ],
"MonthlyLeasingPrice": "string",
"Registered": boolean,
"RegistrationId": "string",
"SenderId": "string",
"SenderIdArn": "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.
- DeletionProtectionEnabled
-
By default this is set to false. When set to true the sender ID can't be deleted.
Type: Boolean
- IsoCountryCode
-
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
Type: String
Length Constraints: Fixed length of 2.
Pattern:
[A-Z]{2} - MessageTypes
-
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: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Valid Values:
TRANSACTIONAL | PROMOTIONAL - MonthlyLeasingPrice
-
The monthly price, in US dollars, to lease the sender ID.
Type: String
- Registered
-
True if the sender ID is registered..
Type: Boolean
- RegistrationId
-
The unique identifier for the registration.
Type: String
- SenderId
-
The sender ID that was updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 11.
Pattern:
[A-Za-z0-9_-]+ - SenderIdArn
-
The Amazon Resource Name (ARN) associated with the SenderId.
Type: String
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:
