v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.

post/#X-Amz-Target=PinpointSMSVoiceV2.CreateNotifyConfiguration

Headers

X-Amz-Target'PinpointSMSVoiceV2.CreateNotifyConfiguration' required

Request body

DisplayNamestring required

The display name to associate with the notify configuration.

UseCase'CODE_VERIFICATION' required

The use case for the notify configuration.

DefaultTemplateIdstring

The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

PoolIdstring

The identifier of the pool to associate with the notify configuration.

EnabledCountriesIsoCountryCode[]

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

EnabledChannelsNumberCapability[] required

An array of channels to enable for the notify configuration. Supported values include <code>SMS</code> and <code>VOICE</code>.

DeletionProtectionEnabledboolean

By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the <a>UpdateNotifyConfiguration</a> action.

ClientTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Response

Success

NotifyConfigurationArnstring required

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

NotifyConfigurationIdstring required

The unique identifier for the notify configuration.

DisplayNamestring required

The display name associated with the notify configuration.

UseCase'CODE_VERIFICATION' required

The use case for the notify configuration.

DefaultTemplateIdstring

The default template identifier associated with the notify configuration.

PoolIdstring

The identifier of the pool associated with the notify configuration.

EnabledCountriesIsoCountryCode[]

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

EnabledChannelsNumberCapability[] required

An array of channels enabled for the notify configuration. Supported values include <code>SMS</code> and <code>VOICE</code>.

Tier'BASIC' | 'ADVANCED' required

The tier of the notify configuration.

TierUpgradeStatus'BASIC' | 'PENDING_UPGRADE' | 'ADVANCED' | 'REJECTED' required

The tier upgrade status of the notify configuration.

Status'PENDING' | 'ACTIVE' | 'REJECTED' | 'REQUIRES_VERIFICATION' required

The current status of the notify configuration.

RejectionReasonstring

The reason the notify configuration was rejected, if applicable.

DeletionProtectionEnabledboolean required

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

CreatedTimestampstring date-time required

The time when the notify configuration was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.