blib/lib/Paws/Pinpoint/GetCampaignDateRangeKpi.pm untested

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Pinpoint::GetCampaignDateRangeKpi;
3 use Moose;
4 has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1);
5 has CampaignId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'campaign-id', required => 1);
6 has EndTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'end-time');
7 has KpiName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'kpi-name', required => 1);
8 has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token');
9 has PageSize => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'page-size');
10 has StartTime => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'start-time');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCampaignDateRangeKpi');
15 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}');
16 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::GetCampaignDateRangeKpiResponse');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Pinpoint::GetCampaignDateRangeKpi - Arguments for method GetCampaignDateRangeKpi on L<Paws::Pinpoint>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method GetCampaignDateRangeKpi on the
29 L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class
30 as arguments to method GetCampaignDateRangeKpi.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCampaignDateRangeKpi.
33  
34 =head1 SYNOPSIS
35  
36 my $pinpoint = Paws->service('Pinpoint');
37 my $GetCampaignDateRangeKpiResponse = $pinpoint->GetCampaignDateRangeKpi(
38 ApplicationId => 'My__string',
39 CampaignId => 'My__string',
40 KpiName => 'My__string',
41 EndTime => '1970-01-01T01:00:00', # OPTIONAL
42 NextToken => 'My__string', # OPTIONAL
43 PageSize => 'My__string', # OPTIONAL
44 StartTime => '1970-01-01T01:00:00', # OPTIONAL
45 );
46  
47 # Results:
48 my $CampaignDateRangeKpiResponse =
49 $GetCampaignDateRangeKpiResponse->CampaignDateRangeKpiResponse;
50  
51 # Returns a L<Paws::Pinpoint::GetCampaignDateRangeKpiResponse> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/GetCampaignDateRangeKpi>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 B<REQUIRED> ApplicationId => Str
60  
61 The unique identifier for the application. This identifier is displayed
62 as the B<Project ID> on the Amazon Pinpoint console.
63  
64  
65  
66 =head2 B<REQUIRED> CampaignId => Str
67  
68 The unique identifier for the campaign.
69  
70  
71  
72 =head2 EndTime => Str
73  
74 The last date and time to retrieve data for, as part of an inclusive
75 date range that filters the query results. This value should be in
76 extended ISO 8601 format and use Coordinated Universal Time (UTC), for
77 example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
78  
79  
80  
81 =head2 B<REQUIRED> KpiName => Str
82  
83 The name of the metric, also referred to as a I<key performance
84 indicator (KPI)>, to retrieve data for. This value describes the
85 associated metric and consists of two or more terms, which are
86 comprised of lowercase alphanumeric characters, separated by a hyphen.
87 Examples are email-open-rate and successful-delivery-rate. For a list
88 of valid values, see the Amazon Pinpoint Developer Guide
89 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).
90  
91  
92  
93 =head2 NextToken => Str
94  
95 The string that specifies which page of results to return in a
96 paginated response. This parameter is not supported for application,
97 campaign, and journey metrics.
98  
99  
100  
101 =head2 PageSize => Str
102  
103 The maximum number of items to include in each page of a paginated
104 response. This parameter is not supported for application, campaign,
105 and journey metrics.
106  
107  
108  
109 =head2 StartTime => Str
110  
111 The first date and time to retrieve data for, as part of an inclusive
112 date range that filters the query results. This value should be in
113 extended ISO 8601 format and use Coordinated Universal Time (UTC), for
114 example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value
115 should also be fewer than 90 days from the current day.
116  
117  
118  
119  
120 =head1 SEE ALSO
121  
122 This class forms part of L<Paws>, documenting arguments for method GetCampaignDateRangeKpi in L<Paws::Pinpoint>
123  
124 =head1 BUGS and CONTRIBUTIONS
125  
126 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
127  
128 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
129  
130 =cut
131