Describe Notify Configurations

pinpointsmsvoicev2_describe_notify_configurations

R Documentation

Describes the specified notify configurations or all notify configurations in your account¶

Description¶

Describes the specified notify configurations or all notify configurations in your account.

If you specify notify configuration IDs, the output includes information for only the specified notify configurations. If you specify filters, the output includes information for only those notify configurations that meet the filter criteria. If you don't specify notify configuration IDs or filters, the output includes information for all notify configurations.

If you specify a notify configuration ID that isn't valid, an error is returned.

Usage¶

pinpointsmsvoicev2_describe_notify_configurations(
  NotifyConfigurationIds, Filters, NextToken, MaxResults)

Arguments¶

NotifyConfigurationIds

An array of notify configuration IDs to describe.

Filters

An array of NotifyConfigurationFilter objects to filter the results on.

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

MaxResults

The maximum number of results to return per each request.

Value¶

A list with the following syntax:

list(
  NotifyConfigurations = list(
    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"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_notify_configurations(
  NotifyConfigurationIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "display-name"|"enabled-countries"|"enabled-channels"|"default-template"|"default-pool"|"use-case"|"status"|"deletion-protection-enabled"|"tier-upgrade-status",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)