NotifyTemplateInformation - 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.

NotifyTemplateInformation

The information for a system-managed notify template in an AWS account.

Contents

Channels

The channels for the template. Supported values are SMS and VOICE.

Type: Array of strings

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

Valid Values: SMS | VOICE | MMS | RCS

Required: Yes

CreatedTimestamp

The time when the notify template was created, in UNIX epoch time format.

Type: Timestamp

Required: Yes

TemplateId

The unique identifier for the template.

Type: String

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

Pattern: ([A-Za-z0-9_-]*|UNSET_DEFAULT_TEMPLATE)

Required: Yes

TemplateType

The type of the template.

Type: String

Valid Values: OTP_VERIFICATION

Required: Yes

Version

The version of the template.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

Content

The content of the template.

Type: String

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

Required: No

LanguageCode

The language code for the template.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 5.

Pattern: [a-z]{2}(-[A-Z]{2})?

Required: No

Status

The current status of the template.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

SupportedCountries

An array of supported country codes for the template.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 300 items.

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: No

SupportedVoiceIds

An array of supported voice IDs for voice templates.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 60 items.

Valid Values: AMY | ASTRID | BIANCA | BRIAN | CAMILA | CARLA | CARMEN | CELINE | CHANTAL | CONCHITA | CRISTIANO | DORA | EMMA | ENRIQUE | EWA | FILIZ | GERAINT | GIORGIO | GWYNETH | HANS | INES | IVY | JACEK | JAN | JOANNA | JOEY | JUSTIN | KARL | KENDRA | KIMBERLY | LEA | LIV | LOTTE | LUCIA | LUPE | MADS | MAJA | MARLENE | MATHIEU | MATTHEW | MAXIM | MIA | MIGUEL | MIZUKI | NAJA | NICOLE | PENELOPE | RAVEENA | RICARDO | RUBEN | RUSSELL | SALLI | SEOYEON | TAKUMI | TATYANA | VICKI | VITORIA | ZEINA | ZHIYU

Required: No

TierAccess

The tier access level for the template.

Type: Array of strings

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

Valid Values: BASIC | ADVANCED

Required: No

Variables

An array of template variable metadata for the template.

Type: String to TemplateVariableMetadata object map

Required: No

See Also

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