You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Pinpoint::Types::CreateJourneyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::CreateJourneyRequest
- Defined in:
- (unknown)
Overview
Note:
When passing CreateJourneyRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
application_id: "__string", # required
write_journey_request: { # required
activities: {
"__string" => {
custom: {
delivery_uri: "__string",
endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
message_config: {
data: "__string",
},
next_activity: "__string",
template_name: "__string",
template_version: "__string",
},
conditional_split: {
condition: {
conditions: [
{
event_condition: {
dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
},
message_activity: "__string",
},
segment_condition: {
segment_id: "__string", # required
},
segment_dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
behavior: {
recency: {
duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
},
},
demographic: {
app_version: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
channel: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
device_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
make: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
model: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
platform: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
location: {
country: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
gps_point: {
coordinates: { # required
latitude: 1.0, # required
longitude: 1.0, # required
},
range_in_kilometers: 1.0,
},
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
user_attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
},
},
],
operator: "ALL", # accepts ALL, ANY
},
evaluation_wait_time: {
wait_for: "__string",
wait_until: "__string",
},
false_activity: "__string",
true_activity: "__string",
},
description: "__string",
email: {
message_config: {
from_address: "__string",
},
next_activity: "__string",
template_name: "__string",
template_version: "__string",
},
holdout: {
next_activity: "__string",
percentage: 1, # required
},
multi_condition: {
branches: [
{
condition: {
event_condition: {
dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
},
message_activity: "__string",
},
segment_condition: {
segment_id: "__string", # required
},
segment_dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
behavior: {
recency: {
duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
},
},
demographic: {
app_version: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
channel: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
device_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
make: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
model: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
platform: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
location: {
country: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
gps_point: {
coordinates: { # required
latitude: 1.0, # required
longitude: 1.0, # required
},
range_in_kilometers: 1.0,
},
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
user_attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
},
},
next_activity: "__string",
},
],
default_activity: "__string",
evaluation_wait_time: {
wait_for: "__string",
wait_until: "__string",
},
},
push: {
message_config: {
time_to_live: "__string",
},
next_activity: "__string",
template_name: "__string",
template_version: "__string",
},
random_split: {
branches: [
{
next_activity: "__string",
percentage: 1,
},
],
},
sms: {
message_config: {
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
sender_id: "__string",
},
next_activity: "__string",
template_name: "__string",
template_version: "__string",
},
wait: {
next_activity: "__string",
wait_time: {
wait_for: "__string",
wait_until: "__string",
},
},
},
},
creation_date: "__string",
last_modified_date: "__string",
limits: {
daily_cap: 1,
endpoint_reentry_cap: 1,
messages_per_second: 1,
},
local_time: false,
name: "__string", # required
quiet_time: {
end: "__string",
start: "__string",
},
refresh_frequency: "__string",
schedule: {
end_time: Time.now,
start_time: Time.now,
timezone: "__string",
},
start_activity: "__string",
start_condition: {
description: "__string",
event_start_condition: {
event_filter: {
dimensions: { # required
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
},
filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
},
segment_id: "__string",
},
segment_start_condition: {
segment_id: "__string", # required
},
},
state: "DRAFT", # accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED
},
}
Instance Attribute Summary collapse
-
#application_id ⇒ String
-
#write_journey_request ⇒ Types::WriteJourneyRequest
Specifies the configuration and other settings for a journey.
.
Instance Attribute Details
#application_id ⇒ String
#write_journey_request ⇒ Types::WriteJourneyRequest
Specifies the configuration and other settings for a journey.