| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::JourneyStateRequest; | ||
| 3 | use Moose; | ||
| 4 | has State => (is => 'ro', isa => 'Str'); | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::Pinpoint::JourneyStateRequest | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::Pinpoint::JourneyStateRequest object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { State => $value, ..., State => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::JourneyStateRequest object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->State | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | Changes the status of a journey. | ||
| 37 | |||
| 38 | =head1 ATTRIBUTES | ||
| 39 | |||
| 40 | |||
| 41 | =head2 State => Str | ||
| 42 | |||
| 43 | The status of the journey. Currently, Supported values are ACTIVE, | ||
| 44 | PAUSED, and CANCELLED | ||
| 45 | |||
| 46 | If you cancel a journey, Amazon Pinpoint continues to perform | ||
| 47 | activities that are currently in progress, until those activities are | ||
| 48 | complete. Amazon Pinpoint also continues to collect and aggregate | ||
| 49 | analytics data for those activities, until they are complete, and any | ||
| 50 | activities that were complete when you cancelled the journey. | ||
| 51 | |||
| 52 | After you cancel a journey, you can't add, change, or remove any | ||
| 53 | activities from the journey. In addition, Amazon Pinpoint stops | ||
| 54 | evaluating the journey and doesn't perform any activities that haven't | ||
| 55 | started. | ||
| 56 | |||
| 57 | When the journey is paused, Amazon Pinpoint continues to perform | ||
| 58 | activities that are currently in progress, until those activities are | ||
| 59 | complete. Endpoints will stop entering journeys when the journey is | ||
| 60 | paused and will resume entering the journey after the journey is | ||
| 61 | resumed. For wait activities, wait time is paused when the journey is | ||
| 62 | paused. Currently, PAUSED only supports journeys with a segment refresh | ||
| 63 | interval. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |