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

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

Overview

Note:

When making an API call, you may pass SMSChannelRequest data as a hash:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Specifies whether to enable the SMS channel for the application.

Returns:

  • (Boolean)


13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13387

class SMSChannelRequest < Struct.new(
  :enabled,
  :sender_id,
  :short_code)
  SENSITIVE = []
  include Aws::Structure
end

#sender_idString

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

Returns:

  • (String)


13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13387

class SMSChannelRequest < Struct.new(
  :enabled,
  :sender_id,
  :short_code)
  SENSITIVE = []
  include Aws::Structure
end

#short_codeString

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

Returns:

  • (String)


13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 13387

class SMSChannelRequest < Struct.new(
  :enabled,
  :sender_id,
  :short_code)
  SENSITIVE = []
  include Aws::Structure
end