Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Deletes an existing notify configuration.

If deletion protection is enabled, an error is returned.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.DeleteNotifyConfiguration' required

Request body

NotifyConfigurationIdstring required

The identifier of the notify configuration to delete. The NotifyConfigurationId can be found using the <a>DescribeNotifyConfigurations</a> operation.

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.