The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Pinpoint::CreateJourney

NAME

Paws::Pinpoint::CreateJourney - Arguments for method CreateJourney on Paws::Pinpoint

DESCRIPTION

This class represents the parameters used for calling the method CreateJourney on the Amazon Pinpoint service. Use the attributes of this class as arguments to method CreateJourney.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateJourney.

SYNOPSIS


            

              
              
my $pinpoint = Paws->service('Pinpoint');
my $CreateJourneyResponse = $pinpoint->CreateJourney(
  ApplicationId       => 'My__string',
  WriteJourneyRequest => {
    Name       => 'My__string',
    Activities => {
      'My__string' => {
        CUSTOM => {
          DeliveryUri   => 'My__string',
          EndpointTypes => [
            'PUSH',
            ... # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
          ],    # OPTIONAL
          MessageConfig   => { Data => 'My__string', },    # OPTIONAL
          NextActivity    => 'My__string',
          TemplateName    => 'My__string',
          TemplateVersion => 'My__string',
        },    # OPTIONAL
        ConditionalSplit => {
          Condition => {
            Conditions => [
              {
                EventCondition => {
                  Dimensions => {
                    Attributes => {
                      'My__string' => {
                        Values        => [ 'My__string', ... ],
                        AttributeType => 'INCLUSIVE'
                        , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                      },
                    },    # OPTIONAL
                    EventType => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Metrics => {
                      'My__string' => {
                        ComparisonOperator => 'My__string',
                        Value              => 1,
                      },
                    },    # OPTIONAL
                  },    # OPTIONAL
                  MessageActivity => 'My__string',
                },    # OPTIONAL
                SegmentCondition => {
                  SegmentId => 'My__string',
                },    # OPTIONAL
                SegmentDimensions => {
                  Attributes => {
                    'My__string' => {
                      Values        => [ 'My__string', ... ],
                      AttributeType => 'INCLUSIVE'
                      , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                    },
                  },    # OPTIONAL
                  Behavior => {
                    Recency => {
                      Duration =>
                        'HR_24',    # values: HR_24, DAY_7, DAY_14, DAY_30
                      RecencyType => 'ACTIVE',    # values: ACTIVE, INACTIVE
                    },    # OPTIONAL
                  },    # OPTIONAL
                  Demographic => {
                    AppVersion => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Channel => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    DeviceType => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Make => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Model => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Platform => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                  },    # OPTIONAL
                  Location => {
                    Country => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    GPSPoint => {
                      Coordinates => {
                        Latitude  => 1,
                        Longitude => 1,
                      },
                      RangeInKilometers => 1,
                    },    # OPTIONAL
                  },    # OPTIONAL
                  Metrics => {
                    'My__string' => {
                      ComparisonOperator => 'My__string',
                      Value              => 1,
                    },
                  },    # OPTIONAL
                  UserAttributes => {
                    'My__string' => {
                      Values        => [ 'My__string', ... ],
                      AttributeType => 'INCLUSIVE'
                      , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                    },
                  },    # OPTIONAL
                },    # OPTIONAL
              },
              ...
            ],    # OPTIONAL
            Operator => 'ALL',    # values: ALL, ANY; OPTIONAL
          },    # OPTIONAL
          EvaluationWaitTime => {
            WaitFor   => 'My__string',
            WaitUntil => 'My__string',
          },    # OPTIONAL
          FalseActivity => 'My__string',
          TrueActivity  => 'My__string',
        },    # OPTIONAL
        Description => 'My__string',
        EMAIL       => {
          MessageConfig   => { FromAddress => 'My__string', },    # OPTIONAL
          NextActivity    => 'My__string',
          TemplateName    => 'My__string',
          TemplateVersion => 'My__string',
        },    # OPTIONAL
        Holdout => {
          Percentage   => 1,
          NextActivity => 'My__string',
        },    # OPTIONAL
        MultiCondition => {
          Branches => [
            {
              Condition => {
                EventCondition => {
                  Dimensions => {
                    Attributes => {
                      'My__string' => {
                        Values        => [ 'My__string', ... ],
                        AttributeType => 'INCLUSIVE'
                        , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                      },
                    },    # OPTIONAL
                    EventType => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Metrics => {
                      'My__string' => {
                        ComparisonOperator => 'My__string',
                        Value              => 1,
                      },
                    },    # OPTIONAL
                  },    # OPTIONAL
                  MessageActivity => 'My__string',
                },    # OPTIONAL
                SegmentCondition => {
                  SegmentId => 'My__string',
                },    # OPTIONAL
                SegmentDimensions => {
                  Attributes => {
                    'My__string' => {
                      Values        => [ 'My__string', ... ],
                      AttributeType => 'INCLUSIVE'
                      , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                    },
                  },    # OPTIONAL
                  Behavior => {
                    Recency => {
                      Duration =>
                        'HR_24',    # values: HR_24, DAY_7, DAY_14, DAY_30
                      RecencyType => 'ACTIVE',    # values: ACTIVE, INACTIVE
                    },    # OPTIONAL
                  },    # OPTIONAL
                  Demographic => {
                    AppVersion => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Channel => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    DeviceType => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Make => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Model => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    Platform => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                  },    # OPTIONAL
                  Location => {
                    Country => {
                      Values        => [ 'My__string', ... ],
                      DimensionType => 'INCLUSIVE'
                      ,    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
                    },    # OPTIONAL
                    GPSPoint => {
                      Coordinates => {
                        Latitude  => 1,
                        Longitude => 1,
                      },
                      RangeInKilometers => 1,
                    },    # OPTIONAL
                  },    # OPTIONAL
                  Metrics => {
                    'My__string' => {
                      ComparisonOperator => 'My__string',
                      Value              => 1,
                    },
                  },    # OPTIONAL
                  UserAttributes => {
                    'My__string' => {
                      Values        => [ 'My__string', ... ],
                      AttributeType => 'INCLUSIVE'
                      , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
                    },
                  },    # OPTIONAL
                },    # OPTIONAL
              },
              NextActivity => 'My__string',
            },
            ...
          ],    # OPTIONAL
          DefaultActivity    => 'My__string',
          EvaluationWaitTime => {
            WaitFor   => 'My__string',
            WaitUntil => 'My__string',
          },    # OPTIONAL
        },    # OPTIONAL
        PUSH => {
          MessageConfig   => { TimeToLive => 'My__string', },    # OPTIONAL
          NextActivity    => 'My__string',
          TemplateName    => 'My__string',
          TemplateVersion => 'My__string',
        },    # OPTIONAL
        RandomSplit => {
          Branches => [
            {
              NextActivity => 'My__string',
              Percentage   => 1,
            },
            ...
          ],    # OPTIONAL
        },    # OPTIONAL
        SMS => {
          MessageConfig => {
            EntityId    => 'My__string',
            MessageType => 'TRANSACTIONAL'
            ,    # values: TRANSACTIONAL, PROMOTIONAL; OPTIONAL
            OriginationNumber => 'My__string',
            SenderId          => 'My__string',
            TemplateId        => 'My__string',
          },    # OPTIONAL
          NextActivity    => 'My__string',
          TemplateName    => 'My__string',
          TemplateVersion => 'My__string',
        },    # OPTIONAL
        Wait => {
          NextActivity => 'My__string',
          WaitTime     => {
            WaitFor   => 'My__string',
            WaitUntil => 'My__string',
          },    # OPTIONAL
        },    # OPTIONAL
      },
    },    # OPTIONAL
    CreationDate     => 'My__string',
    LastModifiedDate => 'My__string',
    Limits           => {
      DailyCap                => 1,
      EndpointReentryCap      => 1,
      EndpointReentryInterval => 'My__string',
      MessagesPerSecond       => 1,
    },    # OPTIONAL
    LocalTime => 1,    # OPTIONAL
    QuietTime => {
      End   => 'My__string',
      Start => 'My__string',
    },                 # OPTIONAL
    RefreshFrequency       => 'My__string',
    RefreshOnSegmentUpdate => 1,              # OPTIONAL
    Schedule               => {
      EndTime   => '1970-01-01T01:00:00',     # OPTIONAL
      StartTime => '1970-01-01T01:00:00',     # OPTIONAL
      Timezone  => 'My__string',
    },    # OPTIONAL
    StartActivity  => 'My__string',
    StartCondition => {
      Description         => 'My__string',
      EventStartCondition => {
        EventFilter => {
          Dimensions => {
            Attributes => {
              'My__string' => {
                Values        => [ 'My__string', ... ],
                AttributeType => 'INCLUSIVE'
                , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL
              },
            },    # OPTIONAL
            EventType => {
              Values        => [ 'My__string', ... ],
              DimensionType =>
                'INCLUSIVE',    # values: INCLUSIVE, EXCLUSIVE; OPTIONAL
            },    # OPTIONAL
            Metrics => {
              'My__string' => {
                ComparisonOperator => 'My__string',
                Value              => 1,
              },
            },    # OPTIONAL
          },    # OPTIONAL
          FilterType => 'SYSTEM',    # values: SYSTEM, ENDPOINT
        },    # OPTIONAL
        SegmentId => 'My__string',
      },    # OPTIONAL
      SegmentStartCondition => {
        SegmentId => 'My__string',
      },    # OPTIONAL
    },    # OPTIONAL
    State => 'DRAFT'
    , # values: DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED; OPTIONAL
    WaitForQuietTime => 1,    # OPTIONAL
  },
);
# Results:
my $JourneyResponse = $CreateJourneyResponse->JourneyResponse;
# Returns a L<Paws::Pinpoint::CreateJourneyResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/pinpoint/CreateJourney

ATTRIBUTES

REQUIRED ApplicationId => Str

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

REQUIRED WriteJourneyRequest => Paws::Pinpoint::WriteJourneyRequest

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateJourney in Paws::Pinpoint

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues