Get Sms Channel

pinpoint_get_sms_channel

R Documentation

Retrieves information about the status and settings of the SMS channel for an application¶

Description¶

Retrieves information about the status and settings of the SMS channel for an application.

Usage¶

pinpoint_get_sms_channel(ApplicationId)

Arguments¶

ApplicationId: [required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Value¶

A list with the following syntax:

list(
  SMSChannelResponse = list(
    ApplicationId = "string",
    CreationDate = "string",
    Enabled = TRUE|FALSE,
    HasCredential = TRUE|FALSE,
    Id = "string",
    IsArchived = TRUE|FALSE,
    LastModifiedBy = "string",
    LastModifiedDate = "string",
    Platform = "string",
    PromotionalMessagesPerSecond = 123,
    SenderId = "string",
    ShortCode = "string",
    TransactionalMessagesPerSecond = 123,
    Version = 123
  )
)

Request syntax¶

svc$get_sms_channel(
  ApplicationId = "string"
)