OriginationIdentityMetadata - AWS End User Messaging SMS
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

OriginationIdentityMetadata

The metadata for an origination identity associated with a pool.

Contents

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and may not be present for origination identity types that are not country-specific, such as RCS agents.

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: Yes

NumberCapabilities

Describes if the origination identity can be used for text messages, voice calls or both.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Valid Values: SMS | VOICE | MMS | RCS

Required: Yes

OriginationIdentity

The unique identifier of the origination identity.

Type: String

Required: Yes

OriginationIdentityArn

The Amazon Resource Name (ARN) associated with the origination identity.

Type: String

Required: Yes

PhoneNumber

The phone number in E.164 format.

Type: String

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

Pattern: \+?[1-9][0-9]{1,18}

Required: No

See Also

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