aws-sdk-pinpoint 1.33.0 → 1.34.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -115,6 +115,27 @@ module Aws::Pinpoint
115
115
 
116
116
  end
117
117
 
118
+ class PayloadTooLargeException < ServiceError
119
+
120
+ # @param [Seahorse::Client::RequestContext] context
121
+ # @param [String] message
122
+ # @param [Aws::Pinpoint::Types::PayloadTooLargeException] data
123
+ def initialize(context, message, data = Aws::EmptyStructure.new)
124
+ super(context, message, data)
125
+ end
126
+
127
+ # @return [String]
128
+ def message
129
+ @message || @data[:message]
130
+ end
131
+
132
+ # @return [String]
133
+ def request_id
134
+ @data[:request_id]
135
+ end
136
+
137
+ end
138
+
118
139
  class TooManyRequestsException < ServiceError
119
140
 
120
141
  # @param [Seahorse::Client::RequestContext] context
@@ -1637,10 +1637,11 @@ module Aws::Pinpoint
1637
1637
  #
1638
1638
  # @!attribute [rw] context
1639
1639
  # An object that maps custom attributes to attributes for the address
1640
- # and is attached to the message. For a push notification, this
1641
- # payload is added to the data.pinpoint object. For an email or text
1642
- # message, this payload is added to email/SMS delivery receipt event
1643
- # attributes.
1640
+ # and is attached to the message. Attribute names are case sensitive.
1641
+ #
1642
+ # For a push notification, this payload is added to the data.pinpoint
1643
+ # object. For an email or text message, this payload is added to
1644
+ # email/SMS delivery receipt event attributes.
1644
1645
  # @return [Hash<String,String>]
1645
1646
  #
1646
1647
  # @!attribute [rw] raw_content
@@ -1750,7 +1751,7 @@ module Aws::Pinpoint
1750
1751
  #
1751
1752
  # @!attribute [rw] url
1752
1753
  # The URL to open in a recipient's default mobile browser, if a
1753
- # recipient taps a a push notification that's based on the message
1754
+ # recipient taps a push notification that's based on the message
1754
1755
  # template and the value of the Action property is URL.
1755
1756
  # @return [String]
1756
1757
  #
@@ -2419,7 +2420,7 @@ module Aws::Pinpoint
2419
2420
  # ENDPOINT, sends the campaign when an endpoint event (<link
2420
2421
  # linkend="apps-application-id-events" />
2421
2422
  #
2422
- # Events resource</link>) occurs.
2423
+ # Events</link> resource) occurs.
2423
2424
  # @return [String]
2424
2425
  #
2425
2426
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignEventFilter AWS API Documentation
@@ -3466,6 +3467,7 @@ module Aws::Pinpoint
3466
3467
  # email_template_request: { # required
3467
3468
  # default_substitutions: "__string",
3468
3469
  # html_part: "__string",
3470
+ # recommender_id: "__string",
3469
3471
  # subject: "__string",
3470
3472
  # tags: {
3471
3473
  # "__string" => "__string",
@@ -3952,6 +3954,7 @@ module Aws::Pinpoint
3952
3954
  # title: "__string",
3953
3955
  # url: "__string",
3954
3956
  # },
3957
+ # recommender_id: "__string",
3955
3958
  # tags: {
3956
3959
  # "__string" => "__string",
3957
3960
  # },
@@ -3988,6 +3991,191 @@ module Aws::Pinpoint
3988
3991
  include Aws::Structure
3989
3992
  end
3990
3993
 
3994
+ # Specifies Amazon Pinpoint configuration settings for retrieving and
3995
+ # processing recommendation data from a recommender model.
3996
+ #
3997
+ # @note When making an API call, you may pass CreateRecommenderConfiguration
3998
+ # data as a hash:
3999
+ #
4000
+ # {
4001
+ # attributes: {
4002
+ # "__string" => "__string",
4003
+ # },
4004
+ # description: "__string",
4005
+ # name: "__string",
4006
+ # recommendation_provider_id_type: "__string",
4007
+ # recommendation_provider_role_arn: "__string", # required
4008
+ # recommendation_provider_uri: "__string", # required
4009
+ # recommendation_transformer_uri: "__string",
4010
+ # recommendations_display_name: "__string",
4011
+ # recommendations_per_message: 1,
4012
+ # }
4013
+ #
4014
+ # @!attribute [rw] attributes
4015
+ # A map of key-value pairs that defines 1-10 custom endpoint or user
4016
+ # attributes, depending on the value for the RecommenderUserIdType
4017
+ # property. Each of these attributes temporarily stores a recommended
4018
+ # item that's retrieved from the recommender model and sent to an AWS
4019
+ # Lambda function for additional processing. Each attribute can be
4020
+ # used as a message variable in a message template.
4021
+ #
4022
+ # In the map, the key is the name of a custom attribute and the value
4023
+ # is a custom display name for that attribute. The display name
4024
+ # appears in the **Attribute finder** pane of the template editor on
4025
+ # the Amazon Pinpoint console. The following restrictions apply to
4026
+ # these names:
4027
+ #
4028
+ # * An attribute name must start with a letter or number and it can
4029
+ # contain up to 50 characters. The characters can be letters,
4030
+ # numbers, underscores (\_), or hyphens (-). Attribute names are
4031
+ # case sensitive and must be unique.
4032
+ #
4033
+ # * An attribute display name must start with a letter or number and
4034
+ # it can contain up to 25 characters. The characters can be letters,
4035
+ # numbers, spaces, underscores (\_), or hyphens (-).
4036
+ #
4037
+ # This object is required if the configuration invokes an AWS Lambda
4038
+ # function (LambdaFunctionArn) to process recommendation data.
4039
+ # Otherwise, don't include this object in your request.
4040
+ # @return [Hash<String,String>]
4041
+ #
4042
+ # @!attribute [rw] description
4043
+ # A custom description of the configuration for the recommender model.
4044
+ # The description can contain up to 128 characters.
4045
+ # @return [String]
4046
+ #
4047
+ # @!attribute [rw] name
4048
+ # A custom name of the configuration for the recommender model. The
4049
+ # name must start with a letter or number and it can contain up to 128
4050
+ # characters. The characters can be letters, numbers, spaces,
4051
+ # underscores (\_), or hyphens (-).
4052
+ # @return [String]
4053
+ #
4054
+ # @!attribute [rw] recommendation_provider_id_type
4055
+ # The type of Amazon Pinpoint ID to associate with unique user IDs in
4056
+ # the recommender model. This value enables the model to use attribute
4057
+ # and event data that’s specific to a particular endpoint or user in
4058
+ # an Amazon Pinpoint application. Valid values are:
4059
+ #
4060
+ # * PINPOINT\_ENDPOINT\_ID - Associate each user in the model with a
4061
+ # particular endpoint in Amazon Pinpoint. The data is correlated
4062
+ # based on endpoint IDs in Amazon Pinpoint. This is the default
4063
+ # value.
4064
+ #
4065
+ # * PINPOINT\_USER\_ID - Associate each user in the model with a
4066
+ # particular user and endpoint in Amazon Pinpoint. The data is
4067
+ # correlated based on user IDs in Amazon Pinpoint. If you specify
4068
+ # this value, an endpoint definition in Amazon Pinpoint has to
4069
+ # specify a both a user ID (UserId) and an endpoint ID. Otherwise,
4070
+ # messages won’t be sent to the user's endpoint.
4071
+ # @return [String]
4072
+ #
4073
+ # @!attribute [rw] recommendation_provider_role_arn
4074
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
4075
+ # Management (IAM) role that authorizes Amazon Pinpoint to retrieve
4076
+ # recommendation data from the recommender model.
4077
+ # @return [String]
4078
+ #
4079
+ # @!attribute [rw] recommendation_provider_uri
4080
+ # The Amazon Resource Name (ARN) of the recommender model to retrieve
4081
+ # recommendation data from. This value must match the ARN of an Amazon
4082
+ # Personalize campaign.
4083
+ # @return [String]
4084
+ #
4085
+ # @!attribute [rw] recommendation_transformer_uri
4086
+ # The name or Amazon Resource Name (ARN) of the AWS Lambda function to
4087
+ # invoke for additional processing of recommendation data that's
4088
+ # retrieved from the recommender model.
4089
+ # @return [String]
4090
+ #
4091
+ # @!attribute [rw] recommendations_display_name
4092
+ # A custom display name for the standard endpoint or user attribute
4093
+ # (RecommendationItems) that temporarily stores a recommended item for
4094
+ # each endpoint or user, depending on the value for the
4095
+ # RecommenderUserIdType property. This value is required if the
4096
+ # configuration doesn't invoke an AWS Lambda function
4097
+ # (LambdaFunctionArn) to perform additional processing of
4098
+ # recommendation data.
4099
+ #
4100
+ # This name appears in the **Attribute finder** pane of the template
4101
+ # editor on the Amazon Pinpoint console. The name can contain up to 25
4102
+ # characters. The characters can be letters, numbers, spaces,
4103
+ # underscores (\_), or hyphens (-). These restrictions don't apply to
4104
+ # attribute values.
4105
+ # @return [String]
4106
+ #
4107
+ # @!attribute [rw] recommendations_per_message
4108
+ # The number of recommended items to retrieve from the model for each
4109
+ # endpoint or user, depending on the value for the
4110
+ # RecommenderUserIdType property. This number determines how many
4111
+ # recommended attributes are available for use as message variables in
4112
+ # message templates. The minimum value is 1. The maximum value is 5.
4113
+ # The default value is 5.
4114
+ #
4115
+ # To use multiple recommended items and custom attributes with message
4116
+ # variables, you have to use an AWS Lambda function
4117
+ # (LambdaFunctionArn) to perform additional processing of
4118
+ # recommendation data.
4119
+ # @return [Integer]
4120
+ #
4121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateRecommenderConfiguration AWS API Documentation
4122
+ #
4123
+ class CreateRecommenderConfiguration < Struct.new(
4124
+ :attributes,
4125
+ :description,
4126
+ :name,
4127
+ :recommendation_provider_id_type,
4128
+ :recommendation_provider_role_arn,
4129
+ :recommendation_provider_uri,
4130
+ :recommendation_transformer_uri,
4131
+ :recommendations_display_name,
4132
+ :recommendations_per_message)
4133
+ include Aws::Structure
4134
+ end
4135
+
4136
+ # @note When making an API call, you may pass CreateRecommenderConfigurationRequest
4137
+ # data as a hash:
4138
+ #
4139
+ # {
4140
+ # create_recommender_configuration: { # required
4141
+ # attributes: {
4142
+ # "__string" => "__string",
4143
+ # },
4144
+ # description: "__string",
4145
+ # name: "__string",
4146
+ # recommendation_provider_id_type: "__string",
4147
+ # recommendation_provider_role_arn: "__string", # required
4148
+ # recommendation_provider_uri: "__string", # required
4149
+ # recommendation_transformer_uri: "__string",
4150
+ # recommendations_display_name: "__string",
4151
+ # recommendations_per_message: 1,
4152
+ # },
4153
+ # }
4154
+ #
4155
+ # @!attribute [rw] create_recommender_configuration
4156
+ # Specifies Amazon Pinpoint configuration settings for retrieving and
4157
+ # processing recommendation data from a recommender model.
4158
+ # @return [Types::CreateRecommenderConfiguration]
4159
+ #
4160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateRecommenderConfigurationRequest AWS API Documentation
4161
+ #
4162
+ class CreateRecommenderConfigurationRequest < Struct.new(
4163
+ :create_recommender_configuration)
4164
+ include Aws::Structure
4165
+ end
4166
+
4167
+ # @!attribute [rw] recommender_configuration_response
4168
+ # Provides information about Amazon Pinpoint configuration settings
4169
+ # for retrieving and processing data from a recommender model.
4170
+ # @return [Types::RecommenderConfigurationResponse]
4171
+ #
4172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CreateRecommenderConfigurationResponse AWS API Documentation
4173
+ #
4174
+ class CreateRecommenderConfigurationResponse < Struct.new(
4175
+ :recommender_configuration_response)
4176
+ include Aws::Structure
4177
+ end
4178
+
3991
4179
  # @note When making an API call, you may pass CreateSegmentRequest
3992
4180
  # data as a hash:
3993
4181
  #
@@ -4184,6 +4372,7 @@ module Aws::Pinpoint
4184
4372
  # sms_template_request: { # required
4185
4373
  # body: "__string",
4186
4374
  # default_substitutions: "__string",
4375
+ # recommender_id: "__string",
4187
4376
  # tags: {
4188
4377
  # "__string" => "__string",
4189
4378
  # },
@@ -4934,6 +5123,35 @@ module Aws::Pinpoint
4934
5123
  include Aws::Structure
4935
5124
  end
4936
5125
 
5126
+ # @note When making an API call, you may pass DeleteRecommenderConfigurationRequest
5127
+ # data as a hash:
5128
+ #
5129
+ # {
5130
+ # recommender_id: "__string", # required
5131
+ # }
5132
+ #
5133
+ # @!attribute [rw] recommender_id
5134
+ # @return [String]
5135
+ #
5136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteRecommenderConfigurationRequest AWS API Documentation
5137
+ #
5138
+ class DeleteRecommenderConfigurationRequest < Struct.new(
5139
+ :recommender_id)
5140
+ include Aws::Structure
5141
+ end
5142
+
5143
+ # @!attribute [rw] recommender_configuration_response
5144
+ # Provides information about Amazon Pinpoint configuration settings
5145
+ # for retrieving and processing data from a recommender model.
5146
+ # @return [Types::RecommenderConfigurationResponse]
5147
+ #
5148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/DeleteRecommenderConfigurationResponse AWS API Documentation
5149
+ #
5150
+ class DeleteRecommenderConfigurationResponse < Struct.new(
5151
+ :recommender_configuration_response)
5152
+ include Aws::Structure
5153
+ end
5154
+
4937
5155
  # @note When making an API call, you may pass DeleteSegmentRequest
4938
5156
  # data as a hash:
4939
5157
  #
@@ -5620,7 +5838,7 @@ module Aws::Pinpoint
5620
5838
  # Template Versions</link> resource.
5621
5839
  #
5622
5840
  # If you don't specify a value for this property, Amazon Pinpoint
5623
- # uses the *active* version of the template. The *active* version is
5841
+ # uses the *active version* of the template. The *active version* is
5624
5842
  # typically the version of a template that's been most recently
5625
5843
  # reviewed and approved for use, depending on your workflow. It isn't
5626
5844
  # necessarily the latest version of a template.
@@ -5645,6 +5863,7 @@ module Aws::Pinpoint
5645
5863
  # {
5646
5864
  # default_substitutions: "__string",
5647
5865
  # html_part: "__string",
5866
+ # recommender_id: "__string",
5648
5867
  # subject: "__string",
5649
5868
  # tags: {
5650
5869
  # "__string" => "__string",
@@ -5670,6 +5889,14 @@ module Aws::Pinpoint
5670
5889
  # formatted text, and more in an HTML message.
5671
5890
  # @return [String]
5672
5891
  #
5892
+ # @!attribute [rw] recommender_id
5893
+ # The unique identifier for the recommender model to use for the
5894
+ # message template. Amazon Pinpoint uses this value to determine how
5895
+ # to retrieve and process data from a recommender model when it sends
5896
+ # messages that use the template, if the template contains message
5897
+ # variables for recommendation data.
5898
+ # @return [String]
5899
+ #
5673
5900
  # @!attribute [rw] subject
5674
5901
  # The subject line, or title, to use in email messages that are based
5675
5902
  # on the message template.
@@ -5698,6 +5925,7 @@ module Aws::Pinpoint
5698
5925
  class EmailTemplateRequest < Struct.new(
5699
5926
  :default_substitutions,
5700
5927
  :html_part,
5928
+ :recommender_id,
5701
5929
  :subject,
5702
5930
  :tags,
5703
5931
  :template_description,
@@ -5735,6 +5963,11 @@ module Aws::Pinpoint
5735
5963
  # modified.
5736
5964
  # @return [String]
5737
5965
  #
5966
+ # @!attribute [rw] recommender_id
5967
+ # The unique identifier for the recommender model that's used by the
5968
+ # message template.
5969
+ # @return [String]
5970
+ #
5738
5971
  # @!attribute [rw] subject
5739
5972
  # The subject line, or title, that's used in email messages that are
5740
5973
  # based on the message template.
@@ -5778,6 +6011,7 @@ module Aws::Pinpoint
5778
6011
  :default_substitutions,
5779
6012
  :html_part,
5780
6013
  :last_modified_date,
6014
+ :recommender_id,
5781
6015
  :subject,
5782
6016
  :tags,
5783
6017
  :template_description,
@@ -5847,15 +6081,18 @@ module Aws::Pinpoint
5847
6081
  # @!attribute [rw] attributes
5848
6082
  # One or more custom attributes that describe the endpoint by
5849
6083
  # associating a name with an array of values. For example, the value
5850
- # of a custom attribute named Interests might be: \["science",
5851
- # "music", "travel"\]. You can use these attributes as filter
5852
- # criteria when you create segments.
5853
- #
5854
- # When you define the name of a custom attribute, avoid using the
5855
- # following characters: number sign (#), colon (:), question mark (?),
5856
- # backslash (\\), and slash (/). The Amazon Pinpoint console can't
5857
- # display attribute names that contain these characters. This
5858
- # limitation doesn't apply to attribute values.
6084
+ # of a custom attribute named Interests might be: \["Science",
6085
+ # "Music", "Travel"\]. You can use these attributes as filter
6086
+ # criteria when you create segments. Attribute names are case
6087
+ # sensitive.
6088
+ #
6089
+ # An attribute name can contain up to 50 characters. An attribute
6090
+ # value can contain up to 100 characters. When you define the name of
6091
+ # a custom attribute, avoid using the following characters: number
6092
+ # sign (#), colon (:), question mark (?), backslash (\\), and slash
6093
+ # (/). The Amazon Pinpoint console can't display attribute names that
6094
+ # contain these characters. This restriction doesn't apply to
6095
+ # attribute values.
5859
6096
  # @return [Hash<String,Array<String>>]
5860
6097
  #
5861
6098
  # @!attribute [rw] channel_type
@@ -5913,8 +6150,8 @@ module Aws::Pinpoint
5913
6150
  # @return [String]
5914
6151
  #
5915
6152
  # @!attribute [rw] user
5916
- # One or more custom user attributes that your app reports to Amazon
5917
- # Pinpoint for the user who's associated with the endpoint.
6153
+ # One or more custom user attributes that describe the user who's
6154
+ # associated with the endpoint.
5918
6155
  # @return [Types::EndpointUser]
5919
6156
  #
5920
6157
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EndpointBatchItem AWS API Documentation
@@ -6167,7 +6404,7 @@ module Aws::Pinpoint
6167
6404
  # endpoint.
6168
6405
  #
6169
6406
  # * TEMPORARY\_FAILURE - A temporary error occurred. Amazon Pinpoint
6170
- # will attempt to deliver the message again later.
6407
+ # won't attempt to send the message again.
6171
6408
  #
6172
6409
  # * THROTTLED - Amazon Pinpoint throttled the operation to send the
6173
6410
  # message to the endpoint.
@@ -6264,15 +6501,18 @@ module Aws::Pinpoint
6264
6501
  # @!attribute [rw] attributes
6265
6502
  # One or more custom attributes that describe the endpoint by
6266
6503
  # associating a name with an array of values. For example, the value
6267
- # of a custom attribute named Interests might be: \["science",
6268
- # "music", "travel"\]. You can use these attributes as filter
6269
- # criteria when you create segments.
6270
- #
6271
- # When you define the name of a custom attribute, avoid using the
6272
- # following characters: number sign (#), colon (:), question mark (?),
6273
- # backslash (\\), and slash (/). The Amazon Pinpoint console can't
6274
- # display attribute names that contain these characters. This
6275
- # limitation doesn't apply to attribute values.
6504
+ # of a custom attribute named Interests might be: \["Science",
6505
+ # "Music", "Travel"\]. You can use these attributes as filter
6506
+ # criteria when you create segments. Attribute names are case
6507
+ # sensitive.
6508
+ #
6509
+ # An attribute name can contain up to 50 characters. An attribute
6510
+ # value can contain up to 100 characters. When you define the name of
6511
+ # a custom attribute, avoid using the following characters: number
6512
+ # sign (#), colon (:), question mark (?), backslash (\\), and slash
6513
+ # (/). The Amazon Pinpoint console can't display attribute names that
6514
+ # contain these characters. This restriction doesn't apply to
6515
+ # attribute values.
6276
6516
  # @return [Hash<String,Array<String>>]
6277
6517
  #
6278
6518
  # @!attribute [rw] channel_type
@@ -6368,8 +6608,8 @@ module Aws::Pinpoint
6368
6608
  # @!attribute [rw] attributes
6369
6609
  # One or more custom attributes that describe the endpoint by
6370
6610
  # associating a name with an array of values. For example, the value
6371
- # of a custom attribute named Interests might be: \["science",
6372
- # "music", "travel"\]. You can use these attributes as filter
6611
+ # of a custom attribute named Interests might be: \["Science",
6612
+ # "Music", "Travel"\]. You can use these attributes as filter
6373
6613
  # criteria when you create segments.
6374
6614
  # @return [Hash<String,Array<String>>]
6375
6615
  #
@@ -6494,6 +6734,8 @@ module Aws::Pinpoint
6494
6734
  #
6495
6735
  # @!attribute [rw] context
6496
6736
  # A map of custom attributes to attach to the message for the address.
6737
+ # Attribute names are case sensitive.
6738
+ #
6497
6739
  # For a push notification, this payload is added to the data.pinpoint
6498
6740
  # object. For an email or text message, this payload is added to
6499
6741
  # email/SMS delivery receipt event attributes.
@@ -6544,15 +6786,17 @@ module Aws::Pinpoint
6544
6786
  # @!attribute [rw] user_attributes
6545
6787
  # One or more custom attributes that describe the user by associating
6546
6788
  # a name with an array of values. For example, the value of an
6547
- # attribute named Interests might be: \["science", "music",
6548
- # "travel"\]. You can use these attributes as filter criteria when
6549
- # you create segments.
6550
- #
6551
- # When you define the name of a custom attribute, avoid using the
6552
- # following characters: number sign (#), colon (:), question mark (?),
6553
- # backslash (\\), and slash (/). The Amazon Pinpoint console can't
6554
- # display attribute names that contain these characters. This
6555
- # limitation doesn't apply to attribute values.
6789
+ # attribute named Interests might be: \["Science", "Music",
6790
+ # "Travel"\]. You can use these attributes as filter criteria when
6791
+ # you create segments. Attribute names are case sensitive.
6792
+ #
6793
+ # An attribute name can contain up to 50 characters. An attribute
6794
+ # value can contain up to 100 characters. When you define the name of
6795
+ # a custom attribute, avoid using the following characters: number
6796
+ # sign (#), colon (:), question mark (?), backslash (\\), and slash
6797
+ # (/). The Amazon Pinpoint console can't display attribute names that
6798
+ # contain these characters. This restriction doesn't apply to
6799
+ # attribute values.
6556
6800
  # @return [Hash<String,Array<String>>]
6557
6801
  #
6558
6802
  # @!attribute [rw] user_id
@@ -6744,9 +6988,15 @@ module Aws::Pinpoint
6744
6988
  #
6745
6989
  # @!attribute [rw] event_type
6746
6990
  # The name of the event that causes the campaign to be sent or the
6747
- # journey activity to be performed. This can be a standard type of
6748
- # event that Amazon Pinpoint generates, such as \_email.delivered, or
6749
- # a custom event that's specific to your application.
6991
+ # journey activity to be performed. This can be a standard event that
6992
+ # Amazon Pinpoint generates, such as \_email.delivered. For campaigns,
6993
+ # this can also be a custom event that's specific to your
6994
+ # application. For information about standard events, see [Streaming
6995
+ # Amazon Pinpoint Events][1] in the *Amazon Pinpoint Developer Guide*.
6996
+ #
6997
+ #
6998
+ #
6999
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html
6750
7000
  # @return [Types::SetDimension]
6751
7001
  #
6752
7002
  # @!attribute [rw] metrics
@@ -8751,6 +9001,69 @@ module Aws::Pinpoint
8751
9001
  include Aws::Structure
8752
9002
  end
8753
9003
 
9004
+ # @note When making an API call, you may pass GetRecommenderConfigurationRequest
9005
+ # data as a hash:
9006
+ #
9007
+ # {
9008
+ # recommender_id: "__string", # required
9009
+ # }
9010
+ #
9011
+ # @!attribute [rw] recommender_id
9012
+ # @return [String]
9013
+ #
9014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetRecommenderConfigurationRequest AWS API Documentation
9015
+ #
9016
+ class GetRecommenderConfigurationRequest < Struct.new(
9017
+ :recommender_id)
9018
+ include Aws::Structure
9019
+ end
9020
+
9021
+ # @!attribute [rw] recommender_configuration_response
9022
+ # Provides information about Amazon Pinpoint configuration settings
9023
+ # for retrieving and processing data from a recommender model.
9024
+ # @return [Types::RecommenderConfigurationResponse]
9025
+ #
9026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetRecommenderConfigurationResponse AWS API Documentation
9027
+ #
9028
+ class GetRecommenderConfigurationResponse < Struct.new(
9029
+ :recommender_configuration_response)
9030
+ include Aws::Structure
9031
+ end
9032
+
9033
+ # @note When making an API call, you may pass GetRecommenderConfigurationsRequest
9034
+ # data as a hash:
9035
+ #
9036
+ # {
9037
+ # page_size: "__string",
9038
+ # token: "__string",
9039
+ # }
9040
+ #
9041
+ # @!attribute [rw] page_size
9042
+ # @return [String]
9043
+ #
9044
+ # @!attribute [rw] token
9045
+ # @return [String]
9046
+ #
9047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetRecommenderConfigurationsRequest AWS API Documentation
9048
+ #
9049
+ class GetRecommenderConfigurationsRequest < Struct.new(
9050
+ :page_size,
9051
+ :token)
9052
+ include Aws::Structure
9053
+ end
9054
+
9055
+ # @!attribute [rw] list_recommender_configurations_response
9056
+ # Provides information about all the recommender model configurations
9057
+ # that are associated with your Amazon Pinpoint account.
9058
+ # @return [Types::ListRecommenderConfigurationsResponse]
9059
+ #
9060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetRecommenderConfigurationsResponse AWS API Documentation
9061
+ #
9062
+ class GetRecommenderConfigurationsResponse < Struct.new(
9063
+ :list_recommender_configurations_response)
9064
+ include Aws::Structure
9065
+ end
9066
+
8754
9067
  # @note When making an API call, you may pass GetSegmentExportJobsRequest
8755
9068
  # data as a hash:
8756
9069
  #
@@ -9269,8 +9582,8 @@ module Aws::Pinpoint
9269
9582
  # @return [String]
9270
9583
  #
9271
9584
  # @!attribute [rw] segment_name
9272
- # The custom name for the segment that's created by the import job,
9273
- # if the value of the DefineSegment property is true.
9585
+ # A custom name for the segment that's created by the import job, if
9586
+ # the value of the DefineSegment property is true.
9274
9587
  # @return [String]
9275
9588
  #
9276
9589
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ImportJobRequest AWS API Documentation
@@ -9864,9 +10177,7 @@ module Aws::Pinpoint
9864
10177
  # @return [String]
9865
10178
  #
9866
10179
  # @!attribute [rw] tags
9867
- # A string-to-string map of key-value pairs that identifies the tags
9868
- # that are associated with the journey. Each tag consists of a
9869
- # required tag key and an associated tag value.
10180
+ # This object is not used or supported.
9870
10181
  # @return [Hash<String,String>]
9871
10182
  #
9872
10183
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyResponse AWS API Documentation
@@ -10026,6 +10337,28 @@ module Aws::Pinpoint
10026
10337
  include Aws::Structure
10027
10338
  end
10028
10339
 
10340
+ # Provides information about all the recommender model configurations
10341
+ # that are associated with your Amazon Pinpoint account.
10342
+ #
10343
+ # @!attribute [rw] item
10344
+ # An array of responses, one for each recommender model configuration
10345
+ # that's associated with your Amazon Pinpoint account.
10346
+ # @return [Array<Types::RecommenderConfigurationResponse>]
10347
+ #
10348
+ # @!attribute [rw] next_token
10349
+ # The string to use in a subsequent request to get the next page of
10350
+ # results in a paginated response. This value is null if there are no
10351
+ # additional pages.
10352
+ # @return [String]
10353
+ #
10354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListRecommenderConfigurationsResponse AWS API Documentation
10355
+ #
10356
+ class ListRecommenderConfigurationsResponse < Struct.new(
10357
+ :item,
10358
+ :next_token)
10359
+ include Aws::Structure
10360
+ end
10361
+
10029
10362
  # @note When making an API call, you may pass ListTagsForResourceRequest
10030
10363
  # data as a hash:
10031
10364
  #
@@ -10045,7 +10378,7 @@ module Aws::Pinpoint
10045
10378
 
10046
10379
  # @!attribute [rw] tags_model
10047
10380
  # Specifies the tags (keys and values) for an application, campaign,
10048
- # journey, message template, or segment.
10381
+ # message template, or segment.
10049
10382
  # @return [Types::TagsModel]
10050
10383
  #
10051
10384
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ListTagsForResourceResponse AWS API Documentation
@@ -10737,7 +11070,7 @@ module Aws::Pinpoint
10737
11070
  # endpoint address.
10738
11071
  #
10739
11072
  # * TEMPORARY\_FAILURE - A temporary error occurred. Amazon Pinpoint
10740
- # will attempt to deliver the message again later.
11073
+ # won't attempt to send the message again.
10741
11074
  #
10742
11075
  # * THROTTLED - Amazon Pinpoint throttled the operation to send the
10743
11076
  # message to the endpoint address.
@@ -11215,6 +11548,22 @@ module Aws::Pinpoint
11215
11548
  include Aws::Structure
11216
11549
  end
11217
11550
 
11551
+ # Provides information about an API request or response.
11552
+ #
11553
+ # @!attribute [rw] message
11554
+ # @return [String]
11555
+ #
11556
+ # @!attribute [rw] request_id
11557
+ # @return [String]
11558
+ #
11559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/PayloadTooLargeException AWS API Documentation
11560
+ #
11561
+ class PayloadTooLargeException < Struct.new(
11562
+ :message,
11563
+ :request_id)
11564
+ include Aws::Structure
11565
+ end
11566
+
11218
11567
  # @note When making an API call, you may pass PhoneNumberValidateRequest
11219
11568
  # data as a hash:
11220
11569
  #
@@ -11432,6 +11781,7 @@ module Aws::Pinpoint
11432
11781
  # title: "__string",
11433
11782
  # url: "__string",
11434
11783
  # },
11784
+ # recommender_id: "__string",
11435
11785
  # tags: {
11436
11786
  # "__string" => "__string",
11437
11787
  # },
@@ -11479,6 +11829,14 @@ module Aws::Pinpoint
11479
11829
  # channels (DefaultPushNotificationTemplate).
11480
11830
  # @return [Types::AndroidPushNotificationTemplate]
11481
11831
  #
11832
+ # @!attribute [rw] recommender_id
11833
+ # The unique identifier for the recommender model to use for the
11834
+ # message template. Amazon Pinpoint uses this value to determine how
11835
+ # to retrieve and process data from a recommender model when it sends
11836
+ # messages that use the template, if the template contains message
11837
+ # variables for recommendation data.
11838
+ # @return [String]
11839
+ #
11482
11840
  # @!attribute [rw] tags
11483
11841
  # A string-to-string map of key-value pairs that defines the tags to
11484
11842
  # associate with the message template. Each tag consists of a required
@@ -11498,6 +11856,7 @@ module Aws::Pinpoint
11498
11856
  :default,
11499
11857
  :default_substitutions,
11500
11858
  :gcm,
11859
+ :recommender_id,
11501
11860
  :tags,
11502
11861
  :template_description)
11503
11862
  include Aws::Structure
@@ -11561,6 +11920,11 @@ module Aws::Pinpoint
11561
11920
  # modified.
11562
11921
  # @return [String]
11563
11922
  #
11923
+ # @!attribute [rw] recommender_id
11924
+ # The unique identifier for the recommender model that's used by the
11925
+ # message template.
11926
+ # @return [String]
11927
+ #
11564
11928
  # @!attribute [rw] tags
11565
11929
  # A string-to-string map of key-value pairs that identifies the tags
11566
11930
  # that are associated with the message template. Each tag consists of
@@ -11598,6 +11962,7 @@ module Aws::Pinpoint
11598
11962
  :default_substitutions,
11599
11963
  :gcm,
11600
11964
  :last_modified_date,
11965
+ :recommender_id,
11601
11966
  :tags,
11602
11967
  :template_description,
11603
11968
  :template_name,
@@ -11897,6 +12262,120 @@ module Aws::Pinpoint
11897
12262
  include Aws::Structure
11898
12263
  end
11899
12264
 
12265
+ # Provides information about Amazon Pinpoint configuration settings for
12266
+ # retrieving and processing data from a recommender model.
12267
+ #
12268
+ # @!attribute [rw] attributes
12269
+ # A map that defines 1-10 custom endpoint or user attributes,
12270
+ # depending on the value for the RecommenderUserIdType property. Each
12271
+ # of these attributes temporarily stores a recommended item that's
12272
+ # retrieved from the recommender model and sent to an AWS Lambda
12273
+ # function for additional processing. Each attribute can be used as a
12274
+ # message variable in a message template.
12275
+ #
12276
+ # This value is null if the configuration doesn't invoke an AWS
12277
+ # Lambda function (LambdaFunctionArn) to perform additional processing
12278
+ # of recommendation data.
12279
+ # @return [Hash<String,String>]
12280
+ #
12281
+ # @!attribute [rw] creation_date
12282
+ # The date, in extended ISO 8601 format, when the configuration was
12283
+ # created for the recommender model.
12284
+ # @return [String]
12285
+ #
12286
+ # @!attribute [rw] description
12287
+ # The custom description of the configuration for the recommender
12288
+ # model.
12289
+ # @return [String]
12290
+ #
12291
+ # @!attribute [rw] id
12292
+ # The unique identifier for the recommender model configuration.
12293
+ # @return [String]
12294
+ #
12295
+ # @!attribute [rw] last_modified_date
12296
+ # The date, in extended ISO 8601 format, when the configuration for
12297
+ # the recommender model was last modified.
12298
+ # @return [String]
12299
+ #
12300
+ # @!attribute [rw] name
12301
+ # The custom name of the configuration for the recommender model.
12302
+ # @return [String]
12303
+ #
12304
+ # @!attribute [rw] recommendation_provider_id_type
12305
+ # The type of Amazon Pinpoint ID that's associated with unique user
12306
+ # IDs in the recommender model. This value enables the model to use
12307
+ # attribute and event data that’s specific to a particular endpoint or
12308
+ # user in an Amazon Pinpoint application. Possible values are:
12309
+ #
12310
+ # * PINPOINT\_ENDPOINT\_ID - Each user in the model is associated with
12311
+ # a particular endpoint in Amazon Pinpoint. The data is correlated
12312
+ # based on endpoint IDs in Amazon Pinpoint. This is the default
12313
+ # value.
12314
+ #
12315
+ # * PINPOINT\_USER\_ID - Each user in the model is associated with a
12316
+ # particular user and endpoint in Amazon Pinpoint. The data is
12317
+ # correlated based on user IDs in Amazon Pinpoint. If this value is
12318
+ # specified, an endpoint definition in Amazon Pinpoint has to
12319
+ # specify both a user ID (UserId) and an endpoint ID. Otherwise,
12320
+ # messages won’t be sent to the user's endpoint.
12321
+ # @return [String]
12322
+ #
12323
+ # @!attribute [rw] recommendation_provider_role_arn
12324
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
12325
+ # Management (IAM) role that authorizes Amazon Pinpoint to retrieve
12326
+ # recommendation data from the recommender model.
12327
+ # @return [String]
12328
+ #
12329
+ # @!attribute [rw] recommendation_provider_uri
12330
+ # The Amazon Resource Name (ARN) of the recommender model that Amazon
12331
+ # Pinpoint retrieves the recommendation data from. This value is the
12332
+ # ARN of an Amazon Personalize campaign.
12333
+ # @return [String]
12334
+ #
12335
+ # @!attribute [rw] recommendation_transformer_uri
12336
+ # The name or Amazon Resource Name (ARN) of the AWS Lambda function
12337
+ # that Amazon Pinpoint invokes to perform additional processing of
12338
+ # recommendation data that it retrieves from the recommender model.
12339
+ # @return [String]
12340
+ #
12341
+ # @!attribute [rw] recommendations_display_name
12342
+ # The custom display name for the standard endpoint or user attribute
12343
+ # (RecommendationItems) that temporarily stores a recommended item for
12344
+ # each endpoint or user, depending on the value for the
12345
+ # RecommenderUserIdType property. This name appears in the **Attribute
12346
+ # finder** pane of the template editor on the Amazon Pinpoint console.
12347
+ #
12348
+ # This value is null if the configuration doesn't invoke an AWS
12349
+ # Lambda function (LambdaFunctionArn) to perform additional processing
12350
+ # of recommendation data.
12351
+ # @return [String]
12352
+ #
12353
+ # @!attribute [rw] recommendations_per_message
12354
+ # The number of recommended items that are retrieved from the model
12355
+ # for each endpoint or user, depending on the value for the
12356
+ # RecommenderUserIdType property. This number determines how many
12357
+ # recommended attributes are available for use as message variables in
12358
+ # message templates.
12359
+ # @return [Integer]
12360
+ #
12361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/RecommenderConfigurationResponse AWS API Documentation
12362
+ #
12363
+ class RecommenderConfigurationResponse < Struct.new(
12364
+ :attributes,
12365
+ :creation_date,
12366
+ :description,
12367
+ :id,
12368
+ :last_modified_date,
12369
+ :name,
12370
+ :recommendation_provider_id_type,
12371
+ :recommendation_provider_role_arn,
12372
+ :recommendation_provider_uri,
12373
+ :recommendation_transformer_uri,
12374
+ :recommendations_display_name,
12375
+ :recommendations_per_message)
12376
+ include Aws::Structure
12377
+ end
12378
+
11900
12379
  # @note When making an API call, you may pass RemoveAttributesRequest
11901
12380
  # data as a hash:
11902
12381
  #
@@ -12191,6 +12670,7 @@ module Aws::Pinpoint
12191
12670
  # {
12192
12671
  # body: "__string",
12193
12672
  # default_substitutions: "__string",
12673
+ # recommender_id: "__string",
12194
12674
  # tags: {
12195
12675
  # "__string" => "__string",
12196
12676
  # },
@@ -12212,6 +12692,14 @@ module Aws::Pinpoint
12212
12692
  # variables and values.
12213
12693
  # @return [String]
12214
12694
  #
12695
+ # @!attribute [rw] recommender_id
12696
+ # The unique identifier for the recommender model to use for the
12697
+ # message template. Amazon Pinpoint uses this value to determine how
12698
+ # to retrieve and process data from a recommender model when it sends
12699
+ # messages that use the template, if the template contains message
12700
+ # variables for recommendation data.
12701
+ # @return [String]
12702
+ #
12215
12703
  # @!attribute [rw] tags
12216
12704
  # A string-to-string map of key-value pairs that defines the tags to
12217
12705
  # associate with the message template. Each tag consists of a required
@@ -12227,6 +12715,7 @@ module Aws::Pinpoint
12227
12715
  class SMSTemplateRequest < Struct.new(
12228
12716
  :body,
12229
12717
  :default_substitutions,
12718
+ :recommender_id,
12230
12719
  :tags,
12231
12720
  :template_description)
12232
12721
  include Aws::Structure
@@ -12262,6 +12751,11 @@ module Aws::Pinpoint
12262
12751
  # modified.
12263
12752
  # @return [String]
12264
12753
  #
12754
+ # @!attribute [rw] recommender_id
12755
+ # The unique identifier for the recommender model that's used by the
12756
+ # message template.
12757
+ # @return [String]
12758
+ #
12265
12759
  # @!attribute [rw] tags
12266
12760
  # A string-to-string map of key-value pairs that identifies the tags
12267
12761
  # that are associated with the message template. Each tag consists of
@@ -12295,6 +12789,7 @@ module Aws::Pinpoint
12295
12789
  :creation_date,
12296
12790
  :default_substitutions,
12297
12791
  :last_modified_date,
12792
+ :recommender_id,
12298
12793
  :tags,
12299
12794
  :template_description,
12300
12795
  :template_name,
@@ -12383,8 +12878,9 @@ module Aws::Pinpoint
12383
12878
  # @return [Types::QuietTime]
12384
12879
  #
12385
12880
  # @!attribute [rw] start_time
12386
- # The scheduled time, in ISO 8601 format, when the campaign began or
12387
- # will begin.
12881
+ # The scheduled time when the campaign began or will begin. Valid
12882
+ # values are: IMMEDIATE, to start the campaign immediately; or, a
12883
+ # specific time in ISO 8601 format.
12388
12884
  # @return [String]
12389
12885
  #
12390
12886
  # @!attribute [rw] timezone
@@ -14137,7 +14633,7 @@ module Aws::Pinpoint
14137
14633
  #
14138
14634
  # @!attribute [rw] tags_model
14139
14635
  # Specifies the tags (keys and values) for an application, campaign,
14140
- # journey, message template, or segment.
14636
+ # message template, or segment.
14141
14637
  # @return [Types::TagsModel]
14142
14638
  #
14143
14639
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TagResourceRequest AWS API Documentation
@@ -14149,7 +14645,7 @@ module Aws::Pinpoint
14149
14645
  end
14150
14646
 
14151
14647
  # Specifies the tags (keys and values) for an application, campaign,
14152
- # journey, message template, or segment.
14648
+ # message template, or segment.
14153
14649
  #
14154
14650
  # @note When making an API call, you may pass TagsModel
14155
14651
  # data as a hash:
@@ -14162,8 +14658,8 @@ module Aws::Pinpoint
14162
14658
  #
14163
14659
  # @!attribute [rw] tags
14164
14660
  # A string-to-string map of key-value pairs that defines the tags for
14165
- # an application, campaign, journey, message template, or segment.
14166
- # Each of these resources can have a maximum of 50 tags.
14661
+ # an application, campaign, message template, or segment. Each of
14662
+ # these resources can have a maximum of 50 tags.
14167
14663
  #
14168
14664
  # Each tag consists of a required tag key and an associated tag value.
14169
14665
  # The maximum length of a tag key is 128 characters. The maximum
@@ -14204,7 +14700,7 @@ module Aws::Pinpoint
14204
14700
  # Template Versions</link> resource.
14205
14701
  #
14206
14702
  # If you don't specify a value for this property, Amazon Pinpoint
14207
- # uses the *active* version of the template. The *active* version is
14703
+ # uses the *active version* of the template. The *active version* is
14208
14704
  # typically the version of a template that's been most recently
14209
14705
  # reviewed and approved for use, depending on your workflow. It isn't
14210
14706
  # necessarily the latest version of a template.
@@ -14229,11 +14725,13 @@ module Aws::Pinpoint
14229
14725
  # }
14230
14726
  #
14231
14727
  # @!attribute [rw] version
14232
- # The unique identifier for the version of the message template to use
14233
- # as the active version of the template. If specified, this value must
14234
- # match the identifier for an existing template version. To retrieve a
14235
- # list of versions and version identifiers for a template, use the
14236
- # <link linkend="templates-template-name-template-type-versions" />
14728
+ # The version of the message template to use as the active version of
14729
+ # the template. Valid values are: latest, for the most recent version
14730
+ # of the template; or, the unique identifier for any existing version
14731
+ # of the template. If you specify an identifier, the value must match
14732
+ # the identifier for an existing template version. To retrieve a list
14733
+ # of versions and version identifiers for a template, use the <link
14734
+ # linkend="templates-template-name-template-type-versions" />
14237
14735
  #
14238
14736
  # Template Versions</link> resource.
14239
14737
  # @return [String]
@@ -14283,7 +14781,8 @@ module Aws::Pinpoint
14283
14781
  # @return [Types::Template]
14284
14782
  #
14285
14783
  # @!attribute [rw] voice_template
14286
- # The voice template to use for the message.
14784
+ # The voice template to use for the message. This object isn't
14785
+ # supported for campaigns.
14287
14786
  # @return [Types::Template]
14288
14787
  #
14289
14788
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/TemplateConfiguration AWS API Documentation
@@ -14300,7 +14799,11 @@ module Aws::Pinpoint
14300
14799
  # your Amazon Pinpoint account.
14301
14800
  #
14302
14801
  # @!attribute [rw] arn
14303
- # The Amazon Resource Name (ARN) of the message template.
14802
+ # The Amazon Resource Name (ARN) of the message template. This value
14803
+ # isn't included in a TemplateResponse object. To retrieve the ARN of
14804
+ # a template, use the GetEmailTemplate, GetPushTemplate,
14805
+ # GetSmsTemplate, or GetVoiceTemplate operation, depending on the type
14806
+ # of template that you want to retrieve the ARN for.
14304
14807
  # @return [String]
14305
14808
  #
14306
14809
  # @!attribute [rw] creation_date
@@ -14309,10 +14812,11 @@ module Aws::Pinpoint
14309
14812
  #
14310
14813
  # @!attribute [rw] default_substitutions
14311
14814
  # The JSON object that specifies the default values that are used for
14312
- # message variables in the message template. This object is a set of
14313
- # key-value pairs. Each key defines a message variable in the
14314
- # template. The corresponding value defines the default value for that
14315
- # variable.
14815
+ # message variables in the message template. This object isn't
14816
+ # included in a TemplateResponse object. To retrieve this object for a
14817
+ # template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate,
14818
+ # or GetVoiceTemplate operation, depending on the type of template
14819
+ # that you want to retrieve the object for.
14316
14820
  # @return [String]
14317
14821
  #
14318
14822
  # @!attribute [rw] last_modified_date
@@ -14321,13 +14825,20 @@ module Aws::Pinpoint
14321
14825
  # @return [String]
14322
14826
  #
14323
14827
  # @!attribute [rw] tags
14324
- # A string-to-string map of key-value pairs that identifies the tags
14325
- # that are associated with the message template. Each tag consists of
14326
- # a required tag key and an associated tag value.
14828
+ # A map of key-value pairs that identifies the tags that are
14829
+ # associated with the message template. This object isn't included in
14830
+ # a TemplateResponse object. To retrieve this object for a template,
14831
+ # use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
14832
+ # GetVoiceTemplate operation, depending on the type of template that
14833
+ # you want to retrieve the object for.
14327
14834
  # @return [Hash<String,String>]
14328
14835
  #
14329
14836
  # @!attribute [rw] template_description
14330
- # The custom description of the message template.
14837
+ # The custom description of the message template. This value isn't
14838
+ # included in a TemplateResponse object. To retrieve the description
14839
+ # of a template, use the GetEmailTemplate, GetPushTemplate,
14840
+ # GetSmsTemplate, or GetVoiceTemplate operation, depending on the type
14841
+ # of template that you want to retrieve the description for.
14331
14842
  # @return [String]
14332
14843
  #
14333
14844
  # @!attribute [rw] template_name
@@ -15281,6 +15792,7 @@ module Aws::Pinpoint
15281
15792
  # email_template_request: { # required
15282
15793
  # default_substitutions: "__string",
15283
15794
  # html_part: "__string",
15795
+ # recommender_id: "__string",
15284
15796
  # subject: "__string",
15285
15797
  # tags: {
15286
15798
  # "__string" => "__string",
@@ -15928,6 +16440,7 @@ module Aws::Pinpoint
15928
16440
  # title: "__string",
15929
16441
  # url: "__string",
15930
16442
  # },
16443
+ # recommender_id: "__string",
15931
16444
  # tags: {
15932
16445
  # "__string" => "__string",
15933
16446
  # },
@@ -15973,6 +16486,196 @@ module Aws::Pinpoint
15973
16486
  include Aws::Structure
15974
16487
  end
15975
16488
 
16489
+ # Specifies Amazon Pinpoint configuration settings for retrieving and
16490
+ # processing recommendation data from a recommender model.
16491
+ #
16492
+ # @note When making an API call, you may pass UpdateRecommenderConfiguration
16493
+ # data as a hash:
16494
+ #
16495
+ # {
16496
+ # attributes: {
16497
+ # "__string" => "__string",
16498
+ # },
16499
+ # description: "__string",
16500
+ # name: "__string",
16501
+ # recommendation_provider_id_type: "__string",
16502
+ # recommendation_provider_role_arn: "__string", # required
16503
+ # recommendation_provider_uri: "__string", # required
16504
+ # recommendation_transformer_uri: "__string",
16505
+ # recommendations_display_name: "__string",
16506
+ # recommendations_per_message: 1,
16507
+ # }
16508
+ #
16509
+ # @!attribute [rw] attributes
16510
+ # A map of key-value pairs that defines 1-10 custom endpoint or user
16511
+ # attributes, depending on the value for the RecommenderUserIdType
16512
+ # property. Each of these attributes temporarily stores a recommended
16513
+ # item that's retrieved from the recommender model and sent to an AWS
16514
+ # Lambda function for additional processing. Each attribute can be
16515
+ # used as a message variable in a message template.
16516
+ #
16517
+ # In the map, the key is the name of a custom attribute and the value
16518
+ # is a custom display name for that attribute. The display name
16519
+ # appears in the **Attribute finder** pane of the template editor on
16520
+ # the Amazon Pinpoint console. The following restrictions apply to
16521
+ # these names:
16522
+ #
16523
+ # * An attribute name must start with a letter or number and it can
16524
+ # contain up to 50 characters. The characters can be letters,
16525
+ # numbers, underscores (\_), or hyphens (-). Attribute names are
16526
+ # case sensitive and must be unique.
16527
+ #
16528
+ # * An attribute display name must start with a letter or number and
16529
+ # it can contain up to 25 characters. The characters can be letters,
16530
+ # numbers, spaces, underscores (\_), or hyphens (-).
16531
+ #
16532
+ # This object is required if the configuration invokes an AWS Lambda
16533
+ # function (LambdaFunctionArn) to process recommendation data.
16534
+ # Otherwise, don't include this object in your request.
16535
+ # @return [Hash<String,String>]
16536
+ #
16537
+ # @!attribute [rw] description
16538
+ # A custom description of the configuration for the recommender model.
16539
+ # The description can contain up to 128 characters.
16540
+ # @return [String]
16541
+ #
16542
+ # @!attribute [rw] name
16543
+ # A custom name of the configuration for the recommender model. The
16544
+ # name must start with a letter or number and it can contain up to 128
16545
+ # characters. The characters can be letters, numbers, spaces,
16546
+ # underscores (\_), or hyphens (-).
16547
+ # @return [String]
16548
+ #
16549
+ # @!attribute [rw] recommendation_provider_id_type
16550
+ # The type of Amazon Pinpoint ID to associate with unique user IDs in
16551
+ # the recommender model. This value enables the model to use attribute
16552
+ # and event data that’s specific to a particular endpoint or user in
16553
+ # an Amazon Pinpoint application. Valid values are:
16554
+ #
16555
+ # * PINPOINT\_ENDPOINT\_ID - Associate each user in the model with a
16556
+ # particular endpoint in Amazon Pinpoint. The data is correlated
16557
+ # based on endpoint IDs in Amazon Pinpoint. This is the default
16558
+ # value.
16559
+ #
16560
+ # * PINPOINT\_USER\_ID - Associate each user in the model with a
16561
+ # particular user and endpoint in Amazon Pinpoint. The data is
16562
+ # correlated based on user IDs in Amazon Pinpoint. If you specify
16563
+ # this value, an endpoint definition in Amazon Pinpoint has to
16564
+ # specify a both a user ID (UserId) and an endpoint ID. Otherwise,
16565
+ # messages won’t be sent to the user's endpoint.
16566
+ # @return [String]
16567
+ #
16568
+ # @!attribute [rw] recommendation_provider_role_arn
16569
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
16570
+ # Management (IAM) role that authorizes Amazon Pinpoint to retrieve
16571
+ # recommendation data from the recommender model.
16572
+ # @return [String]
16573
+ #
16574
+ # @!attribute [rw] recommendation_provider_uri
16575
+ # The Amazon Resource Name (ARN) of the recommender model to retrieve
16576
+ # recommendation data from. This value must match the ARN of an Amazon
16577
+ # Personalize campaign.
16578
+ # @return [String]
16579
+ #
16580
+ # @!attribute [rw] recommendation_transformer_uri
16581
+ # The name or Amazon Resource Name (ARN) of the AWS Lambda function to
16582
+ # invoke for additional processing of recommendation data that's
16583
+ # retrieved from the recommender model.
16584
+ # @return [String]
16585
+ #
16586
+ # @!attribute [rw] recommendations_display_name
16587
+ # A custom display name for the standard endpoint or user attribute
16588
+ # (RecommendationItems) that temporarily stores a recommended item for
16589
+ # each endpoint or user, depending on the value for the
16590
+ # RecommenderUserIdType property. This value is required if the
16591
+ # configuration doesn't invoke an AWS Lambda function
16592
+ # (LambdaFunctionArn) to perform additional processing of
16593
+ # recommendation data.
16594
+ #
16595
+ # This name appears in the **Attribute finder** pane of the template
16596
+ # editor on the Amazon Pinpoint console. The name can contain up to 25
16597
+ # characters. The characters can be letters, numbers, spaces,
16598
+ # underscores (\_), or hyphens (-). These restrictions don't apply to
16599
+ # attribute values.
16600
+ # @return [String]
16601
+ #
16602
+ # @!attribute [rw] recommendations_per_message
16603
+ # The number of recommended items to retrieve from the model for each
16604
+ # endpoint or user, depending on the value for the
16605
+ # RecommenderUserIdType property. This number determines how many
16606
+ # recommended attributes are available for use as message variables in
16607
+ # message templates. The minimum value is 1. The maximum value is 5.
16608
+ # The default value is 5.
16609
+ #
16610
+ # To use multiple recommended items and custom attributes with message
16611
+ # variables, you have to use an AWS Lambda function
16612
+ # (LambdaFunctionArn) to perform additional processing of
16613
+ # recommendation data.
16614
+ # @return [Integer]
16615
+ #
16616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateRecommenderConfiguration AWS API Documentation
16617
+ #
16618
+ class UpdateRecommenderConfiguration < Struct.new(
16619
+ :attributes,
16620
+ :description,
16621
+ :name,
16622
+ :recommendation_provider_id_type,
16623
+ :recommendation_provider_role_arn,
16624
+ :recommendation_provider_uri,
16625
+ :recommendation_transformer_uri,
16626
+ :recommendations_display_name,
16627
+ :recommendations_per_message)
16628
+ include Aws::Structure
16629
+ end
16630
+
16631
+ # @note When making an API call, you may pass UpdateRecommenderConfigurationRequest
16632
+ # data as a hash:
16633
+ #
16634
+ # {
16635
+ # recommender_id: "__string", # required
16636
+ # update_recommender_configuration: { # required
16637
+ # attributes: {
16638
+ # "__string" => "__string",
16639
+ # },
16640
+ # description: "__string",
16641
+ # name: "__string",
16642
+ # recommendation_provider_id_type: "__string",
16643
+ # recommendation_provider_role_arn: "__string", # required
16644
+ # recommendation_provider_uri: "__string", # required
16645
+ # recommendation_transformer_uri: "__string",
16646
+ # recommendations_display_name: "__string",
16647
+ # recommendations_per_message: 1,
16648
+ # },
16649
+ # }
16650
+ #
16651
+ # @!attribute [rw] recommender_id
16652
+ # @return [String]
16653
+ #
16654
+ # @!attribute [rw] update_recommender_configuration
16655
+ # Specifies Amazon Pinpoint configuration settings for retrieving and
16656
+ # processing recommendation data from a recommender model.
16657
+ # @return [Types::UpdateRecommenderConfiguration]
16658
+ #
16659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateRecommenderConfigurationRequest AWS API Documentation
16660
+ #
16661
+ class UpdateRecommenderConfigurationRequest < Struct.new(
16662
+ :recommender_id,
16663
+ :update_recommender_configuration)
16664
+ include Aws::Structure
16665
+ end
16666
+
16667
+ # @!attribute [rw] recommender_configuration_response
16668
+ # Provides information about Amazon Pinpoint configuration settings
16669
+ # for retrieving and processing data from a recommender model.
16670
+ # @return [Types::RecommenderConfigurationResponse]
16671
+ #
16672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/UpdateRecommenderConfigurationResponse AWS API Documentation
16673
+ #
16674
+ class UpdateRecommenderConfigurationResponse < Struct.new(
16675
+ :recommender_configuration_response)
16676
+ include Aws::Structure
16677
+ end
16678
+
15976
16679
  # @note When making an API call, you may pass UpdateSegmentRequest
15977
16680
  # data as a hash:
15978
16681
  #
@@ -16215,6 +16918,7 @@ module Aws::Pinpoint
16215
16918
  # sms_template_request: { # required
16216
16919
  # body: "__string",
16217
16920
  # default_substitutions: "__string",
16921
+ # recommender_id: "__string",
16218
16922
  # tags: {
16219
16923
  # "__string" => "__string",
16220
16924
  # },
@@ -17202,7 +17906,7 @@ module Aws::Pinpoint
17202
17906
  # @return [Types::MessageConfiguration]
17203
17907
  #
17204
17908
  # @!attribute [rw] name
17205
- # The custom name of the campaign.
17909
+ # A custom name for the campaign.
17206
17910
  # @return [String]
17207
17911
  #
17208
17912
  # @!attribute [rw] schedule
@@ -17234,7 +17938,7 @@ module Aws::Pinpoint
17234
17938
  # @return [String]
17235
17939
  #
17236
17940
  # @!attribute [rw] treatment_name
17237
- # The custom name of a variation of the campaign to use for A/B
17941
+ # A custom name for a variation of the campaign to use for A/B
17238
17942
  # testing.
17239
17943
  # @return [String]
17240
17944
  #
@@ -17584,7 +18288,7 @@ module Aws::Pinpoint
17584
18288
  # activity in the journey. For each Activity object, the key is the
17585
18289
  # unique identifier (string) for an activity and the value is the
17586
18290
  # settings for the activity. An activity identifier can contain a
17587
- # maximum of 128 characters. The characters must be alphanumeric
18291
+ # maximum of 100 characters. The characters must be alphanumeric
17588
18292
  # characters.
17589
18293
  # @return [Hash<String,Types::Activity>]
17590
18294
  #
@@ -17643,9 +18347,9 @@ module Aws::Pinpoint
17643
18347
  # @return [Types::JourneySchedule]
17644
18348
  #
17645
18349
  # @!attribute [rw] start_activity
17646
- # The unique identifier for the first activity in the journey. An
17647
- # activity identifier can contain a maximum of 128 characters. The
17648
- # characters must be alphanumeric characters.
18350
+ # The unique identifier for the first activity in the journey. The
18351
+ # identifier for this activity can contain a maximum of 128
18352
+ # characters. The characters must be alphanumeric characters.
17649
18353
  # @return [String]
17650
18354
  #
17651
18355
  # @!attribute [rw] start_condition
@@ -18047,7 +18751,7 @@ module Aws::Pinpoint
18047
18751
  # @return [String]
18048
18752
  #
18049
18753
  # @!attribute [rw] treatment_name
18050
- # The custom name of the treatment. A treatment is a variation of a
18754
+ # A custom name for the treatment. A treatment is a variation of a
18051
18755
  # campaign that's used for A/B testing of a campaign.
18052
18756
  # @return [String]
18053
18757
  #