Skip to content

Creates a new notify configuration for managed messaging

Description

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.

Usage

pinpointsmsvoicev2_create_notify_configuration(DisplayName, UseCase,
  DefaultTemplateId, PoolId, EnabledCountries, EnabledChannels,
  DeletionProtectionEnabled, ClientToken, Tags)

Arguments

  • DisplayName

[required] The display name to associate with the notify configuration.

  • UseCase

[required] The use case for the notify configuration.

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

  • PoolId

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

  • EnabledCountries

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

  • EnabledChannels

[required] An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

  • 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 update_notify_configuration action.

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

  • Tags

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

Value

A list with the following syntax:

list(
  NotifyConfigurationArn = "string",
  NotifyConfigurationId = "string",
  DisplayName = "string",
  UseCase = "CODE_VERIFICATION",
  DefaultTemplateId = "string",
  PoolId = "string",
  EnabledCountries = list(
    "string"
  ),
  EnabledChannels = list(
    "SMS"|"VOICE"|"MMS"|"RCS"
  ),
  Tier = "BASIC"|"ADVANCED",
  TierUpgradeStatus = "BASIC"|"PENDING_UPGRADE"|"ADVANCED"|"REJECTED",
  Status = "PENDING"|"ACTIVE"|"REJECTED"|"REQUIRES_VERIFICATION",
  RejectionReason = "string",
  DeletionProtectionEnabled = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_notify_configuration(
  DisplayName = "string",
  UseCase = "CODE_VERIFICATION",
  DefaultTemplateId = "string",
  PoolId = "string",
  EnabledCountries = list(
    "string"
  ),
  EnabledChannels = list(
    "SMS"|"VOICE"|"MMS"|"RCS"
  ),
  DeletionProtectionEnabled = TRUE|FALSE,
  ClientToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)