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

Class: Aws::Pinpoint::Types::SMSChannelResponse

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

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The unique identifier for the application that the SMS channel applies to.

Returns:

  • (String) —

    The unique identifier for the application that the SMS channel applies to.

#creation_date ⇒ String

The date and time, in ISO 8601 format, when the SMS channel was enabled.

Returns:

  • (String) —

    The date and time, in ISO 8601 format, when the SMS channel was enabled.

#enabled ⇒ Boolean

Specifies whether the SMS channel is enabled for the application.

Returns:

  • (Boolean) —

    Specifies whether the SMS channel is enabled for the application.

#has_credential ⇒ Boolean

(Not used) This property is retained only for backward compatibility.

Returns:

  • (Boolean) —

    (Not used) This property is retained only for backward compatibility.

#id ⇒ String

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

Returns:

  • (String) —

    (Deprecated) An identifier for the SMS channel.

#is_archived ⇒ Boolean

Specifies whether the SMS channel is archived.

Returns:

  • (Boolean) —

    Specifies whether the SMS channel is archived.

#last_modified_by ⇒ String

The user who last modified the SMS channel.

Returns:

  • (String) —

    The user who last modified the SMS channel.

#last_modified_date ⇒ String

The date and time, in ISO 8601 format, when the SMS channel was last modified.

Returns:

  • (String) —

    The date and time, in ISO 8601 format, when the SMS channel was last modified.

#platform ⇒ String

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

Returns:

  • (String) —

    The type of messaging or notification platform for the channel.

#promotional_messages_per_second ⇒ Integer

The maximum number of promotional messages that you can send through the SMS channel each second.

Returns:

  • (Integer) —

    The maximum number of promotional messages that you can send through the SMS channel each second.

#sender_id ⇒ String

The identity that displays on recipients\' devices when they receive messages from the SMS channel.

Returns:

  • (String) —

    The identity that displays on recipients\' devices when they receive messages from the SMS channel.

#short_code ⇒ String

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

Returns:

  • (String) —

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

#transactional_messages_per_second ⇒ Integer

The maximum number of transactional messages that you can send through the SMS channel each second.

Returns:

  • (Integer) —

    The maximum number of transactional messages that you can send through the SMS channel each second.

#version ⇒ Integer

The current version of the SMS channel.

Returns:

  • (Integer) —

    The current version of the SMS channel.