« blib/lib/Paws/CloudWatch/GetMetricStatisticsOutput.pm
↑ Summary
blib/lib/Paws/CloudWatch/ListMetricsOutput.pm »
| 1 | |||
| 2 | package Paws::CloudWatch::ListMetrics; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::DimensionFilter]'); | |
| 5 | 1 | has MetricName => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has Namespace => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has NextToken => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has RecentlyActive => (is => 'ro', isa => 'Str'); | |
| 9 | |||
| 10 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 11 | |||
| 12 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListMetrics'); | |
| 13 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::ListMetricsOutput'); | |
| 14 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListMetricsResult'); | |
| 15 | 1 | 1; | |
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CloudWatch::ListMetrics - Arguments for method ListMetrics on L<Paws::CloudWatch> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListMetrics on the | ||
| 26 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 27 | as arguments to method ListMetrics. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListMetrics. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $monitoring = Paws->service('CloudWatch'); | ||
| 34 | my $ListMetricsOutput = $monitoring->ListMetrics( | ||
| 35 | Dimensions => [ | ||
| 36 | { | ||
| 37 | Name => 'MyDimensionName', # min: 1, max: 255 | ||
| 38 | Value => 'MyDimensionValue', # min: 1, max: 255; OPTIONAL | ||
| 39 | }, | ||
| 40 | ... | ||
| 41 | ], # OPTIONAL | ||
| 42 | MetricName => 'MyMetricName', # OPTIONAL | ||
| 43 | Namespace => 'MyNamespace', # OPTIONAL | ||
| 44 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 45 | RecentlyActive => 'PT3H', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Metrics = $ListMetricsOutput->Metrics; | ||
| 50 | my $NextToken = $ListMetricsOutput->NextToken; | ||
| 51 | |||
| 52 | # Returns a L<Paws::CloudWatch::ListMetricsOutput> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/ListMetrics> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::DimensionFilter>] | ||
| 61 | |||
| 62 | The dimensions to filter against. Only the dimensions that match | ||
| 63 | exactly will be returned. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 MetricName => Str | ||
| 68 | |||
| 69 | The name of the metric to filter against. Only the metrics with names | ||
| 70 | that match exactly will be returned. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 Namespace => Str | ||
| 75 | |||
| 76 | The metric namespace to filter against. Only the namespace that matches | ||
| 77 | exactly will be returned. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 NextToken => Str | ||
| 82 | |||
| 83 | The token returned by a previous call to indicate that there is more | ||
| 84 | data available. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 RecentlyActive => Str | ||
| 89 | |||
| 90 | To filter the results to show only metrics that have had data points | ||
| 91 | published in the past three hours, specify this parameter with a value | ||
| 92 | of C<PT3H>. This is the only valid value for this parameter. | ||
| 93 | |||
| 94 | The results that are returned are an approximation of the value you | ||
| 95 | specify. There is a low probability that the returned results include | ||
| 96 | metrics with last published data as much as 40 minutes more than the | ||
| 97 | specified time interval. | ||
| 98 | |||
| 99 | Valid values are: C<"PT3H"> | ||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method ListMetrics in L<Paws::CloudWatch> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 | |||