« blib/lib/Paws/Pinpoint/JourneyEmailMessage.pm
↑ Summary
blib/lib/Paws/Pinpoint/JourneyExecutionMetricsResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::JourneyExecutionActivityMetricsResponse; | ||
| 3 | use Moose; | ||
| 4 | has ActivityType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ApplicationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has JourneyActivityId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has JourneyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has LastEvaluatedTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Metrics => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', required => 1); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Pinpoint::JourneyExecutionActivityMetricsResponse | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Pinpoint::JourneyExecutionActivityMetricsResponse object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ActivityType => $value, ..., Metrics => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::JourneyExecutionActivityMetricsResponse object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ActivityType | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Provides the results of a query that retrieved the data for a standard | ||
| 42 | execution metric that applies to a journey activity, and provides | ||
| 43 | information about that query. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> ActivityType => Str | ||
| 49 | |||
| 50 | The type of activity that the metric applies to. Possible values are: | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity | ||
| 57 | that sends participants down one of two paths in a journey. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | HOLDOUT - For a holdout activity, which is an activity that stops a | ||
| 62 | journey for a specified percentage of participants. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | MESSAGE - For an email activity, which is an activity that sends an | ||
| 67 | email message to participants. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is | ||
| 72 | an activity that sends participants down one of as many as five paths | ||
| 73 | in a journey. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | RANDOM_SPLIT - For a random split activity, which is an activity that | ||
| 78 | sends specified percentages of participants down one of as many as five | ||
| 79 | paths in a journey. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | WAIT - For a wait activity, which is an activity that waits for a | ||
| 84 | certain amount of time or until a specific date and time before moving | ||
| 85 | participants to the next activity in a journey. | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 92 | |||
| 93 | The unique identifier for the application that the metric applies to. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> JourneyActivityId => Str | ||
| 97 | |||
| 98 | The unique identifier for the activity that the metric applies to. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> JourneyId => Str | ||
| 102 | |||
| 103 | The unique identifier for the journey that the metric applies to. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> LastEvaluatedTime => Str | ||
| 107 | |||
| 108 | The date and time, in ISO 8601 format, when Amazon Pinpoint last | ||
| 109 | evaluated the execution status of the activity and updated the data for | ||
| 110 | the metric. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> Metrics => L<Paws::Pinpoint::MapOf__string> | ||
| 114 | |||
| 115 | A JSON object that contains the results of the query. The results vary | ||
| 116 | depending on the type of activity (ActivityType). For information about | ||
| 117 | the structure and contents of the results, see the Amazon Pinpoint | ||
| 118 | Developer Guide | ||
| 119 | (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html). | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |