Describe Notify Templates

pinpointsmsvoicev2_describe_notify_templates

R Documentation

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

Description¶

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

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

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

Usage¶

pinpointsmsvoicev2_describe_notify_templates(TemplateIds, Filters,
  NextToken, MaxResults)

Arguments¶

TemplateIds

An array of template IDs to describe.

Filters

An array of NotifyTemplateFilter 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(
  NotifyTemplates = list(
    list(
      TemplateId = "string",
      Version = 123,
      TemplateType = "OTP_VERIFICATION",
      Channels = list(
        "SMS"|"VOICE"|"MMS"|"RCS"
      ),
      TierAccess = list(
        "BASIC"|"ADVANCED"
      ),
      Status = "ACTIVE"|"INACTIVE",
      SupportedCountries = list(
        "string"
      ),
      LanguageCode = "string",
      Content = "string",
      Variables = list(
        list(
          Type = "STRING"|"INTEGER"|"BOOLEAN",
          Required = TRUE|FALSE,
          Description = "string",
          MaxLength = 123,
          MinValue = 123,
          MaxValue = 123,
          DefaultValue = "string",
          Pattern = "string",
          Sample = "string",
          Source = "CUSTOMER"|"SYSTEM"
        )
      ),
      SupportedVoiceIds = list(
        "AMY"|"ASTRID"|"BIANCA"|"BRIAN"|"CAMILA"|"CARLA"|"CARMEN"|"CELINE"|"CHANTAL"|"CONCHITA"|"CRISTIANO"|"DORA"|"EMMA"|"ENRIQUE"|"EWA"|"FILIZ"|"GERAINT"|"GIORGIO"|"GWYNETH"|"HANS"|"INES"|"IVY"|"JACEK"|"JAN"|"JOANNA"|"JOEY"|"JUSTIN"|"KARL"|"KENDRA"|"KIMBERLY"|"LEA"|"LIV"|"LOTTE"|"LUCIA"|"LUPE"|"MADS"|"MAJA"|"MARLENE"|"MATHIEU"|"MATTHEW"|"MAXIM"|"MIA"|"MIGUEL"|"MIZUKI"|"NAJA"|"NICOLE"|"PENELOPE"|"RAVEENA"|"RICARDO"|"RUBEN"|"RUSSELL"|"SALLI"|"SEOYEON"|"TAKUMI"|"TATYANA"|"VICKI"|"VITORIA"|"ZEINA"|"ZHIYU"
      ),
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_notify_templates(
  TemplateIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "template-type"|"channels"|"tier-access"|"supported-countries"|"language-code"|"supported-voice-ids",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)