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

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