Skip to content

Update Sms Channel

pinpoint_update_sms_channel R Documentation

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application

Description

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

Usage

pinpoint_update_sms_channel(ApplicationId, SMSChannelRequest)

Arguments

ApplicationId

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

SMSChannelRequest

[required]

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$update_sms_channel(
  ApplicationId = "string",
  SMSChannelRequest = list(
    Enabled = TRUE|FALSE,
    SenderId = "string",
    ShortCode = "string"
  )
)