NotifyConfigurationInformation - AWS End User Messaging SMS

NotifyConfigurationInformation

The information for a notify configuration in an AWS account.

Contents

CreatedTimestamp

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

Type: Timestamp

Required: Yes

DeletionProtectionEnabled

When set to true deletion protection is enabled. By default this is set to false.

Type: Boolean

Required: Yes

DisplayName

The display name associated with the notify configuration.

Type: String

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

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

Required: Yes

EnabledChannels

An array of channels enabled for the notify configuration. Supported values include 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

NotifyConfigurationArn

The Amazon Resource Name (ARN) for the notify configuration.

Type: String

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

Pattern: arn:\S+

Required: Yes

NotifyConfigurationId

The unique identifier for the notify configuration.

Type: String

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

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

Required: Yes

Status

The current status of the notify configuration.

Type: String

Valid Values: PENDING | ACTIVE | REJECTED | REQUIRES_VERIFICATION

Required: Yes

Tier

The tier of the notify configuration.

Type: String

Valid Values: BASIC | ADVANCED

Required: Yes

TierUpgradeStatus

The tier upgrade status of the notify configuration.

Type: String

Valid Values: BASIC | PENDING_UPGRADE | ADVANCED | REJECTED

Required: Yes

UseCase

The use case for the notify configuration.

Type: String

Valid Values: CODE_VERIFICATION

Required: Yes

DefaultTemplateId

The default template identifier associated with the notify configuration.

Type: String

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

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

Required: No

EnabledCountries

An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

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

PoolId

The identifier of the pool associated with the notify configuration.

Type: String

Required: No

RejectionReason

The reason the notify configuration was rejected, if applicable.

Type: String

Required: No

See Also

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