« blib/lib/Paws/Pinpoint/GetJourneyExecutionActivityMetricsResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/GetJourneyExecutionMetricsResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::GetJourneyExecutionMetrics; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has JourneyId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'journey-id', required => 1); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token'); | ||
| 7 | has PageSize => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'page-size'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetJourneyExecutionMetrics'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/journeys/{journey-id}/execution-metrics'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::GetJourneyExecutionMetricsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Pinpoint::GetJourneyExecutionMetrics - Arguments for method GetJourneyExecutionMetrics on L<Paws::Pinpoint> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetJourneyExecutionMetrics on the | ||
| 26 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 27 | as arguments to method GetJourneyExecutionMetrics. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetJourneyExecutionMetrics. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 34 | my $GetJourneyExecutionMetricsResponse = | ||
| 35 | $pinpoint->GetJourneyExecutionMetrics( | ||
| 36 | ApplicationId => 'My__string', | ||
| 37 | JourneyId => 'My__string', | ||
| 38 | NextToken => 'My__string', # OPTIONAL | ||
| 39 | PageSize => 'My__string', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $JourneyExecutionMetricsResponse = | ||
| 44 | $GetJourneyExecutionMetricsResponse->JourneyExecutionMetricsResponse; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Pinpoint::GetJourneyExecutionMetricsResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/GetJourneyExecutionMetrics> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 55 | |||
| 56 | The unique identifier for the application. This identifier is displayed | ||
| 57 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> JourneyId => Str | ||
| 62 | |||
| 63 | The unique identifier for the journey. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 NextToken => Str | ||
| 68 | |||
| 69 | The string that specifies which page of results to return in a | ||
| 70 | paginated response. This parameter is not supported for application, | ||
| 71 | campaign, and journey metrics. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 PageSize => Str | ||
| 76 | |||
| 77 | The maximum number of items to include in each page of a paginated | ||
| 78 | response. This parameter is not supported for application, campaign, | ||
| 79 | and journey metrics. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method GetJourneyExecutionMetrics in L<Paws::Pinpoint> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |