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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether the SMS channel is enabled for the application.

Returns:

  • (Boolean) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#has_credential ⇒ Boolean

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

Returns:

  • (Boolean) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#is_archived ⇒ Boolean

Specifies whether the SMS channel is archived.

Returns:

  • (Boolean) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ String

The user who last modified the SMS channel.

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#promotional_messages_per_second ⇒ Integer

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

Returns:

  • (Integer) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#sender_id ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#short_code ⇒ String

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

Returns:

  • (String) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#transactional_messages_per_second ⇒ Integer

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

Returns:

  • (Integer) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

The current version of the SMS channel.

Returns:

  • (Integer) 


10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10656

class SMSChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :enabled,
  :has_credential,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :promotional_messages_per_second,
  :sender_id,
  :short_code,
  :transactional_messages_per_second,
  :version)
  SENSITIVE = []
  include Aws::Structure
end