AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::SMSChannelRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SMSChannelRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  enabled: false,
  sender_id: "__string",
  short_code: "__string",
}

Specifies the status and settings of the SMS channel for an application.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Specifies whether to enable the SMS channel for the application.

Returns:

  • (Boolean)

    Specifies whether to enable the SMS channel for the application.

#sender_idString

The identity that you want to display on recipients\' devices when they receive messages from the SMS channel.

Returns:

  • (String)

    The identity that you want to display on recipients\' devices when they receive messages from the SMS channel.

#short_codeString

The registered short code that you want to use when you send messages through the SMS channel.

Returns:

  • (String)

    The registered short code that you want to use when you send messages through the SMS channel.