aws-sdk-pinpoint 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-pinpoint.rb +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +60 -4
- data/lib/aws-sdk-pinpoint/client_api.rb +29 -0
- data/lib/aws-sdk-pinpoint/types.rb +391 -50
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b6726d8ac0ee5bad7205552860c4d2037e71659d
|
4
|
+
data.tar.gz: 32f755d061a5f328c3a20a1a20edd3c9e46434a1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7566d090f058edd06baf3bc2b92aa49fa6e858cb4378fbbce4449c46599a239059c669504e468ce24940df1a129cba9055974c61fdda43e780c221a23aa7ac8a
|
7
|
+
data.tar.gz: 26da249dbae9a7515b9cb0aea2e847d7029dda95e96265ea0a628f2cd65bccd77ae2f15cb772c7729f5c896f7c010b48576c242f63cfc0fec72ad0799b688662
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
@@ -1492,6 +1492,7 @@ module Aws::Pinpoint
|
|
1492
1492
|
# @example Response structure
|
1493
1493
|
#
|
1494
1494
|
# resp.email_channel_response.application_id #=> String
|
1495
|
+
# resp.email_channel_response.configuration_set #=> String
|
1495
1496
|
# resp.email_channel_response.creation_date #=> String
|
1496
1497
|
# resp.email_channel_response.enabled #=> Boolean
|
1497
1498
|
# resp.email_channel_response.from_address #=> String
|
@@ -3136,6 +3137,7 @@ module Aws::Pinpoint
|
|
3136
3137
|
# @example Response structure
|
3137
3138
|
#
|
3138
3139
|
# resp.email_channel_response.application_id #=> String
|
3140
|
+
# resp.email_channel_response.configuration_set #=> String
|
3139
3141
|
# resp.email_channel_response.creation_date #=> String
|
3140
3142
|
# resp.email_channel_response.enabled #=> Boolean
|
3141
3143
|
# resp.email_channel_response.from_address #=> String
|
@@ -4227,7 +4229,7 @@ module Aws::Pinpoint
|
|
4227
4229
|
# Returns information about the specified phone number.
|
4228
4230
|
#
|
4229
4231
|
# @option params [required, Types::NumberValidateRequest] :number_validate_request
|
4230
|
-
# Phone Number
|
4232
|
+
# Phone Number Validate request.
|
4231
4233
|
#
|
4232
4234
|
# @return [Types::PhoneNumberValidateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4233
4235
|
#
|
@@ -4314,7 +4316,7 @@ module Aws::Pinpoint
|
|
4314
4316
|
# @option params [required, String] :application_id
|
4315
4317
|
#
|
4316
4318
|
# @option params [required, Types::EventsRequest] :events_request
|
4317
|
-
#
|
4319
|
+
# A set of events to process.
|
4318
4320
|
#
|
4319
4321
|
# @return [Types::PutEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4320
4322
|
#
|
@@ -4577,6 +4579,32 @@ module Aws::Pinpoint
|
|
4577
4579
|
# title: "__string",
|
4578
4580
|
# url: "__string",
|
4579
4581
|
# },
|
4582
|
+
# email_message: {
|
4583
|
+
# body: "__string",
|
4584
|
+
# feedback_forwarding_address: "__string",
|
4585
|
+
# from_address: "__string",
|
4586
|
+
# raw_email: {
|
4587
|
+
# data: "data",
|
4588
|
+
# },
|
4589
|
+
# reply_to_addresses: ["__string"],
|
4590
|
+
# simple_email: {
|
4591
|
+
# html_part: {
|
4592
|
+
# charset: "__string",
|
4593
|
+
# data: "__string",
|
4594
|
+
# },
|
4595
|
+
# subject: {
|
4596
|
+
# charset: "__string",
|
4597
|
+
# data: "__string",
|
4598
|
+
# },
|
4599
|
+
# text_part: {
|
4600
|
+
# charset: "__string",
|
4601
|
+
# data: "__string",
|
4602
|
+
# },
|
4603
|
+
# },
|
4604
|
+
# substitutions: {
|
4605
|
+
# "__string" => ["__string"],
|
4606
|
+
# },
|
4607
|
+
# },
|
4580
4608
|
# gcm_message: {
|
4581
4609
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4582
4610
|
# body: "__string",
|
@@ -4746,6 +4774,32 @@ module Aws::Pinpoint
|
|
4746
4774
|
# title: "__string",
|
4747
4775
|
# url: "__string",
|
4748
4776
|
# },
|
4777
|
+
# email_message: {
|
4778
|
+
# body: "__string",
|
4779
|
+
# feedback_forwarding_address: "__string",
|
4780
|
+
# from_address: "__string",
|
4781
|
+
# raw_email: {
|
4782
|
+
# data: "data",
|
4783
|
+
# },
|
4784
|
+
# reply_to_addresses: ["__string"],
|
4785
|
+
# simple_email: {
|
4786
|
+
# html_part: {
|
4787
|
+
# charset: "__string",
|
4788
|
+
# data: "__string",
|
4789
|
+
# },
|
4790
|
+
# subject: {
|
4791
|
+
# charset: "__string",
|
4792
|
+
# data: "__string",
|
4793
|
+
# },
|
4794
|
+
# text_part: {
|
4795
|
+
# charset: "__string",
|
4796
|
+
# data: "__string",
|
4797
|
+
# },
|
4798
|
+
# },
|
4799
|
+
# substitutions: {
|
4800
|
+
# "__string" => ["__string"],
|
4801
|
+
# },
|
4802
|
+
# },
|
4749
4803
|
# gcm_message: {
|
4750
4804
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
4751
4805
|
# body: "__string",
|
@@ -5610,6 +5664,7 @@ module Aws::Pinpoint
|
|
5610
5664
|
# resp = client.update_email_channel({
|
5611
5665
|
# application_id: "__string", # required
|
5612
5666
|
# email_channel_request: { # required
|
5667
|
+
# configuration_set: "__string",
|
5613
5668
|
# enabled: false,
|
5614
5669
|
# from_address: "__string",
|
5615
5670
|
# identity: "__string",
|
@@ -5620,6 +5675,7 @@ module Aws::Pinpoint
|
|
5620
5675
|
# @example Response structure
|
5621
5676
|
#
|
5622
5677
|
# resp.email_channel_response.application_id #=> String
|
5678
|
+
# resp.email_channel_response.configuration_set #=> String
|
5623
5679
|
# resp.email_channel_response.creation_date #=> String
|
5624
5680
|
# resp.email_channel_response.enabled #=> Boolean
|
5625
5681
|
# resp.email_channel_response.from_address #=> String
|
@@ -5650,7 +5706,7 @@ module Aws::Pinpoint
|
|
5650
5706
|
# @option params [required, String] :endpoint_id
|
5651
5707
|
#
|
5652
5708
|
# @option params [required, Types::EndpointRequest] :endpoint_request
|
5653
|
-
#
|
5709
|
+
# An endpoint update request.
|
5654
5710
|
#
|
5655
5711
|
# @return [Types::UpdateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5656
5712
|
#
|
@@ -6172,7 +6228,7 @@ module Aws::Pinpoint
|
|
6172
6228
|
params: params,
|
6173
6229
|
config: config)
|
6174
6230
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
6175
|
-
context[:gem_version] = '1.
|
6231
|
+
context[:gem_version] = '1.12.0'
|
6176
6232
|
Seahorse::Client::Request.new(handlers, context)
|
6177
6233
|
end
|
6178
6234
|
|
@@ -97,6 +97,7 @@ module Aws::Pinpoint
|
|
97
97
|
Duration = Shapes::StringShape.new(name: 'Duration')
|
98
98
|
EmailChannelRequest = Shapes::StructureShape.new(name: 'EmailChannelRequest')
|
99
99
|
EmailChannelResponse = Shapes::StructureShape.new(name: 'EmailChannelResponse')
|
100
|
+
EmailMessage = Shapes::StructureShape.new(name: 'EmailMessage')
|
100
101
|
EndpointBatchItem = Shapes::StructureShape.new(name: 'EndpointBatchItem')
|
101
102
|
EndpointBatchRequest = Shapes::StructureShape.new(name: 'EndpointBatchRequest')
|
102
103
|
EndpointDemographic = Shapes::StructureShape.new(name: 'EndpointDemographic')
|
@@ -247,6 +248,7 @@ module Aws::Pinpoint
|
|
247
248
|
PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
|
248
249
|
PutEventsResponse = Shapes::StructureShape.new(name: 'PutEventsResponse')
|
249
250
|
QuietTime = Shapes::StructureShape.new(name: 'QuietTime')
|
251
|
+
RawEmail = Shapes::StructureShape.new(name: 'RawEmail')
|
250
252
|
RecencyDimension = Shapes::StructureShape.new(name: 'RecencyDimension')
|
251
253
|
RecencyType = Shapes::StringShape.new(name: 'RecencyType')
|
252
254
|
RemoveAttributesRequest = Shapes::StructureShape.new(name: 'RemoveAttributesRequest')
|
@@ -274,6 +276,8 @@ module Aws::Pinpoint
|
|
274
276
|
SendUsersMessagesResponse = Shapes::StructureShape.new(name: 'SendUsersMessagesResponse')
|
275
277
|
Session = Shapes::StructureShape.new(name: 'Session')
|
276
278
|
SetDimension = Shapes::StructureShape.new(name: 'SetDimension')
|
279
|
+
SimpleEmail = Shapes::StructureShape.new(name: 'SimpleEmail')
|
280
|
+
SimpleEmailPart = Shapes::StructureShape.new(name: 'SimpleEmailPart')
|
277
281
|
SourceType = Shapes::StringShape.new(name: 'SourceType')
|
278
282
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
279
283
|
TreatmentResource = Shapes::StructureShape.new(name: 'TreatmentResource')
|
@@ -312,6 +316,7 @@ module Aws::Pinpoint
|
|
312
316
|
WriteEventStream = Shapes::StructureShape.new(name: 'WriteEventStream')
|
313
317
|
WriteSegmentRequest = Shapes::StructureShape.new(name: 'WriteSegmentRequest')
|
314
318
|
WriteTreatmentResource = Shapes::StructureShape.new(name: 'WriteTreatmentResource')
|
319
|
+
__blob = Shapes::BlobShape.new(name: '__blob')
|
315
320
|
__boolean = Shapes::BooleanShape.new(name: '__boolean')
|
316
321
|
__double = Shapes::FloatShape.new(name: '__double')
|
317
322
|
__integer = Shapes::IntegerShape.new(name: '__integer')
|
@@ -819,10 +824,12 @@ module Aws::Pinpoint
|
|
819
824
|
DirectMessageConfiguration.add_member(:baidu_message, Shapes::ShapeRef.new(shape: BaiduMessage, location_name: "BaiduMessage"))
|
820
825
|
DirectMessageConfiguration.add_member(:default_message, Shapes::ShapeRef.new(shape: DefaultMessage, location_name: "DefaultMessage"))
|
821
826
|
DirectMessageConfiguration.add_member(:default_push_notification_message, Shapes::ShapeRef.new(shape: DefaultPushNotificationMessage, location_name: "DefaultPushNotificationMessage"))
|
827
|
+
DirectMessageConfiguration.add_member(:email_message, Shapes::ShapeRef.new(shape: EmailMessage, location_name: "EmailMessage"))
|
822
828
|
DirectMessageConfiguration.add_member(:gcm_message, Shapes::ShapeRef.new(shape: GCMMessage, location_name: "GCMMessage"))
|
823
829
|
DirectMessageConfiguration.add_member(:sms_message, Shapes::ShapeRef.new(shape: SMSMessage, location_name: "SMSMessage"))
|
824
830
|
DirectMessageConfiguration.struct_class = Types::DirectMessageConfiguration
|
825
831
|
|
832
|
+
EmailChannelRequest.add_member(:configuration_set, Shapes::ShapeRef.new(shape: __string, location_name: "ConfigurationSet"))
|
826
833
|
EmailChannelRequest.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "Enabled"))
|
827
834
|
EmailChannelRequest.add_member(:from_address, Shapes::ShapeRef.new(shape: __string, location_name: "FromAddress"))
|
828
835
|
EmailChannelRequest.add_member(:identity, Shapes::ShapeRef.new(shape: __string, location_name: "Identity"))
|
@@ -830,6 +837,7 @@ module Aws::Pinpoint
|
|
830
837
|
EmailChannelRequest.struct_class = Types::EmailChannelRequest
|
831
838
|
|
832
839
|
EmailChannelResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, location_name: "ApplicationId"))
|
840
|
+
EmailChannelResponse.add_member(:configuration_set, Shapes::ShapeRef.new(shape: __string, location_name: "ConfigurationSet"))
|
833
841
|
EmailChannelResponse.add_member(:creation_date, Shapes::ShapeRef.new(shape: __string, location_name: "CreationDate"))
|
834
842
|
EmailChannelResponse.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "Enabled"))
|
835
843
|
EmailChannelResponse.add_member(:from_address, Shapes::ShapeRef.new(shape: __string, location_name: "FromAddress"))
|
@@ -845,6 +853,15 @@ module Aws::Pinpoint
|
|
845
853
|
EmailChannelResponse.add_member(:version, Shapes::ShapeRef.new(shape: __integer, location_name: "Version"))
|
846
854
|
EmailChannelResponse.struct_class = Types::EmailChannelResponse
|
847
855
|
|
856
|
+
EmailMessage.add_member(:body, Shapes::ShapeRef.new(shape: __string, location_name: "Body"))
|
857
|
+
EmailMessage.add_member(:feedback_forwarding_address, Shapes::ShapeRef.new(shape: __string, location_name: "FeedbackForwardingAddress"))
|
858
|
+
EmailMessage.add_member(:from_address, Shapes::ShapeRef.new(shape: __string, location_name: "FromAddress"))
|
859
|
+
EmailMessage.add_member(:raw_email, Shapes::ShapeRef.new(shape: RawEmail, location_name: "RawEmail"))
|
860
|
+
EmailMessage.add_member(:reply_to_addresses, Shapes::ShapeRef.new(shape: ListOf__string, location_name: "ReplyToAddresses"))
|
861
|
+
EmailMessage.add_member(:simple_email, Shapes::ShapeRef.new(shape: SimpleEmail, location_name: "SimpleEmail"))
|
862
|
+
EmailMessage.add_member(:substitutions, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Substitutions"))
|
863
|
+
EmailMessage.struct_class = Types::EmailMessage
|
864
|
+
|
848
865
|
EndpointBatchItem.add_member(:address, Shapes::ShapeRef.new(shape: __string, location_name: "Address"))
|
849
866
|
EndpointBatchItem.add_member(:attributes, Shapes::ShapeRef.new(shape: MapOfListOf__string, location_name: "Attributes"))
|
850
867
|
EndpointBatchItem.add_member(:channel_type, Shapes::ShapeRef.new(shape: ChannelType, location_name: "ChannelType"))
|
@@ -1562,6 +1579,9 @@ module Aws::Pinpoint
|
|
1562
1579
|
QuietTime.add_member(:start, Shapes::ShapeRef.new(shape: __string, location_name: "Start"))
|
1563
1580
|
QuietTime.struct_class = Types::QuietTime
|
1564
1581
|
|
1582
|
+
RawEmail.add_member(:data, Shapes::ShapeRef.new(shape: __blob, location_name: "Data"))
|
1583
|
+
RawEmail.struct_class = Types::RawEmail
|
1584
|
+
|
1565
1585
|
RecencyDimension.add_member(:duration, Shapes::ShapeRef.new(shape: Duration, location_name: "Duration"))
|
1566
1586
|
RecencyDimension.add_member(:recency_type, Shapes::ShapeRef.new(shape: RecencyType, location_name: "RecencyType"))
|
1567
1587
|
RecencyDimension.struct_class = Types::RecencyDimension
|
@@ -1719,6 +1739,15 @@ module Aws::Pinpoint
|
|
1719
1739
|
SetDimension.add_member(:values, Shapes::ShapeRef.new(shape: ListOf__string, location_name: "Values"))
|
1720
1740
|
SetDimension.struct_class = Types::SetDimension
|
1721
1741
|
|
1742
|
+
SimpleEmail.add_member(:html_part, Shapes::ShapeRef.new(shape: SimpleEmailPart, location_name: "HtmlPart"))
|
1743
|
+
SimpleEmail.add_member(:subject, Shapes::ShapeRef.new(shape: SimpleEmailPart, location_name: "Subject"))
|
1744
|
+
SimpleEmail.add_member(:text_part, Shapes::ShapeRef.new(shape: SimpleEmailPart, location_name: "TextPart"))
|
1745
|
+
SimpleEmail.struct_class = Types::SimpleEmail
|
1746
|
+
|
1747
|
+
SimpleEmailPart.add_member(:charset, Shapes::ShapeRef.new(shape: __string, location_name: "Charset"))
|
1748
|
+
SimpleEmailPart.add_member(:data, Shapes::ShapeRef.new(shape: __string, location_name: "Data"))
|
1749
|
+
SimpleEmailPart.struct_class = Types::SimpleEmailPart
|
1750
|
+
|
1722
1751
|
TreatmentResource.add_member(:id, Shapes::ShapeRef.new(shape: __string, location_name: "Id"))
|
1723
1752
|
TreatmentResource.add_member(:message_configuration, Shapes::ShapeRef.new(shape: MessageConfiguration, location_name: "MessageConfiguration"))
|
1724
1753
|
TreatmentResource.add_member(:schedule, Shapes::ShapeRef.new(shape: Schedule, location_name: "Schedule"))
|
@@ -1508,7 +1508,7 @@ module Aws::Pinpoint
|
|
1508
1508
|
end
|
1509
1509
|
|
1510
1510
|
# Campaign Limits are used to limit the number of messages that can be
|
1511
|
-
# sent to a
|
1511
|
+
# sent to a single endpoint.
|
1512
1512
|
#
|
1513
1513
|
# @note When making an API call, you may pass CampaignLimits
|
1514
1514
|
# data as a hash:
|
@@ -1521,7 +1521,8 @@ module Aws::Pinpoint
|
|
1521
1521
|
# }
|
1522
1522
|
#
|
1523
1523
|
# @!attribute [rw] daily
|
1524
|
-
# The maximum number of messages that
|
1524
|
+
# The maximum number of messages that each campaign can send to a
|
1525
|
+
# single endpoint in a 24-hour period.
|
1525
1526
|
# @return [Integer]
|
1526
1527
|
#
|
1527
1528
|
# @!attribute [rw] maximum_duration
|
@@ -1536,7 +1537,8 @@ module Aws::Pinpoint
|
|
1536
1537
|
# @return [Integer]
|
1537
1538
|
#
|
1538
1539
|
# @!attribute [rw] total
|
1539
|
-
# The maximum
|
1540
|
+
# The maximum number of messages that an individual campaign can send
|
1541
|
+
# to a single endpoint over the course of the campaign.
|
1540
1542
|
# @return [Integer]
|
1541
1543
|
#
|
1542
1544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignLimits AWS API Documentation
|
@@ -2431,9 +2433,9 @@ module Aws::Pinpoint
|
|
2431
2433
|
# @return [Hash<String,String>]
|
2432
2434
|
#
|
2433
2435
|
# @!attribute [rw] silent_push
|
2434
|
-
# Indicates if the message should display on the
|
2435
|
-
#
|
2436
|
-
#
|
2436
|
+
# Indicates if the message should display on the recipient's device.
|
2437
|
+
# You can use silent pushes for remote configuration or to deliver
|
2438
|
+
# messages to in-app notification centers.
|
2437
2439
|
# @return [Boolean]
|
2438
2440
|
#
|
2439
2441
|
# @!attribute [rw] substitutions
|
@@ -2995,6 +2997,32 @@ module Aws::Pinpoint
|
|
2995
2997
|
# title: "__string",
|
2996
2998
|
# url: "__string",
|
2997
2999
|
# },
|
3000
|
+
# email_message: {
|
3001
|
+
# body: "__string",
|
3002
|
+
# feedback_forwarding_address: "__string",
|
3003
|
+
# from_address: "__string",
|
3004
|
+
# raw_email: {
|
3005
|
+
# data: "data",
|
3006
|
+
# },
|
3007
|
+
# reply_to_addresses: ["__string"],
|
3008
|
+
# simple_email: {
|
3009
|
+
# html_part: {
|
3010
|
+
# charset: "__string",
|
3011
|
+
# data: "__string",
|
3012
|
+
# },
|
3013
|
+
# subject: {
|
3014
|
+
# charset: "__string",
|
3015
|
+
# data: "__string",
|
3016
|
+
# },
|
3017
|
+
# text_part: {
|
3018
|
+
# charset: "__string",
|
3019
|
+
# data: "__string",
|
3020
|
+
# },
|
3021
|
+
# },
|
3022
|
+
# substitutions: {
|
3023
|
+
# "__string" => ["__string"],
|
3024
|
+
# },
|
3025
|
+
# },
|
2998
3026
|
# gcm_message: {
|
2999
3027
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
3000
3028
|
# body: "__string",
|
@@ -3053,6 +3081,10 @@ module Aws::Pinpoint
|
|
3053
3081
|
# The default push notification message for all push channels.
|
3054
3082
|
# @return [Types::DefaultPushNotificationMessage]
|
3055
3083
|
#
|
3084
|
+
# @!attribute [rw] email_message
|
3085
|
+
# The message to Email channels. Overrides the default message.
|
3086
|
+
# @return [Types::EmailMessage]
|
3087
|
+
#
|
3056
3088
|
# @!attribute [rw] gcm_message
|
3057
3089
|
# The message to GCM channels. Overrides the default push notification
|
3058
3090
|
# message.
|
@@ -3070,6 +3102,7 @@ module Aws::Pinpoint
|
|
3070
3102
|
:baidu_message,
|
3071
3103
|
:default_message,
|
3072
3104
|
:default_push_notification_message,
|
3105
|
+
:email_message,
|
3073
3106
|
:gcm_message,
|
3074
3107
|
:sms_message)
|
3075
3108
|
include Aws::Structure
|
@@ -3081,12 +3114,18 @@ module Aws::Pinpoint
|
|
3081
3114
|
# data as a hash:
|
3082
3115
|
#
|
3083
3116
|
# {
|
3117
|
+
# configuration_set: "__string",
|
3084
3118
|
# enabled: false,
|
3085
3119
|
# from_address: "__string",
|
3086
3120
|
# identity: "__string",
|
3087
3121
|
# role_arn: "__string",
|
3088
3122
|
# }
|
3089
3123
|
#
|
3124
|
+
# @!attribute [rw] configuration_set
|
3125
|
+
# The configuration set that you want to use when you send email using
|
3126
|
+
# the Pinpoint Email API.
|
3127
|
+
# @return [String]
|
3128
|
+
#
|
3090
3129
|
# @!attribute [rw] enabled
|
3091
3130
|
# If the channel is enabled for sending messages.
|
3092
3131
|
# @return [Boolean]
|
@@ -3107,6 +3146,7 @@ module Aws::Pinpoint
|
|
3107
3146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailChannelRequest AWS API Documentation
|
3108
3147
|
#
|
3109
3148
|
class EmailChannelRequest < Struct.new(
|
3149
|
+
:configuration_set,
|
3110
3150
|
:enabled,
|
3111
3151
|
:from_address,
|
3112
3152
|
:identity,
|
@@ -3120,6 +3160,11 @@ module Aws::Pinpoint
|
|
3120
3160
|
# The unique ID of the application to which the email channel belongs.
|
3121
3161
|
# @return [String]
|
3122
3162
|
#
|
3163
|
+
# @!attribute [rw] configuration_set
|
3164
|
+
# The configuration set that you want to use when you send email using
|
3165
|
+
# the Pinpoint Email API.
|
3166
|
+
# @return [String]
|
3167
|
+
#
|
3123
3168
|
# @!attribute [rw] creation_date
|
3124
3169
|
# The date that the settings were last updated in ISO 8601 format.
|
3125
3170
|
# @return [String]
|
@@ -3177,6 +3222,7 @@ module Aws::Pinpoint
|
|
3177
3222
|
#
|
3178
3223
|
class EmailChannelResponse < Struct.new(
|
3179
3224
|
:application_id,
|
3225
|
+
:configuration_set,
|
3180
3226
|
:creation_date,
|
3181
3227
|
:enabled,
|
3182
3228
|
:from_address,
|
@@ -3193,6 +3239,83 @@ module Aws::Pinpoint
|
|
3193
3239
|
include Aws::Structure
|
3194
3240
|
end
|
3195
3241
|
|
3242
|
+
# Email Message.
|
3243
|
+
#
|
3244
|
+
# @note When making an API call, you may pass EmailMessage
|
3245
|
+
# data as a hash:
|
3246
|
+
#
|
3247
|
+
# {
|
3248
|
+
# body: "__string",
|
3249
|
+
# feedback_forwarding_address: "__string",
|
3250
|
+
# from_address: "__string",
|
3251
|
+
# raw_email: {
|
3252
|
+
# data: "data",
|
3253
|
+
# },
|
3254
|
+
# reply_to_addresses: ["__string"],
|
3255
|
+
# simple_email: {
|
3256
|
+
# html_part: {
|
3257
|
+
# charset: "__string",
|
3258
|
+
# data: "__string",
|
3259
|
+
# },
|
3260
|
+
# subject: {
|
3261
|
+
# charset: "__string",
|
3262
|
+
# data: "__string",
|
3263
|
+
# },
|
3264
|
+
# text_part: {
|
3265
|
+
# charset: "__string",
|
3266
|
+
# data: "__string",
|
3267
|
+
# },
|
3268
|
+
# },
|
3269
|
+
# substitutions: {
|
3270
|
+
# "__string" => ["__string"],
|
3271
|
+
# },
|
3272
|
+
# }
|
3273
|
+
#
|
3274
|
+
# @!attribute [rw] body
|
3275
|
+
# The body of the email message.
|
3276
|
+
# @return [String]
|
3277
|
+
#
|
3278
|
+
# @!attribute [rw] feedback_forwarding_address
|
3279
|
+
# The email address that bounces and complaints will be forwarded to
|
3280
|
+
# when feedback forwarding is enabled.
|
3281
|
+
# @return [String]
|
3282
|
+
#
|
3283
|
+
# @!attribute [rw] from_address
|
3284
|
+
# The email address used to send the email from. Defaults to use
|
3285
|
+
# FromAddress specified in the Email Channel.
|
3286
|
+
# @return [String]
|
3287
|
+
#
|
3288
|
+
# @!attribute [rw] raw_email
|
3289
|
+
# An email represented as a raw MIME message.
|
3290
|
+
# @return [Types::RawEmail]
|
3291
|
+
#
|
3292
|
+
# @!attribute [rw] reply_to_addresses
|
3293
|
+
# The reply-to email address(es) for the email. If the recipient
|
3294
|
+
# replies to the email, each reply-to address will receive the reply.
|
3295
|
+
# @return [Array<String>]
|
3296
|
+
#
|
3297
|
+
# @!attribute [rw] simple_email
|
3298
|
+
# An email composed of a subject, a text part and a html part.
|
3299
|
+
# @return [Types::SimpleEmail]
|
3300
|
+
#
|
3301
|
+
# @!attribute [rw] substitutions
|
3302
|
+
# Default message substitutions. Can be overridden by individual
|
3303
|
+
# address substitutions.
|
3304
|
+
# @return [Hash<String,Array<String>>]
|
3305
|
+
#
|
3306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EmailMessage AWS API Documentation
|
3307
|
+
#
|
3308
|
+
class EmailMessage < Struct.new(
|
3309
|
+
:body,
|
3310
|
+
:feedback_forwarding_address,
|
3311
|
+
:from_address,
|
3312
|
+
:raw_email,
|
3313
|
+
:reply_to_addresses,
|
3314
|
+
:simple_email,
|
3315
|
+
:substitutions)
|
3316
|
+
include Aws::Structure
|
3317
|
+
end
|
3318
|
+
|
3196
3319
|
# Endpoint update request
|
3197
3320
|
#
|
3198
3321
|
# @note When making an API call, you may pass EndpointBatchItem
|
@@ -3446,8 +3569,8 @@ module Aws::Pinpoint
|
|
3446
3569
|
include Aws::Structure
|
3447
3570
|
end
|
3448
3571
|
|
3449
|
-
#
|
3450
|
-
#
|
3572
|
+
# A complex object that holds the status code and message as a result of
|
3573
|
+
# processing an endpoint.
|
3451
3574
|
#
|
3452
3575
|
# @!attribute [rw] message
|
3453
3576
|
# A custom message associated with the registration of an endpoint
|
@@ -3455,8 +3578,8 @@ module Aws::Pinpoint
|
|
3455
3578
|
# @return [String]
|
3456
3579
|
#
|
3457
3580
|
# @!attribute [rw] status_code
|
3458
|
-
# The status code
|
3459
|
-
#
|
3581
|
+
# The status code associated with the merging of an endpoint when
|
3582
|
+
# issuing a response.
|
3460
3583
|
# @return [Integer]
|
3461
3584
|
#
|
3462
3585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointItemResponse AWS API Documentation
|
@@ -3487,7 +3610,7 @@ module Aws::Pinpoint
|
|
3487
3610
|
#
|
3488
3611
|
# @!attribute [rw] country
|
3489
3612
|
# The two-letter code for the country or region of the endpoint.
|
3490
|
-
# Specified as an ISO 3166-1
|
3613
|
+
# Specified as an ISO 3166-1 alpha-2 code, such as "US" for the
|
3491
3614
|
# United States.
|
3492
3615
|
# @return [String]
|
3493
3616
|
#
|
@@ -3574,7 +3697,7 @@ module Aws::Pinpoint
|
|
3574
3697
|
include Aws::Structure
|
3575
3698
|
end
|
3576
3699
|
|
3577
|
-
#
|
3700
|
+
# An endpoint update request.
|
3578
3701
|
#
|
3579
3702
|
# @note When making an API call, you may pass EndpointRequest
|
3580
3703
|
# data as a hash:
|
@@ -3942,11 +4065,11 @@ module Aws::Pinpoint
|
|
3942
4065
|
# @return [String]
|
3943
4066
|
#
|
3944
4067
|
# @!attribute [rw] metrics
|
3945
|
-
#
|
4068
|
+
# Custom metrics related to the event.
|
3946
4069
|
# @return [Hash<String,Float>]
|
3947
4070
|
#
|
3948
4071
|
# @!attribute [rw] session
|
3949
|
-
#
|
4072
|
+
# Information about the session in which the event occurred.
|
3950
4073
|
# @return [Types::Session]
|
3951
4074
|
#
|
3952
4075
|
# @!attribute [rw] timestamp
|
@@ -3965,14 +4088,17 @@ module Aws::Pinpoint
|
|
3965
4088
|
include Aws::Structure
|
3966
4089
|
end
|
3967
4090
|
|
3968
|
-
#
|
4091
|
+
# A complex object that holds the status code and message as a result of
|
4092
|
+
# processing an event.
|
3969
4093
|
#
|
3970
4094
|
# @!attribute [rw] message
|
3971
4095
|
# A custom message that is associated with the processing of an event.
|
3972
4096
|
# @return [String]
|
3973
4097
|
#
|
3974
4098
|
# @!attribute [rw] status_code
|
3975
|
-
# The status
|
4099
|
+
# The status returned in the response as a result of processing the
|
4100
|
+
# event. Possible values: 400 (for invalid events) and 202 (for events
|
4101
|
+
# that were accepted).
|
3976
4102
|
# @return [Integer]
|
3977
4103
|
#
|
3978
4104
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventItemResponse AWS API Documentation
|
@@ -4029,7 +4155,7 @@ module Aws::Pinpoint
|
|
4029
4155
|
include Aws::Structure
|
4030
4156
|
end
|
4031
4157
|
|
4032
|
-
#
|
4158
|
+
# A batch of PublicEndpoints and Events to process.
|
4033
4159
|
#
|
4034
4160
|
# @note When making an API call, you may pass EventsBatch
|
4035
4161
|
# data as a hash:
|
@@ -4095,11 +4221,12 @@ module Aws::Pinpoint
|
|
4095
4221
|
# }
|
4096
4222
|
#
|
4097
4223
|
# @!attribute [rw] endpoint
|
4098
|
-
#
|
4224
|
+
# The PublicEndpoint attached to the EndpointId from the request.
|
4099
4225
|
# @return [Types::PublicEndpoint]
|
4100
4226
|
#
|
4101
4227
|
# @!attribute [rw] events
|
4102
|
-
#
|
4228
|
+
# An object that contains a set of events associated with the
|
4229
|
+
# endpoint.
|
4103
4230
|
# @return [Hash<String,Types::Event>]
|
4104
4231
|
#
|
4105
4232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventsBatch AWS API Documentation
|
@@ -4110,7 +4237,7 @@ module Aws::Pinpoint
|
|
4110
4237
|
include Aws::Structure
|
4111
4238
|
end
|
4112
4239
|
|
4113
|
-
#
|
4240
|
+
# A set of events to process.
|
4114
4241
|
#
|
4115
4242
|
# @note When making an API call, you may pass EventsRequest
|
4116
4243
|
# data as a hash:
|
@@ -4180,9 +4307,8 @@ module Aws::Pinpoint
|
|
4180
4307
|
# }
|
4181
4308
|
#
|
4182
4309
|
# @!attribute [rw] batch_item
|
4183
|
-
#
|
4184
|
-
#
|
4185
|
-
# and a map of event Id's to events
|
4310
|
+
# A batch of events to process. Each BatchItem consists of an endpoint
|
4311
|
+
# ID as the key, and an EventsBatch object as the value.
|
4186
4312
|
# @return [Hash<String,Types::EventsBatch>]
|
4187
4313
|
#
|
4188
4314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventsRequest AWS API Documentation
|
@@ -4192,11 +4318,15 @@ module Aws::Pinpoint
|
|
4192
4318
|
include Aws::Structure
|
4193
4319
|
end
|
4194
4320
|
|
4195
|
-
#
|
4321
|
+
# Custom messages associated with events.
|
4196
4322
|
#
|
4197
4323
|
# @!attribute [rw] results
|
4198
|
-
# A map
|
4199
|
-
# endpoint
|
4324
|
+
# A map that contains a multipart response for each endpoint. Each
|
4325
|
+
# item in this object uses the endpoint ID as the key, and the item
|
4326
|
+
# response as the value. If no item response exists, the value can
|
4327
|
+
# also be one of the following: 202 (if the request was processed
|
4328
|
+
# successfully) or 400 (if the payload was invalid, or required fields
|
4329
|
+
# were missing).
|
4200
4330
|
# @return [Hash<String,Types::ItemResponse>]
|
4201
4331
|
#
|
4202
4332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventsResponse AWS API Documentation
|
@@ -5960,15 +6090,16 @@ module Aws::Pinpoint
|
|
5960
6090
|
include Aws::Structure
|
5961
6091
|
end
|
5962
6092
|
|
5963
|
-
# The
|
6093
|
+
# The response that's provided after registering the endpoint.
|
5964
6094
|
#
|
5965
6095
|
# @!attribute [rw] endpoint_item_response
|
5966
|
-
#
|
6096
|
+
# The response received after the endpoint was accepted.
|
5967
6097
|
# @return [Types::EndpointItemResponse]
|
5968
6098
|
#
|
5969
6099
|
# @!attribute [rw] events_item_response
|
5970
|
-
#
|
5971
|
-
#
|
6100
|
+
# A multipart response object that contains a key and value for each
|
6101
|
+
# event ID in the request. In each object, the event ID is the key,
|
6102
|
+
# and an EventItemResponse object is the value.
|
5972
6103
|
# @return [Hash<String,Types::EventItemResponse>]
|
5973
6104
|
#
|
5974
6105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ItemResponse AWS API Documentation
|
@@ -6357,6 +6488,32 @@ module Aws::Pinpoint
|
|
6357
6488
|
# title: "__string",
|
6358
6489
|
# url: "__string",
|
6359
6490
|
# },
|
6491
|
+
# email_message: {
|
6492
|
+
# body: "__string",
|
6493
|
+
# feedback_forwarding_address: "__string",
|
6494
|
+
# from_address: "__string",
|
6495
|
+
# raw_email: {
|
6496
|
+
# data: "data",
|
6497
|
+
# },
|
6498
|
+
# reply_to_addresses: ["__string"],
|
6499
|
+
# simple_email: {
|
6500
|
+
# html_part: {
|
6501
|
+
# charset: "__string",
|
6502
|
+
# data: "__string",
|
6503
|
+
# },
|
6504
|
+
# subject: {
|
6505
|
+
# charset: "__string",
|
6506
|
+
# data: "__string",
|
6507
|
+
# },
|
6508
|
+
# text_part: {
|
6509
|
+
# charset: "__string",
|
6510
|
+
# data: "__string",
|
6511
|
+
# },
|
6512
|
+
# },
|
6513
|
+
# substitutions: {
|
6514
|
+
# "__string" => ["__string"],
|
6515
|
+
# },
|
6516
|
+
# },
|
6360
6517
|
# gcm_message: {
|
6361
6518
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
6362
6519
|
# body: "__string",
|
@@ -6524,8 +6681,9 @@ module Aws::Pinpoint
|
|
6524
6681
|
# }
|
6525
6682
|
#
|
6526
6683
|
# @!attribute [rw] comparison_operator
|
6527
|
-
#
|
6528
|
-
# LESS\_THAN\_OR\_EQUAL
|
6684
|
+
# The operator that you're using to compare metric values. Possible
|
6685
|
+
# values: GREATER\_THAN, LESS\_THAN, GREATER\_THAN\_OR\_EQUAL,
|
6686
|
+
# LESS\_THAN\_OR\_EQUAL, or EQUAL
|
6529
6687
|
# @return [String]
|
6530
6688
|
#
|
6531
6689
|
# @!attribute [rw] value
|
@@ -6540,7 +6698,7 @@ module Aws::Pinpoint
|
|
6540
6698
|
include Aws::Structure
|
6541
6699
|
end
|
6542
6700
|
|
6543
|
-
# Phone Number
|
6701
|
+
# Phone Number Validate request.
|
6544
6702
|
#
|
6545
6703
|
# @note When making an API call, you may pass NumberValidateRequest
|
6546
6704
|
# data as a hash:
|
@@ -6570,7 +6728,7 @@ module Aws::Pinpoint
|
|
6570
6728
|
include Aws::Structure
|
6571
6729
|
end
|
6572
6730
|
|
6573
|
-
# Phone Number
|
6731
|
+
# Phone Number Validate response.
|
6574
6732
|
#
|
6575
6733
|
# @!attribute [rw] carrier
|
6576
6734
|
# The carrier or servive provider that the phone number is currently
|
@@ -6609,8 +6767,8 @@ module Aws::Pinpoint
|
|
6609
6767
|
# @return [String]
|
6610
6768
|
#
|
6611
6769
|
# @!attribute [rw] original_country_code_iso_2
|
6612
|
-
# The two-character
|
6613
|
-
#
|
6770
|
+
# The two-character code (in ISO 3166-1 alpha-2 format) for the
|
6771
|
+
# country or region in the request body.
|
6614
6772
|
# @return [String]
|
6615
6773
|
#
|
6616
6774
|
# @!attribute [rw] original_phone_number
|
@@ -6669,7 +6827,7 @@ module Aws::Pinpoint
|
|
6669
6827
|
# }
|
6670
6828
|
#
|
6671
6829
|
# @!attribute [rw] number_validate_request
|
6672
|
-
# Phone Number
|
6830
|
+
# Phone Number Validate request.
|
6673
6831
|
# @return [Types::NumberValidateRequest]
|
6674
6832
|
#
|
6675
6833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PhoneNumberValidateRequest AWS API Documentation
|
@@ -6680,7 +6838,7 @@ module Aws::Pinpoint
|
|
6680
6838
|
end
|
6681
6839
|
|
6682
6840
|
# @!attribute [rw] number_validate_response
|
6683
|
-
# Phone Number
|
6841
|
+
# Phone Number Validate response.
|
6684
6842
|
# @return [Types::NumberValidateResponse]
|
6685
6843
|
#
|
6686
6844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PhoneNumberValidateResponse AWS API Documentation
|
@@ -6736,7 +6894,7 @@ module Aws::Pinpoint
|
|
6736
6894
|
#
|
6737
6895
|
# @!attribute [rw] address
|
6738
6896
|
# The unique identifier for the recipient. For example, an address
|
6739
|
-
# could be a device token or
|
6897
|
+
# could be a device token, email address, or mobile phone number.
|
6740
6898
|
# @return [String]
|
6741
6899
|
#
|
6742
6900
|
# @!attribute [rw] attributes
|
@@ -6754,7 +6912,8 @@ module Aws::Pinpoint
|
|
6754
6912
|
# @return [Types::EndpointDemographic]
|
6755
6913
|
#
|
6756
6914
|
# @!attribute [rw] effective_date
|
6757
|
-
# The date and time when the endpoint was last updated
|
6915
|
+
# The date and time when the endpoint was last updated, in ISO 8601
|
6916
|
+
# format.
|
6758
6917
|
# @return [String]
|
6759
6918
|
#
|
6760
6919
|
# @!attribute [rw] endpoint_status
|
@@ -6915,7 +7074,7 @@ module Aws::Pinpoint
|
|
6915
7074
|
# @return [String]
|
6916
7075
|
#
|
6917
7076
|
# @!attribute [rw] events_request
|
6918
|
-
#
|
7077
|
+
# A set of events to process.
|
6919
7078
|
# @return [Types::EventsRequest]
|
6920
7079
|
#
|
6921
7080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventsRequest AWS API Documentation
|
@@ -6927,7 +7086,7 @@ module Aws::Pinpoint
|
|
6927
7086
|
end
|
6928
7087
|
|
6929
7088
|
# @!attribute [rw] events_response
|
6930
|
-
#
|
7089
|
+
# Custom messages associated with events.
|
6931
7090
|
# @return [Types::EventsResponse]
|
6932
7091
|
#
|
6933
7092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PutEventsResponse AWS API Documentation
|
@@ -6948,11 +7107,19 @@ module Aws::Pinpoint
|
|
6948
7107
|
# }
|
6949
7108
|
#
|
6950
7109
|
# @!attribute [rw] end
|
6951
|
-
# The
|
7110
|
+
# The time at which quiet time should end. The value that you specify
|
7111
|
+
# has to be in HH:mm format, where HH is the hour in 24-hour format
|
7112
|
+
# (with a leading zero, if applicable), and mm is the minutes. For
|
7113
|
+
# example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30
|
7114
|
+
# PM.
|
6952
7115
|
# @return [String]
|
6953
7116
|
#
|
6954
7117
|
# @!attribute [rw] start
|
6955
|
-
# The
|
7118
|
+
# The time at which quiet time should begin. The value that you
|
7119
|
+
# specify has to be in HH:mm format, where HH is the hour in 24-hour
|
7120
|
+
# format (with a leading zero, if applicable), and mm is the minutes.
|
7121
|
+
# For example, use 02:30 to represent 2:30 AM, or 14:30 to represent
|
7122
|
+
# 2:30 PM.
|
6956
7123
|
# @return [String]
|
6957
7124
|
#
|
6958
7125
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/QuietTime AWS API Documentation
|
@@ -6963,6 +7130,25 @@ module Aws::Pinpoint
|
|
6963
7130
|
include Aws::Structure
|
6964
7131
|
end
|
6965
7132
|
|
7133
|
+
# An email represented as a raw MIME message.
|
7134
|
+
#
|
7135
|
+
# @note When making an API call, you may pass RawEmail
|
7136
|
+
# data as a hash:
|
7137
|
+
#
|
7138
|
+
# {
|
7139
|
+
# data: "data",
|
7140
|
+
# }
|
7141
|
+
#
|
7142
|
+
# @!attribute [rw] data
|
7143
|
+
# @return [String]
|
7144
|
+
#
|
7145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RawEmail AWS API Documentation
|
7146
|
+
#
|
7147
|
+
class RawEmail < Struct.new(
|
7148
|
+
:data)
|
7149
|
+
include Aws::Structure
|
7150
|
+
end
|
7151
|
+
|
6966
7152
|
# Define how a segment based on recency of use.
|
6967
7153
|
#
|
6968
7154
|
# @note When making an API call, you may pass RecencyDimension
|
@@ -7553,6 +7739,10 @@ module Aws::Pinpoint
|
|
7553
7739
|
# dimensions to the segment, it filters the source segment based on
|
7554
7740
|
# the dimensions that you specify. You can specify more than one
|
7555
7741
|
# dimensional segment. You can only specify one imported segment.
|
7742
|
+
# NOTE: If you specify an imported segment for this attribute, the
|
7743
|
+
# segment size estimate that appears in the Amazon Pinpoint console
|
7744
|
+
# shows the size of the imported segment, without any filters applied
|
7745
|
+
# to it.
|
7556
7746
|
# @return [Array<Types::SegmentReference>]
|
7557
7747
|
#
|
7558
7748
|
# @!attribute [rw] source_type
|
@@ -7749,7 +7939,7 @@ module Aws::Pinpoint
|
|
7749
7939
|
# }
|
7750
7940
|
#
|
7751
7941
|
# @!attribute [rw] country
|
7752
|
-
# The country
|
7942
|
+
# The country or region, in ISO 3166-1 alpha-2 format.
|
7753
7943
|
# @return [Types::SetDimension]
|
7754
7944
|
#
|
7755
7945
|
# @!attribute [rw] gps_point
|
@@ -7996,6 +8186,32 @@ module Aws::Pinpoint
|
|
7996
8186
|
# title: "__string",
|
7997
8187
|
# url: "__string",
|
7998
8188
|
# },
|
8189
|
+
# email_message: {
|
8190
|
+
# body: "__string",
|
8191
|
+
# feedback_forwarding_address: "__string",
|
8192
|
+
# from_address: "__string",
|
8193
|
+
# raw_email: {
|
8194
|
+
# data: "data",
|
8195
|
+
# },
|
8196
|
+
# reply_to_addresses: ["__string"],
|
8197
|
+
# simple_email: {
|
8198
|
+
# html_part: {
|
8199
|
+
# charset: "__string",
|
8200
|
+
# data: "__string",
|
8201
|
+
# },
|
8202
|
+
# subject: {
|
8203
|
+
# charset: "__string",
|
8204
|
+
# data: "__string",
|
8205
|
+
# },
|
8206
|
+
# text_part: {
|
8207
|
+
# charset: "__string",
|
8208
|
+
# data: "__string",
|
8209
|
+
# },
|
8210
|
+
# },
|
8211
|
+
# substitutions: {
|
8212
|
+
# "__string" => ["__string"],
|
8213
|
+
# },
|
8214
|
+
# },
|
7999
8215
|
# gcm_message: {
|
8000
8216
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8001
8217
|
# body: "__string",
|
@@ -8154,6 +8370,32 @@ module Aws::Pinpoint
|
|
8154
8370
|
# title: "__string",
|
8155
8371
|
# url: "__string",
|
8156
8372
|
# },
|
8373
|
+
# email_message: {
|
8374
|
+
# body: "__string",
|
8375
|
+
# feedback_forwarding_address: "__string",
|
8376
|
+
# from_address: "__string",
|
8377
|
+
# raw_email: {
|
8378
|
+
# data: "data",
|
8379
|
+
# },
|
8380
|
+
# reply_to_addresses: ["__string"],
|
8381
|
+
# simple_email: {
|
8382
|
+
# html_part: {
|
8383
|
+
# charset: "__string",
|
8384
|
+
# data: "__string",
|
8385
|
+
# },
|
8386
|
+
# subject: {
|
8387
|
+
# charset: "__string",
|
8388
|
+
# data: "__string",
|
8389
|
+
# },
|
8390
|
+
# text_part: {
|
8391
|
+
# charset: "__string",
|
8392
|
+
# data: "__string",
|
8393
|
+
# },
|
8394
|
+
# },
|
8395
|
+
# substitutions: {
|
8396
|
+
# "__string" => ["__string"],
|
8397
|
+
# },
|
8398
|
+
# },
|
8157
8399
|
# gcm_message: {
|
8158
8400
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8159
8401
|
# body: "__string",
|
@@ -8359,6 +8601,32 @@ module Aws::Pinpoint
|
|
8359
8601
|
# title: "__string",
|
8360
8602
|
# url: "__string",
|
8361
8603
|
# },
|
8604
|
+
# email_message: {
|
8605
|
+
# body: "__string",
|
8606
|
+
# feedback_forwarding_address: "__string",
|
8607
|
+
# from_address: "__string",
|
8608
|
+
# raw_email: {
|
8609
|
+
# data: "data",
|
8610
|
+
# },
|
8611
|
+
# reply_to_addresses: ["__string"],
|
8612
|
+
# simple_email: {
|
8613
|
+
# html_part: {
|
8614
|
+
# charset: "__string",
|
8615
|
+
# data: "__string",
|
8616
|
+
# },
|
8617
|
+
# subject: {
|
8618
|
+
# charset: "__string",
|
8619
|
+
# data: "__string",
|
8620
|
+
# },
|
8621
|
+
# text_part: {
|
8622
|
+
# charset: "__string",
|
8623
|
+
# data: "__string",
|
8624
|
+
# },
|
8625
|
+
# },
|
8626
|
+
# substitutions: {
|
8627
|
+
# "__string" => ["__string"],
|
8628
|
+
# },
|
8629
|
+
# },
|
8362
8630
|
# gcm_message: {
|
8363
8631
|
# action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
|
8364
8632
|
# body: "__string",
|
@@ -8449,7 +8717,7 @@ module Aws::Pinpoint
|
|
8449
8717
|
# }
|
8450
8718
|
#
|
8451
8719
|
# @!attribute [rw] duration
|
8452
|
-
#
|
8720
|
+
# The duration of the session, in milliseconds.
|
8453
8721
|
# @return [Integer]
|
8454
8722
|
#
|
8455
8723
|
# @!attribute [rw] id
|
@@ -8504,6 +8772,78 @@ module Aws::Pinpoint
|
|
8504
8772
|
include Aws::Structure
|
8505
8773
|
end
|
8506
8774
|
|
8775
|
+
# An email composed of a subject, a text part and a html part.
|
8776
|
+
#
|
8777
|
+
# @note When making an API call, you may pass SimpleEmail
|
8778
|
+
# data as a hash:
|
8779
|
+
#
|
8780
|
+
# {
|
8781
|
+
# html_part: {
|
8782
|
+
# charset: "__string",
|
8783
|
+
# data: "__string",
|
8784
|
+
# },
|
8785
|
+
# subject: {
|
8786
|
+
# charset: "__string",
|
8787
|
+
# data: "__string",
|
8788
|
+
# },
|
8789
|
+
# text_part: {
|
8790
|
+
# charset: "__string",
|
8791
|
+
# data: "__string",
|
8792
|
+
# },
|
8793
|
+
# }
|
8794
|
+
#
|
8795
|
+
# @!attribute [rw] html_part
|
8796
|
+
# The content of the message, in HTML format. Use this for email
|
8797
|
+
# clients that can process HTML. You can include clickable links,
|
8798
|
+
# formatted text, and much more in an HTML message.
|
8799
|
+
# @return [Types::SimpleEmailPart]
|
8800
|
+
#
|
8801
|
+
# @!attribute [rw] subject
|
8802
|
+
# The subject of the message: A short summary of the content, which
|
8803
|
+
# will appear in the recipient's inbox.
|
8804
|
+
# @return [Types::SimpleEmailPart]
|
8805
|
+
#
|
8806
|
+
# @!attribute [rw] text_part
|
8807
|
+
# The content of the message, in text format. Use this for text-based
|
8808
|
+
# email clients, or clients on high-latency networks (such as mobile
|
8809
|
+
# devices).
|
8810
|
+
# @return [Types::SimpleEmailPart]
|
8811
|
+
#
|
8812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SimpleEmail AWS API Documentation
|
8813
|
+
#
|
8814
|
+
class SimpleEmail < Struct.new(
|
8815
|
+
:html_part,
|
8816
|
+
:subject,
|
8817
|
+
:text_part)
|
8818
|
+
include Aws::Structure
|
8819
|
+
end
|
8820
|
+
|
8821
|
+
# Textual email data, plus an optional character set specification.
|
8822
|
+
#
|
8823
|
+
# @note When making an API call, you may pass SimpleEmailPart
|
8824
|
+
# data as a hash:
|
8825
|
+
#
|
8826
|
+
# {
|
8827
|
+
# charset: "__string",
|
8828
|
+
# data: "__string",
|
8829
|
+
# }
|
8830
|
+
#
|
8831
|
+
# @!attribute [rw] charset
|
8832
|
+
# The character set of the content.
|
8833
|
+
# @return [String]
|
8834
|
+
#
|
8835
|
+
# @!attribute [rw] data
|
8836
|
+
# The textual data of the content.
|
8837
|
+
# @return [String]
|
8838
|
+
#
|
8839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/SimpleEmailPart AWS API Documentation
|
8840
|
+
#
|
8841
|
+
class SimpleEmailPart < Struct.new(
|
8842
|
+
:charset,
|
8843
|
+
:data)
|
8844
|
+
include Aws::Structure
|
8845
|
+
end
|
8846
|
+
|
8507
8847
|
# Treatment resource
|
8508
8848
|
#
|
8509
8849
|
# @!attribute [rw] id
|
@@ -9126,6 +9466,7 @@ module Aws::Pinpoint
|
|
9126
9466
|
# {
|
9127
9467
|
# application_id: "__string", # required
|
9128
9468
|
# email_channel_request: { # required
|
9469
|
+
# configuration_set: "__string",
|
9129
9470
|
# enabled: false,
|
9130
9471
|
# from_address: "__string",
|
9131
9472
|
# identity: "__string",
|
@@ -9212,7 +9553,7 @@ module Aws::Pinpoint
|
|
9212
9553
|
# @return [String]
|
9213
9554
|
#
|
9214
9555
|
# @!attribute [rw] endpoint_request
|
9215
|
-
#
|
9556
|
+
# An endpoint update request.
|
9216
9557
|
# @return [Types::EndpointRequest]
|
9217
9558
|
#
|
9218
9559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateEndpointRequest AWS API Documentation
|
@@ -9607,9 +9948,9 @@ module Aws::Pinpoint
|
|
9607
9948
|
# @return [Boolean]
|
9608
9949
|
#
|
9609
9950
|
# @!attribute [rw] limits
|
9610
|
-
# The
|
9611
|
-
#
|
9612
|
-
#
|
9951
|
+
# The limits that apply to each campaign in the project by default.
|
9952
|
+
# Campaigns can also have their own limits, which override the
|
9953
|
+
# settings at the project level.
|
9613
9954
|
# @return [Types::CampaignLimits]
|
9614
9955
|
#
|
9615
9956
|
# @!attribute [rw] quiet_time
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-pinpoint
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.12.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-11-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|