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