Class: Aws::PinpointSMSVoiceV2::Types::SendMediaMessageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointSMSVoiceV2::Types::SendMediaMessageRequest
- Defined in:
- gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#configuration_set_name ⇒ String
The name of the configuration set to use.
-
#context ⇒ Hash<String,String>
You can specify custom data in this field.
-
#destination_phone_number ⇒ String
The destination phone number in E.164 format.
-
#dry_run ⇒ Boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
-
#max_price ⇒ String
The maximum amount that you want to spend, in US dollars, per each MMS message.
-
#media_urls ⇒ Array<String>
An array of URLs to each media file to send.
-
#message_body ⇒ String
The text body of the message.
-
#origination_identity ⇒ String
The origination identity of the message.
-
#protect_configuration_id ⇒ String
The unique identifier of the protect configuration to use.
-
#time_to_live ⇒ Integer
How long the text message is valid for.
Instance Attribute Details
#configuration_set_name ⇒ String
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#context ⇒ Hash<String,String>
You can specify custom data in this field. If you do, that data is logged to the event destination.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#destination_phone_number ⇒ String
The destination phone number in E.164 format.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#dry_run ⇒ Boolean
When set to true, the message is checked and validated, but isn't sent to the end recipient.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#max_price ⇒ String
The maximum amount that you want to spend, in US dollars, per each MMS message.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#media_urls ⇒ Array<String>
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#message_body ⇒ String
The text body of the message.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#origination_identity ⇒ String
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#protect_configuration_id ⇒ String
The unique identifier of the protect configuration to use.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |
#time_to_live ⇒ Integer
How long the text message is valid for. By default this is 72 hours.
5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 |
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5471 class SendMediaMessageRequest < Struct.new( :destination_phone_number, :origination_identity, :message_body, :media_urls, :configuration_set_name, :max_price, :time_to_live, :context, :dry_run, :protect_configuration_id) SENSITIVE = [] include Aws::Structure end |