SenderIdInformation - AWS End User Messaging SMS

SenderIdInformation

The information for all SenderIds in an AWS account.

Contents

DeletionProtectionEnabled

By default this is set to false. When set to true the sender ID can't be deleted.

Type: Boolean

Required: Yes

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

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

Required: Yes

MonthlyLeasingPrice

The monthly leasing price, in US dollars.

Type: String

Required: Yes

Registered

True if the sender ID is registered.

Type: Boolean

Required: Yes

SenderId

The alphanumeric sender ID in a specific country that you'd like to describe.

Type: String

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

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

Required: Yes

SenderIdArn

The Amazon Resource Name (ARN) associated with the SenderId.

Type: String

Required: Yes

RegistrationId

The unique identifier for the registration.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: