blib/lib/Paws/ApplicationAutoScaling/DescribeScalableTargets.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ApplicationAutoScaling::DescribeScalableTargets;
3 use Moose;
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 use MooseX::ClassAttribute;
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 L<Paws::ApplicationAutoScaling>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeScalableTargets on the
26 L<Application Auto Scaling|Paws::ApplicationAutoScaling> 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 =head1 SYNOPSIS
32  
33 my $application-autoscaling = Paws->service('ApplicationAutoScaling');
34 # To describe scalable targets
35 # This example describes the scalable targets for the ecs service namespace.
36 my $DescribeScalableTargetsResponse = $application -
37 autoscaling->DescribeScalableTargets( 'ServiceNamespace' => 'ecs' );
38  
39 # Results:
40 my $ScalableTargets = $DescribeScalableTargetsResponse->ScalableTargets;
41  
42 # Returns a L<Paws::ApplicationAutoScaling::DescribeScalableTargetsResponse> object.
43  
44 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.
45 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling/DescribeScalableTargets>
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 MaxResults => Int
51  
52 The maximum number of scalable targets. This value can be between 1 and
53 50. The default value is 50.
54  
55 If this parameter is used, the operation returns up to C<MaxResults>
56 results at a time, along with a C<NextToken> value. To get the next set
57 of results, include the C<NextToken> value in a subsequent call. If
58 this parameter is not used, the operation returns up to 50 results and
59 a C<NextToken> value, if applicable.
60  
61  
62  
63 =head2 NextToken => Str
64  
65 The token for the next set of results.
66  
67  
68  
69 =head2 ResourceIds => ArrayRef[Str|Undef]
70  
71 The identifier of the resource associated with the scalable target.
72 This string consists of the resource type and unique identifier.
73  
74 =over
75  
76 =item *
77  
78 ECS service - The resource type is C<service> and the unique identifier
79 is the cluster name and service name. Example:
80 C<service/default/sample-webapp>.
81  
82 =item *
83  
84 Spot Fleet request - The resource type is C<spot-fleet-request> and the
85 unique identifier is the Spot Fleet request ID. Example:
86 C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>.
87  
88 =item *
89  
90 EMR cluster - The resource type is C<instancegroup> and the unique
91 identifier is the cluster ID and instance group ID. Example:
92 C<instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0>.
93  
94 =item *
95  
96 AppStream 2.0 fleet - The resource type is C<fleet> and the unique
97 identifier is the fleet name. Example: C<fleet/sample-fleet>.
98  
99 =item *
100  
101 DynamoDB table - The resource type is C<table> and the unique
102 identifier is the table name. Example: C<table/my-table>.
103  
104 =item *
105  
106 DynamoDB global secondary index - The resource type is C<index> and the
107 unique identifier is the index name. Example:
108 C<table/my-table/index/my-table-index>.
109  
110 =item *
111  
112 Aurora DB cluster - The resource type is C<cluster> and the unique
113 identifier is the cluster name. Example: C<cluster:my-db-cluster>.
114  
115 =item *
116  
117 Amazon SageMaker endpoint variant - The resource type is C<variant> and
118 the unique identifier is the resource ID. Example:
119 C<endpoint/my-end-point/variant/KMeansClustering>.
120  
121 =item *
122  
123 Custom resources are not supported with a resource type. This parameter
124 must specify the C<OutputValue> from the CloudFormation template stack
125 used to access the resources. The unique identifier is defined by the
126 service provider. More information is available in our GitHub
127 repository (https://github.com/aws/aws-auto-scaling-custom-resource).
128  
129 =item *
130  
131 Amazon Comprehend document classification endpoint - The resource type
132 and unique identifier are specified using the endpoint ARN. Example:
133 C<arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE>.
134  
135 =item *
136  
137 Amazon Comprehend entity recognizer endpoint - The resource type and
138 unique identifier are specified using the endpoint ARN. Example:
139 C<arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE>.
140  
141 =item *
142  
143 Lambda provisioned concurrency - The resource type is C<function> and
144 the unique identifier is the function name with a function version or
145 alias name suffix that is not C<$LATEST>. Example:
146 C<function:my-function:prod> or C<function:my-function:1>.
147  
148 =item *
149  
150 Amazon Keyspaces table - The resource type is C<table> and the unique
151 identifier is the table name. Example:
152 C<keyspace/mykeyspace/table/mytable>.
153  
154 =item *
155  
156 Amazon MSK cluster - The resource type and unique identifier are
157 specified using the cluster ARN. Example:
158 C<arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5>.
159  
160 =back
161  
162  
163  
164  
165 =head2 ScalableDimension => Str
166  
167 The scalable dimension associated with the scalable target. This string
168 consists of the service namespace, resource type, and scaling property.
169 If you specify a scalable dimension, you must also specify a resource
170 ID.
171  
172 =over
173  
174 =item *
175  
176 C<ecs:service:DesiredCount> - The desired task count of an ECS service.
177  
178 =item *
179  
180 C<ec2:spot-fleet-request:TargetCapacity> - The target capacity of a
181 Spot Fleet request.
182  
183 =item *
184  
185 C<elasticmapreduce:instancegroup:InstanceCount> - The instance count of
186 an EMR Instance Group.
187  
188 =item *
189  
190 C<appstream:fleet:DesiredCapacity> - The desired capacity of an
191 AppStream 2.0 fleet.
192  
193 =item *
194  
195 C<dynamodb:table:ReadCapacityUnits> - The provisioned read capacity for
196 a DynamoDB table.
197  
198 =item *
199  
200 C<dynamodb:table:WriteCapacityUnits> - The provisioned write capacity
201 for a DynamoDB table.
202  
203 =item *
204  
205 C<dynamodb:index:ReadCapacityUnits> - The provisioned read capacity for
206 a DynamoDB global secondary index.
207  
208 =item *
209  
210 C<dynamodb:index:WriteCapacityUnits> - The provisioned write capacity
211 for a DynamoDB global secondary index.
212  
213 =item *
214  
215 C<rds:cluster:ReadReplicaCount> - The count of Aurora Replicas in an
216 Aurora DB cluster. Available for Aurora MySQL-compatible edition and
217 Aurora PostgreSQL-compatible edition.
218  
219 =item *
220  
221 C<sagemaker:variant:DesiredInstanceCount> - The number of EC2 instances
222 for an Amazon SageMaker model endpoint variant.
223  
224 =item *
225  
226 C<custom-resource:ResourceType:Property> - The scalable dimension for a
227 custom resource provided by your own application or service.
228  
229 =item *
230  
231 C<comprehend:document-classifier-endpoint:DesiredInferenceUnits> - The
232 number of inference units for an Amazon Comprehend document
233 classification endpoint.
234  
235 =item *
236  
237 C<comprehend:entity-recognizer-endpoint:DesiredInferenceUnits> - The
238 number of inference units for an Amazon Comprehend entity recognizer
239 endpoint.
240  
241 =item *
242  
243 C<lambda:function:ProvisionedConcurrency> - The provisioned concurrency
244 for a Lambda function.
245  
246 =item *
247  
248 C<cassandra:table:ReadCapacityUnits> - The provisioned read capacity
249 for an Amazon Keyspaces table.
250  
251 =item *
252  
253 C<cassandra:table:WriteCapacityUnits> - The provisioned write capacity
254 for an Amazon Keyspaces table.
255  
256 =item *
257  
258 C<kafka:broker-storage:VolumeSize> - The provisioned volume size (in
259 GiB) for brokers in an Amazon MSK cluster.
260  
261 =back
262  
263  
264 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">, C<"rds:cluster:ReadReplicaCount">, C<"sagemaker:variant:DesiredInstanceCount">, C<"custom-resource:ResourceType:Property">, C<"comprehend:document-classifier-endpoint:DesiredInferenceUnits">, C<"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits">, C<"lambda:function:ProvisionedConcurrency">, C<"cassandra:table:ReadCapacityUnits">, C<"cassandra:table:WriteCapacityUnits">, C<"kafka:broker-storage:VolumeSize">
265  
266 =head2 B<REQUIRED> ServiceNamespace => Str
267  
268 The namespace of the AWS service that provides the resource. For a
269 resource provided by your own application or service, use
270 C<custom-resource> instead.
271  
272 Valid values are: C<"ecs">, C<"elasticmapreduce">, C<"ec2">, C<"appstream">, C<"dynamodb">, C<"rds">, C<"sagemaker">, C<"custom-resource">, C<"comprehend">, C<"lambda">, C<"cassandra">, C<"kafka">
273  
274  
275 =head1 SEE ALSO
276  
277 This class forms part of L<Paws>, documenting arguments for method DescribeScalableTargets in L<Paws::ApplicationAutoScaling>
278  
279 =head1 BUGS and CONTRIBUTIONS
280  
281 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
282  
283 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
284  
285 =cut
286