Update Notify Configuration

pinpointsmsvoicev2_update_notify_configuration

R Documentation

Updates an existing notify configuration¶

Description¶

Updates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection settings.

Usage¶

pinpointsmsvoicev2_update_notify_configuration(NotifyConfigurationId,
  DefaultTemplateId, PoolId, EnabledCountries, EnabledChannels,
  DeletionProtectionEnabled)

Arguments¶

NotifyConfigurationId

[required] The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the describe_notify_configurations operation.

DefaultTemplateId

The template ID to set as the default, or the special value UNSET_DEFAULT_TEMPLATE to clear the current default template.

PoolId

The pool ID or ARN to associate, or the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool.

EnabledCountries

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

EnabledChannels

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

DeletionProtectionEnabled

When set to true the notify configuration can't be deleted.

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,
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$update_notify_configuration(
  NotifyConfigurationId = "string",
  DefaultTemplateId = "string",
  PoolId = "string",
  EnabledCountries = list(
    "string"
  ),
  EnabledChannels = list(
    "SMS"|"VOICE"|"MMS"|"RCS"
  ),
  DeletionProtectionEnabled = TRUE|FALSE
)