The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Pinpoint::WriteJourneyRequest

NAME

Paws::Pinpoint::WriteJourneyRequest

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Pinpoint::WriteJourneyRequest object:

  $service_obj->Method(Att1 => { Activities => $value, ..., WaitForQuietTime => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::WriteJourneyRequest object:

  $result = $service_obj->Method(...);
  $result->Att1->Activities

DESCRIPTION

Specifies the configuration and other settings for a journey.

ATTRIBUTES

Activities => Paws::Pinpoint::MapOfActivity

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

CreationDate => Str

The date, in ISO 8601 format, when the journey was created.

LastModifiedDate => Str

The date, in ISO 8601 format, when the journey was last modified.

Limits => Paws::Pinpoint::JourneyLimits

The messaging and entry limits for the journey.

LocalTime => Bool

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

REQUIRED Name => Str

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

QuietTime => Paws::Pinpoint::QuietTime

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

  • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

  • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

RefreshFrequency => Str

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

RefreshOnSegmentUpdate => Bool

Specifies whether a journey should be refreshed on segment update.

Schedule => Paws::Pinpoint::JourneySchedule

The schedule settings for the journey.

StartActivity => Str

The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

StartCondition => Paws::Pinpoint::StartCondition

The segment that defines which users are participants in the journey.

State => Str

The status of the journey. Valid values are:

  • DRAFT - Saves the journey and doesn't publish it.

  • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the

Journey State resource.

WaitForQuietTime => Bool

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

SEE ALSO

This class forms part of Paws, describing an object used 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