File Coverage

blib/lib/Paws/ApplicationAutoScaling/DescribeScalableTargets.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApplicationAutoScaling::DescribeScalableTargets;
3 1     1   521 use Moose;
  1         5  
  1         8  
4             has MaxResults => (is => 'ro', isa => 'Int');
5             has NextToken => (is => 'ro', isa => 'Str');
6             has ResourceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has ScalableDimension => (is => 'ro', isa => 'Str');
8             has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   6748 use MooseX::ClassAttribute;
  1         3  
  1         9  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeScalableTargets');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApplicationAutoScaling::DescribeScalableTargetsResponse');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ApplicationAutoScaling::DescribeScalableTargets - Arguments for method DescribeScalableTargets on Paws::ApplicationAutoScaling
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeScalableTargets on the
26             Application Auto Scaling service. Use the attributes of this class
27             as arguments to method DescribeScalableTargets.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeScalableTargets.
30              
31             As an example:
32              
33             $service_obj->DescribeScalableTargets(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 MaxResults => Int
41              
42             The maximum number of scalable target results. This value can be
43             between 1 and 50. The default value is 50.
44              
45             If this parameter is used, the operation returns up to C<MaxResults>
46             results at a time, along with a C<NextToken> value. To get the next set
47             of results, include the C<NextToken> value in a subsequent call. If
48             this parameter is not used, the operation returns up to 50 results and
49             a C<NextToken> value, if applicable.
50              
51              
52              
53             =head2 NextToken => Str
54              
55             The token for the next set of results.
56              
57              
58              
59             =head2 ResourceIds => ArrayRef[Str|Undef]
60              
61             The identifier of the resource associated with the scalable target.
62             This string consists of the resource type and unique identifier. If you
63             specify a scalable dimension, you must also specify a resource ID.
64              
65             =over
66              
67             =item *
68              
69             ECS service - The resource type is C<service> and the unique identifier
70             is the cluster name and service name. Example:
71             C<service/default/sample-webapp>.
72              
73             =item *
74              
75             Spot fleet request - The resource type is C<spot-fleet-request> and the
76             unique identifier is the Spot fleet request ID. Example:
77             C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>.
78              
79             =item *
80              
81             EMR cluster - The resource type is C<instancegroup> and the unique
82             identifier is the cluster ID and instance group ID. Example:
83             C<instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0>.
84              
85             =item *
86              
87             AppStream 2.0 fleet - The resource type is C<fleet> and the unique
88             identifier is the fleet name. Example: C<fleet/sample-fleet>.
89              
90             =item *
91              
92             DynamoDB table - The resource type is C<table> and the unique
93             identifier is the resource ID. Example: C<table/my-table>.
94              
95             =item *
96              
97             DynamoDB global secondary index - The resource type is C<index> and the
98             unique identifier is the resource ID. Example:
99             C<table/my-table/index/my-table-index>.
100              
101             =back
102              
103              
104              
105              
106             =head2 ScalableDimension => Str
107              
108             The scalable dimension associated with the scalable target. This string
109             consists of the service namespace, resource type, and scaling property.
110             If you specify a scalable dimension, you must also specify a resource
111             ID.
112              
113             =over
114              
115             =item *
116              
117             C<ecs:service:DesiredCount> - The desired task count of an ECS service.
118              
119             =item *
120              
121             C<ec2:spot-fleet-request:TargetCapacity> - The target capacity of a
122             Spot fleet request.
123              
124             =item *
125              
126             C<elasticmapreduce:instancegroup:InstanceCount> - The instance count of
127             an EMR Instance Group.
128              
129             =item *
130              
131             C<appstream:fleet:DesiredCapacity> - The desired capacity of an
132             AppStream 2.0 fleet.
133              
134             =item *
135              
136             C<dynamodb:table:ReadCapacityUnits> - The provisioned read capacity for
137             a DynamoDB table.
138              
139             =item *
140              
141             C<dynamodb:table:WriteCapacityUnits> - The provisioned write capacity
142             for a DynamoDB table.
143              
144             =item *
145              
146             C<dynamodb:index:ReadCapacityUnits> - The provisioned read capacity for
147             a DynamoDB global secondary index.
148              
149             =item *
150              
151             C<dynamodb:index:WriteCapacityUnits> - The provisioned write capacity
152             for a DynamoDB global secondary index.
153              
154             =back
155              
156              
157             Valid values are: C<"ecs:service:DesiredCount">, C<"ec2:spot-fleet-request:TargetCapacity">, C<"elasticmapreduce:instancegroup:InstanceCount">, C<"appstream:fleet:DesiredCapacity">, C<"dynamodb:table:ReadCapacityUnits">, C<"dynamodb:table:WriteCapacityUnits">, C<"dynamodb:index:ReadCapacityUnits">, C<"dynamodb:index:WriteCapacityUnits">
158              
159             =head2 B<REQUIRED> ServiceNamespace => Str
160              
161             The namespace of the AWS service. For more information, see AWS Service
162             Namespaces in the I<Amazon Web Services General Reference>.
163              
164             Valid values are: C<"ecs">, C<"elasticmapreduce">, C<"ec2">, C<"appstream">, C<"dynamodb">
165              
166              
167             =head1 SEE ALSO
168              
169             This class forms part of L<Paws>, documenting arguments for method DescribeScalableTargets in L<Paws::ApplicationAutoScaling>
170              
171             =head1 BUGS and CONTRIBUTIONS
172              
173             The source code is located here: https://github.com/pplu/aws-sdk-perl
174              
175             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
176              
177             =cut
178