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