CreateNotifyConfiguration - AWS End User Messaging SMS
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

CreateNotifyConfiguration

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.

Request Syntax

{
   "ClientToken": "string",
   "DefaultTemplateId": "string",
   "DeletionProtectionEnabled": boolean,
   "DisplayName": "string",
   "EnabledChannels": [ "string" ],
   "EnabledCountries": [ "string" ],
   "PoolId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UseCase": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

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.

Type: String

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

Pattern: [!-~]+

Required: No

DefaultTemplateId

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

Type: String

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

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

Required: No

DeletionProtectionEnabled

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 UpdateNotifyConfiguration action.

Type: Boolean

Required: No

DisplayName

The display name to associate 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 to enable 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

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 to associate with the notify configuration.

Type: String

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

Pattern: [A-Za-z0-9_:/-]*

Required: No

Tags

An array of tags (key and value pairs) associated with the notify configuration.

Type: Array of Tag objects

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

Required: No

UseCase

The use case for the notify configuration.

Type: String

Valid Values: CODE_VERIFICATION

Required: Yes

Response Syntax

{
   "CreatedTimestamp": number,
   "DefaultTemplateId": "string",
   "DeletionProtectionEnabled": boolean,
   "DisplayName": "string",
   "EnabledChannels": [ "string" ],
   "EnabledCountries": [ "string" ],
   "NotifyConfigurationArn": "string",
   "NotifyConfigurationId": "string",
   "PoolId": "string",
   "RejectionReason": "string",
   "Status": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Tier": "string",
   "TierUpgradeStatus": "string",
   "UseCase": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedTimestamp

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

Type: Timestamp

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)

DeletionProtectionEnabled

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

Type: Boolean

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_ -]+

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

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}

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+

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_-]+

PoolId

The identifier of the pool associated with the notify configuration.

Type: String

RejectionReason

The reason the notify configuration was rejected, if applicable.

Type: String

Status

The current status of the notify configuration.

Type: String

Valid Values: PENDING | ACTIVE | REJECTED | REQUIRES_VERIFICATION

Tags

An array of tags (key and value pairs) associated with the notify configuration.

Type: Array of Tag objects

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

Tier

The tier of the notify configuration.

Type: String

Valid Values: BASIC | ADVANCED

TierUpgradeStatus

The tier upgrade status of the notify configuration.

Type: String

Valid Values: BASIC | PENDING_UPGRADE | ADVANCED | REJECTED

UseCase

The use case for the notify configuration.

Type: String

Valid Values: CODE_VERIFICATION

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

Reason

The reason for the exception.

HTTP Status Code: 400

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.

Reason

The reason for the exception.

ResourceId

The unique identifier of the request.

ResourceType

The type of resource that caused the exception.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

RequestId

The unique identifier of the request.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

ResourceId

The unique identifier of the resource.

ResourceType

The type of resource that caused the exception.

HTTP Status Code: 400

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Reason

The reason for the exception.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

Fields

The field that failed validation.

Reason

The reason for the exception.

HTTP Status Code: 400

See Also

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