aws-sdk-pinpoint 1.70.0 → 1.71.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpoint/client.rb +222 -1
- data/lib/aws-sdk-pinpoint/client_api.rb +122 -0
- data/lib/aws-sdk-pinpoint/endpoint_provider.rb +39 -21
- data/lib/aws-sdk-pinpoint/endpoints.rb +42 -0
- data/lib/aws-sdk-pinpoint/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-pinpoint/types.rb +353 -31
- data/lib/aws-sdk-pinpoint.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ba924f387f35a3fe2fd65edd7b94314153774bc8f5bd377ee4669ad818cd0ddf
|
|
4
|
+
data.tar.gz: 280847c927ad02ae3d44abb29a65f4339b6c3a0943aff21988f2cfeddf95da41
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f51f086910d21ea86c6fda8f2b03d2e45f8a2d4540cd3da5e0e4a6b85661d56909e8a5d62f26b5b6102be77b954ebe94982327373d309486d2046007b386fff7
|
|
7
|
+
data.tar.gz: 0ab9fcc7f79173f82137b91aa7a8d52621de0ae38dfb97ccaf05cf94b285a89bdaa52955765c30db9c89d49444fbb4ba14ba3910ae6df6566a28949c7bba2410
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.71.0 (2023-04-25)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds support for journey runs and querying journey execution metrics based on journey runs. Adds execution metrics to campaign activities. Updates docs for Advanced Quiet Time.
|
|
8
|
+
|
|
4
9
|
1.70.0 (2023-01-18)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.71.0
|
|
@@ -4901,6 +4901,8 @@ module Aws::Pinpoint
|
|
|
4901
4901
|
# resp.activities_response.item[0].timezones_total_count #=> Integer
|
|
4902
4902
|
# resp.activities_response.item[0].total_endpoint_count #=> Integer
|
|
4903
4903
|
# resp.activities_response.item[0].treatment_id #=> String
|
|
4904
|
+
# resp.activities_response.item[0].execution_metrics #=> Hash
|
|
4905
|
+
# resp.activities_response.item[0].execution_metrics["__string"] #=> String
|
|
4904
4906
|
# resp.activities_response.next_token #=> String
|
|
4905
4907
|
#
|
|
4906
4908
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetCampaignActivities AWS API Documentation
|
|
@@ -7023,6 +7025,225 @@ module Aws::Pinpoint
|
|
|
7023
7025
|
req.send_request(options)
|
|
7024
7026
|
end
|
|
7025
7027
|
|
|
7028
|
+
# Retrieves (queries) pre-aggregated data for a standard run execution
|
|
7029
|
+
# metric that applies to a journey activity.
|
|
7030
|
+
#
|
|
7031
|
+
# @option params [required, String] :application_id
|
|
7032
|
+
#
|
|
7033
|
+
# @option params [required, String] :journey_activity_id
|
|
7034
|
+
#
|
|
7035
|
+
# @option params [required, String] :journey_id
|
|
7036
|
+
#
|
|
7037
|
+
# @option params [String] :next_token
|
|
7038
|
+
#
|
|
7039
|
+
# @option params [String] :page_size
|
|
7040
|
+
#
|
|
7041
|
+
# @option params [required, String] :run_id
|
|
7042
|
+
#
|
|
7043
|
+
# @return [Types::GetJourneyRunExecutionActivityMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7044
|
+
#
|
|
7045
|
+
# * {Types::GetJourneyRunExecutionActivityMetricsResponse#journey_run_execution_activity_metrics_response #journey_run_execution_activity_metrics_response} => Types::JourneyRunExecutionActivityMetricsResponse
|
|
7046
|
+
#
|
|
7047
|
+
#
|
|
7048
|
+
# @example Example: To get the activity execution metrics for a journey run
|
|
7049
|
+
#
|
|
7050
|
+
# # The following example gets activity execution metrics for a single run of a journey.
|
|
7051
|
+
#
|
|
7052
|
+
# resp = client.get_journey_run_execution_activity_metrics({
|
|
7053
|
+
# application_id: "11111111112222222222333333333344",
|
|
7054
|
+
# journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd",
|
|
7055
|
+
# run_id: "99999999998888888888777777777766",
|
|
7056
|
+
# journey_activity_id: "AAAAAAAAAA",
|
|
7057
|
+
# })
|
|
7058
|
+
#
|
|
7059
|
+
# resp.to_h outputs the following:
|
|
7060
|
+
# {
|
|
7061
|
+
# journey_run_execution_activity_metrics_response: {
|
|
7062
|
+
# application_id: "11111111112222222222333333333344",
|
|
7063
|
+
# journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd",
|
|
7064
|
+
# run_id: "99999999998888888888777777777766",
|
|
7065
|
+
# journey_activity_id: "AAAAAAAAAA",
|
|
7066
|
+
# activity_type: "EMAIL",
|
|
7067
|
+
# last_evaluated_time: "2000-01-01T00:00:05.000Z",
|
|
7068
|
+
# metrics: {
|
|
7069
|
+
# "SUCCESS" => "1",
|
|
7070
|
+
# },
|
|
7071
|
+
# },
|
|
7072
|
+
# }
|
|
7073
|
+
#
|
|
7074
|
+
# @example Request syntax with placeholder values
|
|
7075
|
+
#
|
|
7076
|
+
# resp = client.get_journey_run_execution_activity_metrics({
|
|
7077
|
+
# application_id: "__string", # required
|
|
7078
|
+
# journey_activity_id: "__string", # required
|
|
7079
|
+
# journey_id: "__string", # required
|
|
7080
|
+
# next_token: "__string",
|
|
7081
|
+
# page_size: "__string",
|
|
7082
|
+
# run_id: "__string", # required
|
|
7083
|
+
# })
|
|
7084
|
+
#
|
|
7085
|
+
# @example Response structure
|
|
7086
|
+
#
|
|
7087
|
+
# resp.journey_run_execution_activity_metrics_response.activity_type #=> String
|
|
7088
|
+
# resp.journey_run_execution_activity_metrics_response.application_id #=> String
|
|
7089
|
+
# resp.journey_run_execution_activity_metrics_response.journey_activity_id #=> String
|
|
7090
|
+
# resp.journey_run_execution_activity_metrics_response.journey_id #=> String
|
|
7091
|
+
# resp.journey_run_execution_activity_metrics_response.last_evaluated_time #=> String
|
|
7092
|
+
# resp.journey_run_execution_activity_metrics_response.metrics #=> Hash
|
|
7093
|
+
# resp.journey_run_execution_activity_metrics_response.metrics["__string"] #=> String
|
|
7094
|
+
# resp.journey_run_execution_activity_metrics_response.run_id #=> String
|
|
7095
|
+
#
|
|
7096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunExecutionActivityMetrics AWS API Documentation
|
|
7097
|
+
#
|
|
7098
|
+
# @overload get_journey_run_execution_activity_metrics(params = {})
|
|
7099
|
+
# @param [Hash] params ({})
|
|
7100
|
+
def get_journey_run_execution_activity_metrics(params = {}, options = {})
|
|
7101
|
+
req = build_request(:get_journey_run_execution_activity_metrics, params)
|
|
7102
|
+
req.send_request(options)
|
|
7103
|
+
end
|
|
7104
|
+
|
|
7105
|
+
# Retrieves (queries) pre-aggregated data for a standard run execution
|
|
7106
|
+
# metric that applies to a journey.
|
|
7107
|
+
#
|
|
7108
|
+
# @option params [required, String] :application_id
|
|
7109
|
+
#
|
|
7110
|
+
# @option params [required, String] :journey_id
|
|
7111
|
+
#
|
|
7112
|
+
# @option params [String] :next_token
|
|
7113
|
+
#
|
|
7114
|
+
# @option params [String] :page_size
|
|
7115
|
+
#
|
|
7116
|
+
# @option params [required, String] :run_id
|
|
7117
|
+
#
|
|
7118
|
+
# @return [Types::GetJourneyRunExecutionMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7119
|
+
#
|
|
7120
|
+
# * {Types::GetJourneyRunExecutionMetricsResponse#journey_run_execution_metrics_response #journey_run_execution_metrics_response} => Types::JourneyRunExecutionMetricsResponse
|
|
7121
|
+
#
|
|
7122
|
+
#
|
|
7123
|
+
# @example Example: To get the execution metrics for a journey run
|
|
7124
|
+
#
|
|
7125
|
+
# # The following example gets execution metrics for a single run of a journey.
|
|
7126
|
+
#
|
|
7127
|
+
# resp = client.get_journey_run_execution_metrics({
|
|
7128
|
+
# application_id: "11111111112222222222333333333344",
|
|
7129
|
+
# journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd",
|
|
7130
|
+
# run_id: "99999999998888888888777777777766",
|
|
7131
|
+
# })
|
|
7132
|
+
#
|
|
7133
|
+
# resp.to_h outputs the following:
|
|
7134
|
+
# {
|
|
7135
|
+
# journey_run_execution_metrics_response: {
|
|
7136
|
+
# application_id: "11111111112222222222333333333344",
|
|
7137
|
+
# journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd",
|
|
7138
|
+
# run_id: "99999999998888888888777777777766",
|
|
7139
|
+
# last_evaluated_time: "2000-01-01T00:00:05.000Z",
|
|
7140
|
+
# metrics: {
|
|
7141
|
+
# "ENDPOINT_PRODUCED" => "1",
|
|
7142
|
+
# "ENDPOINT_ENTERED" => "1",
|
|
7143
|
+
# "ENDPOINT_LEFT" => "1",
|
|
7144
|
+
# },
|
|
7145
|
+
# },
|
|
7146
|
+
# }
|
|
7147
|
+
#
|
|
7148
|
+
# @example Request syntax with placeholder values
|
|
7149
|
+
#
|
|
7150
|
+
# resp = client.get_journey_run_execution_metrics({
|
|
7151
|
+
# application_id: "__string", # required
|
|
7152
|
+
# journey_id: "__string", # required
|
|
7153
|
+
# next_token: "__string",
|
|
7154
|
+
# page_size: "__string",
|
|
7155
|
+
# run_id: "__string", # required
|
|
7156
|
+
# })
|
|
7157
|
+
#
|
|
7158
|
+
# @example Response structure
|
|
7159
|
+
#
|
|
7160
|
+
# resp.journey_run_execution_metrics_response.application_id #=> String
|
|
7161
|
+
# resp.journey_run_execution_metrics_response.journey_id #=> String
|
|
7162
|
+
# resp.journey_run_execution_metrics_response.last_evaluated_time #=> String
|
|
7163
|
+
# resp.journey_run_execution_metrics_response.metrics #=> Hash
|
|
7164
|
+
# resp.journey_run_execution_metrics_response.metrics["__string"] #=> String
|
|
7165
|
+
# resp.journey_run_execution_metrics_response.run_id #=> String
|
|
7166
|
+
#
|
|
7167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunExecutionMetrics AWS API Documentation
|
|
7168
|
+
#
|
|
7169
|
+
# @overload get_journey_run_execution_metrics(params = {})
|
|
7170
|
+
# @param [Hash] params ({})
|
|
7171
|
+
def get_journey_run_execution_metrics(params = {}, options = {})
|
|
7172
|
+
req = build_request(:get_journey_run_execution_metrics, params)
|
|
7173
|
+
req.send_request(options)
|
|
7174
|
+
end
|
|
7175
|
+
|
|
7176
|
+
# Provides information about the runs of a journey.
|
|
7177
|
+
#
|
|
7178
|
+
# @option params [required, String] :application_id
|
|
7179
|
+
#
|
|
7180
|
+
# @option params [required, String] :journey_id
|
|
7181
|
+
#
|
|
7182
|
+
# @option params [String] :page_size
|
|
7183
|
+
#
|
|
7184
|
+
# @option params [String] :token
|
|
7185
|
+
#
|
|
7186
|
+
# @return [Types::GetJourneyRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7187
|
+
#
|
|
7188
|
+
# * {Types::GetJourneyRunsResponse#journey_runs_response #journey_runs_response} => Types::JourneyRunsResponse
|
|
7189
|
+
#
|
|
7190
|
+
#
|
|
7191
|
+
# @example Example: To get the runs of a journey
|
|
7192
|
+
#
|
|
7193
|
+
# # The following example gets the runs of a journey.
|
|
7194
|
+
#
|
|
7195
|
+
# resp = client.get_journey_runs({
|
|
7196
|
+
# application_id: "11111111112222222222333333333344",
|
|
7197
|
+
# journey_id: "aaaaaaaaaabbbbbbbbbbccccccccccdd",
|
|
7198
|
+
# })
|
|
7199
|
+
#
|
|
7200
|
+
# resp.to_h outputs the following:
|
|
7201
|
+
# {
|
|
7202
|
+
# journey_runs_response: {
|
|
7203
|
+
# item: [
|
|
7204
|
+
# {
|
|
7205
|
+
# run_id: "99999999998888888888777777777766",
|
|
7206
|
+
# creation_time: "2000-01-01T00:00:00.000Z",
|
|
7207
|
+
# last_update_time: "2000-01-01T00:00:05.000Z",
|
|
7208
|
+
# status: "COMPLETED",
|
|
7209
|
+
# },
|
|
7210
|
+
# {
|
|
7211
|
+
# run_id: "ffffffffffeeeeeeeeeeddddddddddcc",
|
|
7212
|
+
# creation_time: "2000-01-01T00:00:10.000Z",
|
|
7213
|
+
# last_update_time: "2000-01-01T00:00:10.000Z",
|
|
7214
|
+
# status: "SCHEDULED",
|
|
7215
|
+
# },
|
|
7216
|
+
# ],
|
|
7217
|
+
# },
|
|
7218
|
+
# }
|
|
7219
|
+
#
|
|
7220
|
+
# @example Request syntax with placeholder values
|
|
7221
|
+
#
|
|
7222
|
+
# resp = client.get_journey_runs({
|
|
7223
|
+
# application_id: "__string", # required
|
|
7224
|
+
# journey_id: "__string", # required
|
|
7225
|
+
# page_size: "__string",
|
|
7226
|
+
# token: "__string",
|
|
7227
|
+
# })
|
|
7228
|
+
#
|
|
7229
|
+
# @example Response structure
|
|
7230
|
+
#
|
|
7231
|
+
# resp.journey_runs_response.item #=> Array
|
|
7232
|
+
# resp.journey_runs_response.item[0].creation_time #=> String
|
|
7233
|
+
# resp.journey_runs_response.item[0].last_update_time #=> String
|
|
7234
|
+
# resp.journey_runs_response.item[0].run_id #=> String
|
|
7235
|
+
# resp.journey_runs_response.item[0].status #=> String, one of "SCHEDULED", "RUNNING", "COMPLETED", "CANCELLED"
|
|
7236
|
+
# resp.journey_runs_response.next_token #=> String
|
|
7237
|
+
#
|
|
7238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRuns AWS API Documentation
|
|
7239
|
+
#
|
|
7240
|
+
# @overload get_journey_runs(params = {})
|
|
7241
|
+
# @param [Hash] params ({})
|
|
7242
|
+
def get_journey_runs(params = {}, options = {})
|
|
7243
|
+
req = build_request(:get_journey_runs, params)
|
|
7244
|
+
req.send_request(options)
|
|
7245
|
+
end
|
|
7246
|
+
|
|
7026
7247
|
# Retrieves the content and settings of a message template for messages
|
|
7027
7248
|
# that are sent through a push notification channel.
|
|
7028
7249
|
#
|
|
@@ -12491,7 +12712,7 @@ module Aws::Pinpoint
|
|
|
12491
12712
|
params: params,
|
|
12492
12713
|
config: config)
|
|
12493
12714
|
context[:gem_name] = 'aws-sdk-pinpoint'
|
|
12494
|
-
context[:gem_version] = '1.
|
|
12715
|
+
context[:gem_version] = '1.71.0'
|
|
12495
12716
|
Seahorse::Client::Request.new(handlers, context)
|
|
12496
12717
|
end
|
|
12497
12718
|
|
|
@@ -255,6 +255,12 @@ module Aws::Pinpoint
|
|
|
255
255
|
GetJourneyExecutionMetricsResponse = Shapes::StructureShape.new(name: 'GetJourneyExecutionMetricsResponse')
|
|
256
256
|
GetJourneyRequest = Shapes::StructureShape.new(name: 'GetJourneyRequest')
|
|
257
257
|
GetJourneyResponse = Shapes::StructureShape.new(name: 'GetJourneyResponse')
|
|
258
|
+
GetJourneyRunExecutionActivityMetricsRequest = Shapes::StructureShape.new(name: 'GetJourneyRunExecutionActivityMetricsRequest')
|
|
259
|
+
GetJourneyRunExecutionActivityMetricsResponse = Shapes::StructureShape.new(name: 'GetJourneyRunExecutionActivityMetricsResponse')
|
|
260
|
+
GetJourneyRunExecutionMetricsRequest = Shapes::StructureShape.new(name: 'GetJourneyRunExecutionMetricsRequest')
|
|
261
|
+
GetJourneyRunExecutionMetricsResponse = Shapes::StructureShape.new(name: 'GetJourneyRunExecutionMetricsResponse')
|
|
262
|
+
GetJourneyRunsRequest = Shapes::StructureShape.new(name: 'GetJourneyRunsRequest')
|
|
263
|
+
GetJourneyRunsResponse = Shapes::StructureShape.new(name: 'GetJourneyRunsResponse')
|
|
258
264
|
GetPushTemplateRequest = Shapes::StructureShape.new(name: 'GetPushTemplateRequest')
|
|
259
265
|
GetPushTemplateResponse = Shapes::StructureShape.new(name: 'GetPushTemplateResponse')
|
|
260
266
|
GetRecommenderConfigurationRequest = Shapes::StructureShape.new(name: 'GetRecommenderConfigurationRequest')
|
|
@@ -311,6 +317,11 @@ module Aws::Pinpoint
|
|
|
311
317
|
JourneyLimits = Shapes::StructureShape.new(name: 'JourneyLimits')
|
|
312
318
|
JourneyPushMessage = Shapes::StructureShape.new(name: 'JourneyPushMessage')
|
|
313
319
|
JourneyResponse = Shapes::StructureShape.new(name: 'JourneyResponse')
|
|
320
|
+
JourneyRunExecutionActivityMetricsResponse = Shapes::StructureShape.new(name: 'JourneyRunExecutionActivityMetricsResponse')
|
|
321
|
+
JourneyRunExecutionMetricsResponse = Shapes::StructureShape.new(name: 'JourneyRunExecutionMetricsResponse')
|
|
322
|
+
JourneyRunResponse = Shapes::StructureShape.new(name: 'JourneyRunResponse')
|
|
323
|
+
JourneyRunStatus = Shapes::StringShape.new(name: 'JourneyRunStatus')
|
|
324
|
+
JourneyRunsResponse = Shapes::StructureShape.new(name: 'JourneyRunsResponse')
|
|
314
325
|
JourneySMSMessage = Shapes::StructureShape.new(name: 'JourneySMSMessage')
|
|
315
326
|
JourneySchedule = Shapes::StructureShape.new(name: 'JourneySchedule')
|
|
316
327
|
JourneyStateRequest = Shapes::StructureShape.new(name: 'JourneyStateRequest')
|
|
@@ -329,6 +340,7 @@ module Aws::Pinpoint
|
|
|
329
340
|
ListOfInAppMessageCampaign = Shapes::ListShape.new(name: 'ListOfInAppMessageCampaign')
|
|
330
341
|
ListOfInAppMessageContent = Shapes::ListShape.new(name: 'ListOfInAppMessageContent')
|
|
331
342
|
ListOfJourneyResponse = Shapes::ListShape.new(name: 'ListOfJourneyResponse')
|
|
343
|
+
ListOfJourneyRunResponse = Shapes::ListShape.new(name: 'ListOfJourneyRunResponse')
|
|
332
344
|
ListOfMultiConditionalBranch = Shapes::ListShape.new(name: 'ListOfMultiConditionalBranch')
|
|
333
345
|
ListOfOpenHoursRules = Shapes::ListShape.new(name: 'ListOfOpenHoursRules')
|
|
334
346
|
ListOfRandomSplitEntry = Shapes::ListShape.new(name: 'ListOfRandomSplitEntry')
|
|
@@ -730,6 +742,7 @@ module Aws::Pinpoint
|
|
|
730
742
|
ActivityResponse.add_member(:timezones_total_count, Shapes::ShapeRef.new(shape: __integer, location_name: "TimezonesTotalCount"))
|
|
731
743
|
ActivityResponse.add_member(:total_endpoint_count, Shapes::ShapeRef.new(shape: __integer, location_name: "TotalEndpointCount"))
|
|
732
744
|
ActivityResponse.add_member(:treatment_id, Shapes::ShapeRef.new(shape: __string, location_name: "TreatmentId"))
|
|
745
|
+
ActivityResponse.add_member(:execution_metrics, Shapes::ShapeRef.new(shape: MapOf__string, location_name: "ExecutionMetrics"))
|
|
733
746
|
ActivityResponse.struct_class = Types::ActivityResponse
|
|
734
747
|
|
|
735
748
|
AddressConfiguration.add_member(:body_override, Shapes::ShapeRef.new(shape: __string, location_name: "BodyOverride"))
|
|
@@ -1934,6 +1947,42 @@ module Aws::Pinpoint
|
|
|
1934
1947
|
GetJourneyResponse[:payload] = :journey_response
|
|
1935
1948
|
GetJourneyResponse[:payload_member] = GetJourneyResponse.member(:journey_response)
|
|
1936
1949
|
|
|
1950
|
+
GetJourneyRunExecutionActivityMetricsRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
|
1951
|
+
GetJourneyRunExecutionActivityMetricsRequest.add_member(:journey_activity_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "journey-activity-id"))
|
|
1952
|
+
GetJourneyRunExecutionActivityMetricsRequest.add_member(:journey_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "journey-id"))
|
|
1953
|
+
GetJourneyRunExecutionActivityMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "next-token"))
|
|
1954
|
+
GetJourneyRunExecutionActivityMetricsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "page-size"))
|
|
1955
|
+
GetJourneyRunExecutionActivityMetricsRequest.add_member(:run_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "run-id"))
|
|
1956
|
+
GetJourneyRunExecutionActivityMetricsRequest.struct_class = Types::GetJourneyRunExecutionActivityMetricsRequest
|
|
1957
|
+
|
|
1958
|
+
GetJourneyRunExecutionActivityMetricsResponse.add_member(:journey_run_execution_activity_metrics_response, Shapes::ShapeRef.new(shape: JourneyRunExecutionActivityMetricsResponse, required: true, location_name: "JourneyRunExecutionActivityMetricsResponse"))
|
|
1959
|
+
GetJourneyRunExecutionActivityMetricsResponse.struct_class = Types::GetJourneyRunExecutionActivityMetricsResponse
|
|
1960
|
+
GetJourneyRunExecutionActivityMetricsResponse[:payload] = :journey_run_execution_activity_metrics_response
|
|
1961
|
+
GetJourneyRunExecutionActivityMetricsResponse[:payload_member] = GetJourneyRunExecutionActivityMetricsResponse.member(:journey_run_execution_activity_metrics_response)
|
|
1962
|
+
|
|
1963
|
+
GetJourneyRunExecutionMetricsRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
|
1964
|
+
GetJourneyRunExecutionMetricsRequest.add_member(:journey_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "journey-id"))
|
|
1965
|
+
GetJourneyRunExecutionMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "next-token"))
|
|
1966
|
+
GetJourneyRunExecutionMetricsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "page-size"))
|
|
1967
|
+
GetJourneyRunExecutionMetricsRequest.add_member(:run_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "run-id"))
|
|
1968
|
+
GetJourneyRunExecutionMetricsRequest.struct_class = Types::GetJourneyRunExecutionMetricsRequest
|
|
1969
|
+
|
|
1970
|
+
GetJourneyRunExecutionMetricsResponse.add_member(:journey_run_execution_metrics_response, Shapes::ShapeRef.new(shape: JourneyRunExecutionMetricsResponse, required: true, location_name: "JourneyRunExecutionMetricsResponse"))
|
|
1971
|
+
GetJourneyRunExecutionMetricsResponse.struct_class = Types::GetJourneyRunExecutionMetricsResponse
|
|
1972
|
+
GetJourneyRunExecutionMetricsResponse[:payload] = :journey_run_execution_metrics_response
|
|
1973
|
+
GetJourneyRunExecutionMetricsResponse[:payload_member] = GetJourneyRunExecutionMetricsResponse.member(:journey_run_execution_metrics_response)
|
|
1974
|
+
|
|
1975
|
+
GetJourneyRunsRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "application-id"))
|
|
1976
|
+
GetJourneyRunsRequest.add_member(:journey_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "journey-id"))
|
|
1977
|
+
GetJourneyRunsRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "page-size"))
|
|
1978
|
+
GetJourneyRunsRequest.add_member(:token, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "token"))
|
|
1979
|
+
GetJourneyRunsRequest.struct_class = Types::GetJourneyRunsRequest
|
|
1980
|
+
|
|
1981
|
+
GetJourneyRunsResponse.add_member(:journey_runs_response, Shapes::ShapeRef.new(shape: JourneyRunsResponse, required: true, location_name: "JourneyRunsResponse"))
|
|
1982
|
+
GetJourneyRunsResponse.struct_class = Types::GetJourneyRunsResponse
|
|
1983
|
+
GetJourneyRunsResponse[:payload] = :journey_runs_response
|
|
1984
|
+
GetJourneyRunsResponse[:payload_member] = GetJourneyRunsResponse.member(:journey_runs_response)
|
|
1985
|
+
|
|
1937
1986
|
GetPushTemplateRequest.add_member(:template_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "template-name"))
|
|
1938
1987
|
GetPushTemplateRequest.add_member(:version, Shapes::ShapeRef.new(shape: __string, location: "querystring", location_name: "version"))
|
|
1939
1988
|
GetPushTemplateRequest.struct_class = Types::GetPushTemplateRequest
|
|
@@ -2248,6 +2297,32 @@ module Aws::Pinpoint
|
|
|
2248
2297
|
JourneyResponse.add_member(:closed_days, Shapes::ShapeRef.new(shape: ClosedDays, location_name: "ClosedDays"))
|
|
2249
2298
|
JourneyResponse.struct_class = Types::JourneyResponse
|
|
2250
2299
|
|
|
2300
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:activity_type, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ActivityType"))
|
|
2301
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
|
|
2302
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:journey_activity_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "JourneyActivityId"))
|
|
2303
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:journey_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "JourneyId"))
|
|
2304
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:last_evaluated_time, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "LastEvaluatedTime"))
|
|
2305
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: MapOf__string, required: true, location_name: "Metrics"))
|
|
2306
|
+
JourneyRunExecutionActivityMetricsResponse.add_member(:run_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "RunId"))
|
|
2307
|
+
JourneyRunExecutionActivityMetricsResponse.struct_class = Types::JourneyRunExecutionActivityMetricsResponse
|
|
2308
|
+
|
|
2309
|
+
JourneyRunExecutionMetricsResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ApplicationId"))
|
|
2310
|
+
JourneyRunExecutionMetricsResponse.add_member(:journey_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "JourneyId"))
|
|
2311
|
+
JourneyRunExecutionMetricsResponse.add_member(:last_evaluated_time, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "LastEvaluatedTime"))
|
|
2312
|
+
JourneyRunExecutionMetricsResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: MapOf__string, required: true, location_name: "Metrics"))
|
|
2313
|
+
JourneyRunExecutionMetricsResponse.add_member(:run_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "RunId"))
|
|
2314
|
+
JourneyRunExecutionMetricsResponse.struct_class = Types::JourneyRunExecutionMetricsResponse
|
|
2315
|
+
|
|
2316
|
+
JourneyRunResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "CreationTime"))
|
|
2317
|
+
JourneyRunResponse.add_member(:last_update_time, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "LastUpdateTime"))
|
|
2318
|
+
JourneyRunResponse.add_member(:run_id, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "RunId"))
|
|
2319
|
+
JourneyRunResponse.add_member(:status, Shapes::ShapeRef.new(shape: JourneyRunStatus, required: true, location_name: "Status"))
|
|
2320
|
+
JourneyRunResponse.struct_class = Types::JourneyRunResponse
|
|
2321
|
+
|
|
2322
|
+
JourneyRunsResponse.add_member(:item, Shapes::ShapeRef.new(shape: ListOfJourneyRunResponse, required: true, location_name: "Item"))
|
|
2323
|
+
JourneyRunsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "NextToken"))
|
|
2324
|
+
JourneyRunsResponse.struct_class = Types::JourneyRunsResponse
|
|
2325
|
+
|
|
2251
2326
|
JourneySMSMessage.add_member(:message_type, Shapes::ShapeRef.new(shape: MessageType, location_name: "MessageType"))
|
|
2252
2327
|
JourneySMSMessage.add_member(:origination_number, Shapes::ShapeRef.new(shape: __string, location_name: "OriginationNumber"))
|
|
2253
2328
|
JourneySMSMessage.add_member(:sender_id, Shapes::ShapeRef.new(shape: __string, location_name: "SenderId"))
|
|
@@ -2299,6 +2374,8 @@ module Aws::Pinpoint
|
|
|
2299
2374
|
|
|
2300
2375
|
ListOfJourneyResponse.member = Shapes::ShapeRef.new(shape: JourneyResponse)
|
|
2301
2376
|
|
|
2377
|
+
ListOfJourneyRunResponse.member = Shapes::ShapeRef.new(shape: JourneyRunResponse)
|
|
2378
|
+
|
|
2302
2379
|
ListOfMultiConditionalBranch.member = Shapes::ShapeRef.new(shape: MultiConditionalBranch)
|
|
2303
2380
|
|
|
2304
2381
|
ListOfOpenHoursRules.member = Shapes::ShapeRef.new(shape: OpenHoursRule)
|
|
@@ -4401,6 +4478,51 @@ module Aws::Pinpoint
|
|
|
4401
4478
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
4402
4479
|
end)
|
|
4403
4480
|
|
|
4481
|
+
api.add_operation(:get_journey_run_execution_activity_metrics, Seahorse::Model::Operation.new.tap do |o|
|
|
4482
|
+
o.name = "GetJourneyRunExecutionActivityMetrics"
|
|
4483
|
+
o.http_method = "GET"
|
|
4484
|
+
o.http_request_uri = "/v1/apps/{application-id}/journeys/{journey-id}/runs/{run-id}/activities/{journey-activity-id}/execution-metrics"
|
|
4485
|
+
o.input = Shapes::ShapeRef.new(shape: GetJourneyRunExecutionActivityMetricsRequest)
|
|
4486
|
+
o.output = Shapes::ShapeRef.new(shape: GetJourneyRunExecutionActivityMetricsResponse)
|
|
4487
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
|
4488
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
|
4489
|
+
o.errors << Shapes::ShapeRef.new(shape: PayloadTooLargeException)
|
|
4490
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
|
4491
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
4492
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
|
4493
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
4494
|
+
end)
|
|
4495
|
+
|
|
4496
|
+
api.add_operation(:get_journey_run_execution_metrics, Seahorse::Model::Operation.new.tap do |o|
|
|
4497
|
+
o.name = "GetJourneyRunExecutionMetrics"
|
|
4498
|
+
o.http_method = "GET"
|
|
4499
|
+
o.http_request_uri = "/v1/apps/{application-id}/journeys/{journey-id}/runs/{run-id}/execution-metrics"
|
|
4500
|
+
o.input = Shapes::ShapeRef.new(shape: GetJourneyRunExecutionMetricsRequest)
|
|
4501
|
+
o.output = Shapes::ShapeRef.new(shape: GetJourneyRunExecutionMetricsResponse)
|
|
4502
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
|
4503
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
|
4504
|
+
o.errors << Shapes::ShapeRef.new(shape: PayloadTooLargeException)
|
|
4505
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
|
4506
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
4507
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
|
4508
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
4509
|
+
end)
|
|
4510
|
+
|
|
4511
|
+
api.add_operation(:get_journey_runs, Seahorse::Model::Operation.new.tap do |o|
|
|
4512
|
+
o.name = "GetJourneyRuns"
|
|
4513
|
+
o.http_method = "GET"
|
|
4514
|
+
o.http_request_uri = "/v1/apps/{application-id}/journeys/{journey-id}/runs"
|
|
4515
|
+
o.input = Shapes::ShapeRef.new(shape: GetJourneyRunsRequest)
|
|
4516
|
+
o.output = Shapes::ShapeRef.new(shape: GetJourneyRunsResponse)
|
|
4517
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
|
4518
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
|
4519
|
+
o.errors << Shapes::ShapeRef.new(shape: PayloadTooLargeException)
|
|
4520
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
|
4521
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
|
4522
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
|
4523
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
|
4524
|
+
end)
|
|
4525
|
+
|
|
4404
4526
|
api.add_operation(:get_push_template, Seahorse::Model::Operation.new.tap do |o|
|
|
4405
4527
|
o.name = "GetPushTemplate"
|
|
4406
4528
|
o.http_method = "GET"
|
|
@@ -14,36 +14,54 @@ module Aws::Pinpoint
|
|
|
14
14
|
use_dual_stack = parameters.use_dual_stack
|
|
15
15
|
use_fips = parameters.use_fips
|
|
16
16
|
endpoint = parameters.endpoint
|
|
17
|
-
if
|
|
18
|
-
if Aws::Endpoints::Matchers.
|
|
17
|
+
if Aws::Endpoints::Matchers.set?(endpoint)
|
|
18
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
19
|
+
raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
|
|
20
|
+
end
|
|
21
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
22
|
+
raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
|
|
23
|
+
end
|
|
24
|
+
return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
|
|
25
|
+
end
|
|
26
|
+
if Aws::Endpoints::Matchers.set?(region)
|
|
27
|
+
if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
|
|
28
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
29
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
30
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
31
|
+
end
|
|
32
|
+
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
|
33
|
+
end
|
|
19
34
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
20
|
-
|
|
35
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
|
|
36
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
37
|
+
end
|
|
38
|
+
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
|
21
39
|
end
|
|
22
40
|
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
23
|
-
|
|
41
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
42
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
43
|
+
end
|
|
44
|
+
raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
|
|
24
45
|
end
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
28
|
-
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
29
|
-
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
46
|
+
if Aws::Endpoints::Matchers.string_equals?(region, "us-east-1")
|
|
47
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.us-east-1.amazonaws.com", headers: {}, properties: {})
|
|
30
48
|
end
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
34
|
-
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
|
|
35
|
-
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
49
|
+
if Aws::Endpoints::Matchers.string_equals?(region, "us-west-2")
|
|
50
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.us-west-2.amazonaws.com", headers: {}, properties: {})
|
|
36
51
|
end
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
if Aws::Endpoints::Matchers.
|
|
41
|
-
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.#{region}
|
|
52
|
+
if Aws::Endpoints::Matchers.string_equals?(region, "us-gov-west-1")
|
|
53
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.us-gov-west-1.amazonaws.com", headers: {}, properties: {})
|
|
54
|
+
end
|
|
55
|
+
if Aws::Endpoints::Matchers.string_equals?("aws", Aws::Endpoints::Matchers.attr(partition_result, "name"))
|
|
56
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.#{region}.amazonaws.com", headers: {}, properties: {})
|
|
57
|
+
end
|
|
58
|
+
if Aws::Endpoints::Matchers.string_equals?("aws-us-gov", Aws::Endpoints::Matchers.attr(partition_result, "name"))
|
|
59
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.#{region}.amazonaws.com", headers: {}, properties: {})
|
|
42
60
|
end
|
|
43
|
-
|
|
61
|
+
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
44
62
|
end
|
|
45
|
-
return Aws::Endpoints::Endpoint.new(url: "https://pinpoint.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
46
63
|
end
|
|
64
|
+
raise ArgumentError, "Invalid Configuration: Missing Region"
|
|
47
65
|
raise ArgumentError, 'No endpoint could be resolved'
|
|
48
66
|
|
|
49
67
|
end
|
|
@@ -949,6 +949,48 @@ module Aws::Pinpoint
|
|
|
949
949
|
end
|
|
950
950
|
end
|
|
951
951
|
|
|
952
|
+
class GetJourneyRunExecutionActivityMetrics
|
|
953
|
+
def self.build(context)
|
|
954
|
+
unless context.config.regional_endpoint
|
|
955
|
+
endpoint = context.config.endpoint.to_s
|
|
956
|
+
end
|
|
957
|
+
Aws::Pinpoint::EndpointParameters.new(
|
|
958
|
+
region: context.config.region,
|
|
959
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
|
960
|
+
use_fips: context.config.use_fips_endpoint,
|
|
961
|
+
endpoint: endpoint,
|
|
962
|
+
)
|
|
963
|
+
end
|
|
964
|
+
end
|
|
965
|
+
|
|
966
|
+
class GetJourneyRunExecutionMetrics
|
|
967
|
+
def self.build(context)
|
|
968
|
+
unless context.config.regional_endpoint
|
|
969
|
+
endpoint = context.config.endpoint.to_s
|
|
970
|
+
end
|
|
971
|
+
Aws::Pinpoint::EndpointParameters.new(
|
|
972
|
+
region: context.config.region,
|
|
973
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
|
974
|
+
use_fips: context.config.use_fips_endpoint,
|
|
975
|
+
endpoint: endpoint,
|
|
976
|
+
)
|
|
977
|
+
end
|
|
978
|
+
end
|
|
979
|
+
|
|
980
|
+
class GetJourneyRuns
|
|
981
|
+
def self.build(context)
|
|
982
|
+
unless context.config.regional_endpoint
|
|
983
|
+
endpoint = context.config.endpoint.to_s
|
|
984
|
+
end
|
|
985
|
+
Aws::Pinpoint::EndpointParameters.new(
|
|
986
|
+
region: context.config.region,
|
|
987
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
|
988
|
+
use_fips: context.config.use_fips_endpoint,
|
|
989
|
+
endpoint: endpoint,
|
|
990
|
+
)
|
|
991
|
+
end
|
|
992
|
+
end
|
|
993
|
+
|
|
952
994
|
class GetPushTemplate
|
|
953
995
|
def self.build(context)
|
|
954
996
|
unless context.config.regional_endpoint
|
|
@@ -190,6 +190,12 @@ module Aws::Pinpoint
|
|
|
190
190
|
Aws::Pinpoint::Endpoints::GetJourneyExecutionActivityMetrics.build(context)
|
|
191
191
|
when :get_journey_execution_metrics
|
|
192
192
|
Aws::Pinpoint::Endpoints::GetJourneyExecutionMetrics.build(context)
|
|
193
|
+
when :get_journey_run_execution_activity_metrics
|
|
194
|
+
Aws::Pinpoint::Endpoints::GetJourneyRunExecutionActivityMetrics.build(context)
|
|
195
|
+
when :get_journey_run_execution_metrics
|
|
196
|
+
Aws::Pinpoint::Endpoints::GetJourneyRunExecutionMetrics.build(context)
|
|
197
|
+
when :get_journey_runs
|
|
198
|
+
Aws::Pinpoint::Endpoints::GetJourneyRuns.build(context)
|
|
193
199
|
when :get_push_template
|
|
194
200
|
Aws::Pinpoint::Endpoints::GetPushTemplate.build(context)
|
|
195
201
|
when :get_recommender_configuration
|
|
@@ -1257,6 +1257,17 @@ module Aws::Pinpoint
|
|
|
1257
1257
|
# for A/B testing of a campaign.
|
|
1258
1258
|
# @return [String]
|
|
1259
1259
|
#
|
|
1260
|
+
# @!attribute [rw] execution_metrics
|
|
1261
|
+
# A JSON object that contains metrics relating to the campaign
|
|
1262
|
+
# execution for this campaign activity. For information about the
|
|
1263
|
+
# structure and contents of the results, see [Standard Amazon Pinpoint
|
|
1264
|
+
# analytics metrics][1] in the *Amazon Pinpoint Developer Guide*.
|
|
1265
|
+
#
|
|
1266
|
+
#
|
|
1267
|
+
#
|
|
1268
|
+
# [1]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html
|
|
1269
|
+
# @return [Hash<String,String>]
|
|
1270
|
+
#
|
|
1260
1271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ActivityResponse AWS API Documentation
|
|
1261
1272
|
#
|
|
1262
1273
|
class ActivityResponse < Struct.new(
|
|
@@ -1272,7 +1283,8 @@ module Aws::Pinpoint
|
|
|
1272
1283
|
:timezones_completed_count,
|
|
1273
1284
|
:timezones_total_count,
|
|
1274
1285
|
:total_endpoint_count,
|
|
1275
|
-
:treatment_id
|
|
1286
|
+
:treatment_id,
|
|
1287
|
+
:execution_metrics)
|
|
1276
1288
|
SENSITIVE = []
|
|
1277
1289
|
include Aws::Structure
|
|
1278
1290
|
end
|
|
@@ -5291,10 +5303,10 @@ module Aws::Pinpoint
|
|
|
5291
5303
|
# to.
|
|
5292
5304
|
#
|
|
5293
5305
|
# For a Kinesis data stream, the ARN format is:
|
|
5294
|
-
# arn:aws:kinesis:*region
|
|
5306
|
+
# arn:aws:kinesis:*region*:*account-id*:stream/*stream\_name*
|
|
5295
5307
|
#
|
|
5296
5308
|
# For a Kinesis Data Firehose delivery stream, the ARN format is:
|
|
5297
|
-
# arn:aws:firehose:*region
|
|
5309
|
+
# arn:aws:firehose:*region*:*account-id*:deliverystream/*stream\_name*
|
|
5298
5310
|
# @return [String]
|
|
5299
5311
|
#
|
|
5300
5312
|
# @!attribute [rw] external_id
|
|
@@ -6863,6 +6875,127 @@ module Aws::Pinpoint
|
|
|
6863
6875
|
include Aws::Structure
|
|
6864
6876
|
end
|
|
6865
6877
|
|
|
6878
|
+
# @!attribute [rw] application_id
|
|
6879
|
+
# @return [String]
|
|
6880
|
+
#
|
|
6881
|
+
# @!attribute [rw] journey_activity_id
|
|
6882
|
+
# @return [String]
|
|
6883
|
+
#
|
|
6884
|
+
# @!attribute [rw] journey_id
|
|
6885
|
+
# @return [String]
|
|
6886
|
+
#
|
|
6887
|
+
# @!attribute [rw] next_token
|
|
6888
|
+
# @return [String]
|
|
6889
|
+
#
|
|
6890
|
+
# @!attribute [rw] page_size
|
|
6891
|
+
# @return [String]
|
|
6892
|
+
#
|
|
6893
|
+
# @!attribute [rw] run_id
|
|
6894
|
+
# @return [String]
|
|
6895
|
+
#
|
|
6896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunExecutionActivityMetricsRequest AWS API Documentation
|
|
6897
|
+
#
|
|
6898
|
+
class GetJourneyRunExecutionActivityMetricsRequest < Struct.new(
|
|
6899
|
+
:application_id,
|
|
6900
|
+
:journey_activity_id,
|
|
6901
|
+
:journey_id,
|
|
6902
|
+
:next_token,
|
|
6903
|
+
:page_size,
|
|
6904
|
+
:run_id)
|
|
6905
|
+
SENSITIVE = []
|
|
6906
|
+
include Aws::Structure
|
|
6907
|
+
end
|
|
6908
|
+
|
|
6909
|
+
# @!attribute [rw] journey_run_execution_activity_metrics_response
|
|
6910
|
+
# Provides the results of a query that retrieved the data for a
|
|
6911
|
+
# standard execution metric that applies to a journey activity for a
|
|
6912
|
+
# particular journey run, and provides information about that query.
|
|
6913
|
+
# @return [Types::JourneyRunExecutionActivityMetricsResponse]
|
|
6914
|
+
#
|
|
6915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunExecutionActivityMetricsResponse AWS API Documentation
|
|
6916
|
+
#
|
|
6917
|
+
class GetJourneyRunExecutionActivityMetricsResponse < Struct.new(
|
|
6918
|
+
:journey_run_execution_activity_metrics_response)
|
|
6919
|
+
SENSITIVE = []
|
|
6920
|
+
include Aws::Structure
|
|
6921
|
+
end
|
|
6922
|
+
|
|
6923
|
+
# @!attribute [rw] application_id
|
|
6924
|
+
# @return [String]
|
|
6925
|
+
#
|
|
6926
|
+
# @!attribute [rw] journey_id
|
|
6927
|
+
# @return [String]
|
|
6928
|
+
#
|
|
6929
|
+
# @!attribute [rw] next_token
|
|
6930
|
+
# @return [String]
|
|
6931
|
+
#
|
|
6932
|
+
# @!attribute [rw] page_size
|
|
6933
|
+
# @return [String]
|
|
6934
|
+
#
|
|
6935
|
+
# @!attribute [rw] run_id
|
|
6936
|
+
# @return [String]
|
|
6937
|
+
#
|
|
6938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunExecutionMetricsRequest AWS API Documentation
|
|
6939
|
+
#
|
|
6940
|
+
class GetJourneyRunExecutionMetricsRequest < Struct.new(
|
|
6941
|
+
:application_id,
|
|
6942
|
+
:journey_id,
|
|
6943
|
+
:next_token,
|
|
6944
|
+
:page_size,
|
|
6945
|
+
:run_id)
|
|
6946
|
+
SENSITIVE = []
|
|
6947
|
+
include Aws::Structure
|
|
6948
|
+
end
|
|
6949
|
+
|
|
6950
|
+
# @!attribute [rw] journey_run_execution_metrics_response
|
|
6951
|
+
# Provides the results of a query that retrieved the data for a
|
|
6952
|
+
# standard execution metric that applies to a journey run, and
|
|
6953
|
+
# provides information about that query.
|
|
6954
|
+
# @return [Types::JourneyRunExecutionMetricsResponse]
|
|
6955
|
+
#
|
|
6956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunExecutionMetricsResponse AWS API Documentation
|
|
6957
|
+
#
|
|
6958
|
+
class GetJourneyRunExecutionMetricsResponse < Struct.new(
|
|
6959
|
+
:journey_run_execution_metrics_response)
|
|
6960
|
+
SENSITIVE = []
|
|
6961
|
+
include Aws::Structure
|
|
6962
|
+
end
|
|
6963
|
+
|
|
6964
|
+
# @!attribute [rw] application_id
|
|
6965
|
+
# @return [String]
|
|
6966
|
+
#
|
|
6967
|
+
# @!attribute [rw] journey_id
|
|
6968
|
+
# @return [String]
|
|
6969
|
+
#
|
|
6970
|
+
# @!attribute [rw] page_size
|
|
6971
|
+
# @return [String]
|
|
6972
|
+
#
|
|
6973
|
+
# @!attribute [rw] token
|
|
6974
|
+
# @return [String]
|
|
6975
|
+
#
|
|
6976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunsRequest AWS API Documentation
|
|
6977
|
+
#
|
|
6978
|
+
class GetJourneyRunsRequest < Struct.new(
|
|
6979
|
+
:application_id,
|
|
6980
|
+
:journey_id,
|
|
6981
|
+
:page_size,
|
|
6982
|
+
:token)
|
|
6983
|
+
SENSITIVE = []
|
|
6984
|
+
include Aws::Structure
|
|
6985
|
+
end
|
|
6986
|
+
|
|
6987
|
+
# @!attribute [rw] journey_runs_response
|
|
6988
|
+
# Provides information from all runs of a journey.
|
|
6989
|
+
# @return [Types::JourneyRunsResponse]
|
|
6990
|
+
#
|
|
6991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRunsResponse AWS API Documentation
|
|
6992
|
+
#
|
|
6993
|
+
class GetJourneyRunsResponse < Struct.new(
|
|
6994
|
+
:journey_runs_response)
|
|
6995
|
+
SENSITIVE = []
|
|
6996
|
+
include Aws::Structure
|
|
6997
|
+
end
|
|
6998
|
+
|
|
6866
6999
|
# @!attribute [rw] template_name
|
|
6867
7000
|
# @return [String]
|
|
6868
7001
|
#
|
|
@@ -8054,25 +8187,25 @@ module Aws::Pinpoint
|
|
|
8054
8187
|
# The type of activity that the metric applies to. Possible values
|
|
8055
8188
|
# are:
|
|
8056
8189
|
#
|
|
8057
|
-
# * CONDITIONAL\_SPLIT
|
|
8190
|
+
# * CONDITIONAL\_SPLIT – For a yes/no split activity, which is an
|
|
8058
8191
|
# activity that sends participants down one of two paths in a
|
|
8059
8192
|
# journey.
|
|
8060
8193
|
#
|
|
8061
|
-
# * HOLDOUT
|
|
8194
|
+
# * HOLDOUT – For a holdout activity, which is an activity that stops
|
|
8062
8195
|
# a journey for a specified percentage of participants.
|
|
8063
8196
|
#
|
|
8064
|
-
# * MESSAGE
|
|
8197
|
+
# * MESSAGE – For an email activity, which is an activity that sends
|
|
8065
8198
|
# an email message to participants.
|
|
8066
8199
|
#
|
|
8067
|
-
# * MULTI\_CONDITIONAL\_SPLIT
|
|
8200
|
+
# * MULTI\_CONDITIONAL\_SPLIT – For a multivariate split activity,
|
|
8068
8201
|
# which is an activity that sends participants down one of as many
|
|
8069
8202
|
# as five paths in a journey.
|
|
8070
8203
|
#
|
|
8071
|
-
# * RANDOM\_SPLIT
|
|
8204
|
+
# * RANDOM\_SPLIT – For a random split activity, which is an activity
|
|
8072
8205
|
# that sends specified percentages of participants down one of as
|
|
8073
8206
|
# many as five paths in a journey.
|
|
8074
8207
|
#
|
|
8075
|
-
# * WAIT
|
|
8208
|
+
# * WAIT – For a wait activity, which is an activity that waits for a
|
|
8076
8209
|
# certain amount of time or until a specific date and time before
|
|
8077
8210
|
# moving participants to the next activity in a journey.
|
|
8078
8211
|
# @return [String]
|
|
@@ -8179,6 +8312,8 @@ module Aws::Pinpoint
|
|
|
8179
8312
|
# @return [Integer]
|
|
8180
8313
|
#
|
|
8181
8314
|
# @!attribute [rw] endpoint_reentry_interval
|
|
8315
|
+
# Minimum time that must pass before an endpoint can re-enter a given
|
|
8316
|
+
# journey.
|
|
8182
8317
|
# @return [String]
|
|
8183
8318
|
#
|
|
8184
8319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyLimits AWS API Documentation
|
|
@@ -8199,7 +8334,7 @@ module Aws::Pinpoint
|
|
|
8199
8334
|
# The number of seconds that the push notification service should keep
|
|
8200
8335
|
# the message, if the service is unable to deliver the notification
|
|
8201
8336
|
# the first time. This value is converted to an expiration value when
|
|
8202
|
-
# it's sent to a push
|
|
8337
|
+
# it's sent to a push notification service. If this value is 0, the
|
|
8203
8338
|
# service treats the notification as if it expires immediately and the
|
|
8204
8339
|
# service doesn't store or try to deliver the notification again.
|
|
8205
8340
|
#
|
|
@@ -8354,9 +8489,13 @@ module Aws::Pinpoint
|
|
|
8354
8489
|
# @return [Hash<String,String>]
|
|
8355
8490
|
#
|
|
8356
8491
|
# @!attribute [rw] wait_for_quiet_time
|
|
8492
|
+
# Indicates whether endpoints in quiet hours should enter a wait
|
|
8493
|
+
# activity until quiet hours have elapsed.
|
|
8357
8494
|
# @return [Boolean]
|
|
8358
8495
|
#
|
|
8359
8496
|
# @!attribute [rw] refresh_on_segment_update
|
|
8497
|
+
# Indicates whether the journey participants should be refreshed when
|
|
8498
|
+
# a segment is updated.
|
|
8360
8499
|
# @return [Boolean]
|
|
8361
8500
|
#
|
|
8362
8501
|
# @!attribute [rw] journey_channel_settings
|
|
@@ -8364,19 +8503,19 @@ module Aws::Pinpoint
|
|
|
8364
8503
|
# @return [Types::JourneyChannelSettings]
|
|
8365
8504
|
#
|
|
8366
8505
|
# @!attribute [rw] sending_schedule
|
|
8367
|
-
# Indicates if journey
|
|
8368
|
-
#
|
|
8369
|
-
#
|
|
8506
|
+
# Indicates if journey has Advance Quiet Time enabled. This flag
|
|
8507
|
+
# should be set to true in order to allow using OpenHours and
|
|
8508
|
+
# ClosedDays.
|
|
8370
8509
|
# @return [Boolean]
|
|
8371
8510
|
#
|
|
8372
8511
|
# @!attribute [rw] open_hours
|
|
8373
|
-
# The time when journey
|
|
8512
|
+
# The time when a journey can send messages. QuietTime should be
|
|
8374
8513
|
# configured first and SendingSchedule should be set to true.
|
|
8375
8514
|
# @return [Types::OpenHours]
|
|
8376
8515
|
#
|
|
8377
8516
|
# @!attribute [rw] closed_days
|
|
8378
|
-
# The time when journey will
|
|
8379
|
-
#
|
|
8517
|
+
# The time when a journey will not send messages. QuietTime should be
|
|
8518
|
+
# configured first and SendingSchedule should be set to true.
|
|
8380
8519
|
# @return [Types::ClosedDays]
|
|
8381
8520
|
#
|
|
8382
8521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyResponse AWS API Documentation
|
|
@@ -8407,6 +8546,183 @@ module Aws::Pinpoint
|
|
|
8407
8546
|
include Aws::Structure
|
|
8408
8547
|
end
|
|
8409
8548
|
|
|
8549
|
+
# Provides the results of a query that retrieved the data for a standard
|
|
8550
|
+
# execution metric that applies to a journey activity for a particular
|
|
8551
|
+
# journey run, and provides information about that query.
|
|
8552
|
+
#
|
|
8553
|
+
# @!attribute [rw] activity_type
|
|
8554
|
+
# The type of activity that the metric applies to. Possible values
|
|
8555
|
+
# are:
|
|
8556
|
+
#
|
|
8557
|
+
# * CONDITIONAL\_SPLIT – For a yes/no split activity, which is an
|
|
8558
|
+
# activity that sends participants down one of two paths in a
|
|
8559
|
+
# journey.
|
|
8560
|
+
#
|
|
8561
|
+
# * HOLDOUT – For a holdout activity, which is an activity that stops
|
|
8562
|
+
# a journey for a specified percentage of participants.
|
|
8563
|
+
#
|
|
8564
|
+
# * MESSAGE – For an email activity, which is an activity that sends
|
|
8565
|
+
# an email message to participants.
|
|
8566
|
+
#
|
|
8567
|
+
# * MULTI\_CONDITIONAL\_SPLIT – For a multivariate split activity,
|
|
8568
|
+
# which is an activity that sends participants down one of as many
|
|
8569
|
+
# as five paths in a journey.
|
|
8570
|
+
#
|
|
8571
|
+
# * RANDOM\_SPLIT – For a random split activity, which is an activity
|
|
8572
|
+
# that sends specified percentages of participants down one of as
|
|
8573
|
+
# many as five paths in a journey.
|
|
8574
|
+
#
|
|
8575
|
+
# * WAIT – For a wait activity, which is an activity that waits for a
|
|
8576
|
+
# certain amount of time or until a specific date and time before
|
|
8577
|
+
# moving participants to the next activity in a journey.
|
|
8578
|
+
# @return [String]
|
|
8579
|
+
#
|
|
8580
|
+
# @!attribute [rw] application_id
|
|
8581
|
+
# The unique identifier for the application that the metric applies
|
|
8582
|
+
# to.
|
|
8583
|
+
# @return [String]
|
|
8584
|
+
#
|
|
8585
|
+
# @!attribute [rw] journey_activity_id
|
|
8586
|
+
# The unique identifier for the activity that the metric applies to.
|
|
8587
|
+
# @return [String]
|
|
8588
|
+
#
|
|
8589
|
+
# @!attribute [rw] journey_id
|
|
8590
|
+
# The unique identifier for the journey that the metric applies to.
|
|
8591
|
+
# @return [String]
|
|
8592
|
+
#
|
|
8593
|
+
# @!attribute [rw] last_evaluated_time
|
|
8594
|
+
# The date and time, in ISO 8601 format, when Amazon Pinpoint last
|
|
8595
|
+
# evaluated the execution status of the activity for this journey run
|
|
8596
|
+
# and updated the data for the metric.
|
|
8597
|
+
# @return [String]
|
|
8598
|
+
#
|
|
8599
|
+
# @!attribute [rw] metrics
|
|
8600
|
+
# A JSON object that contains the results of the query. For
|
|
8601
|
+
# information about the structure and contents of the results, see see
|
|
8602
|
+
# [Standard Amazon Pinpoint analytics metrics][1] in the *Amazon
|
|
8603
|
+
# Pinpoint Developer Guide*.
|
|
8604
|
+
#
|
|
8605
|
+
#
|
|
8606
|
+
#
|
|
8607
|
+
# [1]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html
|
|
8608
|
+
# @return [Hash<String,String>]
|
|
8609
|
+
#
|
|
8610
|
+
# @!attribute [rw] run_id
|
|
8611
|
+
# The unique identifier for the journey run that the metric applies
|
|
8612
|
+
# to.
|
|
8613
|
+
# @return [String]
|
|
8614
|
+
#
|
|
8615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyRunExecutionActivityMetricsResponse AWS API Documentation
|
|
8616
|
+
#
|
|
8617
|
+
class JourneyRunExecutionActivityMetricsResponse < Struct.new(
|
|
8618
|
+
:activity_type,
|
|
8619
|
+
:application_id,
|
|
8620
|
+
:journey_activity_id,
|
|
8621
|
+
:journey_id,
|
|
8622
|
+
:last_evaluated_time,
|
|
8623
|
+
:metrics,
|
|
8624
|
+
:run_id)
|
|
8625
|
+
SENSITIVE = []
|
|
8626
|
+
include Aws::Structure
|
|
8627
|
+
end
|
|
8628
|
+
|
|
8629
|
+
# Provides the results of a query that retrieved the data for a standard
|
|
8630
|
+
# execution metric that applies to a journey run, and provides
|
|
8631
|
+
# information about that query.
|
|
8632
|
+
#
|
|
8633
|
+
# @!attribute [rw] application_id
|
|
8634
|
+
# The unique identifier for the application that the metric applies
|
|
8635
|
+
# to.
|
|
8636
|
+
# @return [String]
|
|
8637
|
+
#
|
|
8638
|
+
# @!attribute [rw] journey_id
|
|
8639
|
+
# The unique identifier for the journey that the metric applies to.
|
|
8640
|
+
# @return [String]
|
|
8641
|
+
#
|
|
8642
|
+
# @!attribute [rw] last_evaluated_time
|
|
8643
|
+
# The date and time, in ISO 8601 format, when Amazon Pinpoint last
|
|
8644
|
+
# evaluated the journey run and updated the data for the metric.
|
|
8645
|
+
# @return [String]
|
|
8646
|
+
#
|
|
8647
|
+
# @!attribute [rw] metrics
|
|
8648
|
+
# A JSON object that contains the results of the query. For
|
|
8649
|
+
# information about the structure and contents of the results, see the
|
|
8650
|
+
# [Standard Amazon Pinpoint analytics metrics][1] in the *Amazon
|
|
8651
|
+
# Pinpoint Developer Guide*.
|
|
8652
|
+
#
|
|
8653
|
+
#
|
|
8654
|
+
#
|
|
8655
|
+
# [1]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html
|
|
8656
|
+
# @return [Hash<String,String>]
|
|
8657
|
+
#
|
|
8658
|
+
# @!attribute [rw] run_id
|
|
8659
|
+
# The unique identifier for the journey run that the metric applies
|
|
8660
|
+
# to.
|
|
8661
|
+
# @return [String]
|
|
8662
|
+
#
|
|
8663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyRunExecutionMetricsResponse AWS API Documentation
|
|
8664
|
+
#
|
|
8665
|
+
class JourneyRunExecutionMetricsResponse < Struct.new(
|
|
8666
|
+
:application_id,
|
|
8667
|
+
:journey_id,
|
|
8668
|
+
:last_evaluated_time,
|
|
8669
|
+
:metrics,
|
|
8670
|
+
:run_id)
|
|
8671
|
+
SENSITIVE = []
|
|
8672
|
+
include Aws::Structure
|
|
8673
|
+
end
|
|
8674
|
+
|
|
8675
|
+
# Provides information from a specified run of a journey.
|
|
8676
|
+
#
|
|
8677
|
+
# @!attribute [rw] creation_time
|
|
8678
|
+
# The time when the journey run was created or scheduled, in ISO 8601
|
|
8679
|
+
# format.
|
|
8680
|
+
# @return [String]
|
|
8681
|
+
#
|
|
8682
|
+
# @!attribute [rw] last_update_time
|
|
8683
|
+
# The last time the journey run was updated, in ISO 8601 format..
|
|
8684
|
+
# @return [String]
|
|
8685
|
+
#
|
|
8686
|
+
# @!attribute [rw] run_id
|
|
8687
|
+
# The unique identifier for the run.
|
|
8688
|
+
# @return [String]
|
|
8689
|
+
#
|
|
8690
|
+
# @!attribute [rw] status
|
|
8691
|
+
# The current status of the journey run.
|
|
8692
|
+
# @return [String]
|
|
8693
|
+
#
|
|
8694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyRunResponse AWS API Documentation
|
|
8695
|
+
#
|
|
8696
|
+
class JourneyRunResponse < Struct.new(
|
|
8697
|
+
:creation_time,
|
|
8698
|
+
:last_update_time,
|
|
8699
|
+
:run_id,
|
|
8700
|
+
:status)
|
|
8701
|
+
SENSITIVE = []
|
|
8702
|
+
include Aws::Structure
|
|
8703
|
+
end
|
|
8704
|
+
|
|
8705
|
+
# Provides information from all runs of a journey.
|
|
8706
|
+
#
|
|
8707
|
+
# @!attribute [rw] item
|
|
8708
|
+
# An array of responses, one for each run of the journey
|
|
8709
|
+
# @return [Array<Types::JourneyRunResponse>]
|
|
8710
|
+
#
|
|
8711
|
+
# @!attribute [rw] next_token
|
|
8712
|
+
# The string to use in a subsequent request to get the next page of
|
|
8713
|
+
# results in a paginated response. This value is null if there are no
|
|
8714
|
+
# additional pages.
|
|
8715
|
+
# @return [String]
|
|
8716
|
+
#
|
|
8717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyRunsResponse AWS API Documentation
|
|
8718
|
+
#
|
|
8719
|
+
class JourneyRunsResponse < Struct.new(
|
|
8720
|
+
:item,
|
|
8721
|
+
:next_token)
|
|
8722
|
+
SENSITIVE = []
|
|
8723
|
+
include Aws::Structure
|
|
8724
|
+
end
|
|
8725
|
+
|
|
8410
8726
|
# Specifies the sender ID and message type for an SMS message that's
|
|
8411
8727
|
# sent to participants in a journey.
|
|
8412
8728
|
#
|
|
@@ -13206,10 +13522,10 @@ module Aws::Pinpoint
|
|
|
13206
13522
|
# publish event data to.
|
|
13207
13523
|
#
|
|
13208
13524
|
# For a Kinesis data stream, the ARN format is:
|
|
13209
|
-
# arn:aws:kinesis:*region
|
|
13525
|
+
# arn:aws:kinesis:*region*:*account-id*:stream/*stream\_name*
|
|
13210
13526
|
#
|
|
13211
13527
|
# For a Kinesis Data Firehose delivery stream, the ARN format is:
|
|
13212
|
-
# arn:aws:firehose:*region
|
|
13528
|
+
# arn:aws:firehose:*region*:*account-id*:deliverystream/*stream\_name*
|
|
13213
13529
|
# @return [String]
|
|
13214
13530
|
#
|
|
13215
13531
|
# @!attribute [rw] role_arn
|
|
@@ -13322,9 +13638,13 @@ module Aws::Pinpoint
|
|
|
13322
13638
|
# @return [String]
|
|
13323
13639
|
#
|
|
13324
13640
|
# @!attribute [rw] wait_for_quiet_time
|
|
13641
|
+
# Indicates whether endpoints in quiet hours should enter a wait
|
|
13642
|
+
# activity until quiet hours have elapsed.
|
|
13325
13643
|
# @return [Boolean]
|
|
13326
13644
|
#
|
|
13327
13645
|
# @!attribute [rw] refresh_on_segment_update
|
|
13646
|
+
# Indicates whether the journey participants should be refreshed when
|
|
13647
|
+
# a segment is updated.
|
|
13328
13648
|
# @return [Boolean]
|
|
13329
13649
|
#
|
|
13330
13650
|
# @!attribute [rw] journey_channel_settings
|
|
@@ -13333,9 +13653,9 @@ module Aws::Pinpoint
|
|
|
13333
13653
|
# @return [Types::JourneyChannelSettings]
|
|
13334
13654
|
#
|
|
13335
13655
|
# @!attribute [rw] sending_schedule
|
|
13336
|
-
# Indicates if journey
|
|
13337
|
-
#
|
|
13338
|
-
#
|
|
13656
|
+
# Indicates if journey has Advance Quiet Time enabled. This flag
|
|
13657
|
+
# should be set to true in order to allow using OpenHours and
|
|
13658
|
+
# ClosedDays.
|
|
13339
13659
|
# @return [Boolean]
|
|
13340
13660
|
#
|
|
13341
13661
|
# @!attribute [rw] open_hours
|
|
@@ -13458,14 +13778,16 @@ module Aws::Pinpoint
|
|
|
13458
13778
|
include Aws::Structure
|
|
13459
13779
|
end
|
|
13460
13780
|
|
|
13461
|
-
#
|
|
13781
|
+
# Specifies the start and end time for OpenHours.
|
|
13462
13782
|
#
|
|
13463
13783
|
# @!attribute [rw] start_time
|
|
13464
|
-
#
|
|
13784
|
+
# The start of the scheduled time, in ISO 8601 format, when the
|
|
13785
|
+
# channel can send messages.
|
|
13465
13786
|
# @return [String]
|
|
13466
13787
|
#
|
|
13467
13788
|
# @!attribute [rw] end_time
|
|
13468
|
-
#
|
|
13789
|
+
# The end of the scheduled time, in ISO 8601 format, when the channel
|
|
13790
|
+
# can't send messages.
|
|
13469
13791
|
# @return [String]
|
|
13470
13792
|
#
|
|
13471
13793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/OpenHoursRule AWS API Documentation
|
|
@@ -13477,8 +13799,7 @@ module Aws::Pinpoint
|
|
|
13477
13799
|
include Aws::Structure
|
|
13478
13800
|
end
|
|
13479
13801
|
|
|
13480
|
-
#
|
|
13481
|
-
# configured first and SendingSchedule should be set to true.
|
|
13802
|
+
# Specifies the times when message are allowed to be sent to endpoints.
|
|
13482
13803
|
#
|
|
13483
13804
|
# @!attribute [rw] email
|
|
13484
13805
|
# Rules for Email Channel.
|
|
@@ -13512,18 +13833,18 @@ module Aws::Pinpoint
|
|
|
13512
13833
|
include Aws::Structure
|
|
13513
13834
|
end
|
|
13514
13835
|
|
|
13515
|
-
#
|
|
13836
|
+
# Specifies the rule settings for when messages can't be sent.
|
|
13516
13837
|
#
|
|
13517
13838
|
# @!attribute [rw] name
|
|
13518
|
-
#
|
|
13839
|
+
# The name of the closed day rule.
|
|
13519
13840
|
# @return [String]
|
|
13520
13841
|
#
|
|
13521
13842
|
# @!attribute [rw] start_date_time
|
|
13522
|
-
# Start
|
|
13843
|
+
# Start DateTime ISO 8601 format
|
|
13523
13844
|
# @return [String]
|
|
13524
13845
|
#
|
|
13525
13846
|
# @!attribute [rw] end_date_time
|
|
13526
|
-
# End
|
|
13847
|
+
# End DateTime ISO 8601 format
|
|
13527
13848
|
# @return [String]
|
|
13528
13849
|
#
|
|
13529
13850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/ClosedDaysRule AWS API Documentation
|
|
@@ -13536,7 +13857,8 @@ module Aws::Pinpoint
|
|
|
13536
13857
|
include Aws::Structure
|
|
13537
13858
|
end
|
|
13538
13859
|
|
|
13539
|
-
# The time when journey will
|
|
13860
|
+
# The time when a journey will not send messages. QuietTime should be
|
|
13861
|
+
# configured first and SendingSchedule should be set to true.
|
|
13540
13862
|
#
|
|
13541
13863
|
# @!attribute [rw] email
|
|
13542
13864
|
# Rules for a Channel.
|
data/lib/aws-sdk-pinpoint.rb
CHANGED
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.71.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: 2023-
|
|
11
|
+
date: 2023-04-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|