| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.ApplicationAutoScaling.DescribeScalingPolicies
Description
Provides descriptive information about the scaling policies in the specified namespace.
You can filter the results using the ResourceId , ScalableDimension , and PolicyNames parameters.
To create a scaling policy or update an existing one, see PutScalingPolicy . If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy .
This operation returns paginated results.
- describeScalingPolicies :: ServiceNamespace -> DescribeScalingPolicies
- data DescribeScalingPolicies
- dPolicyNames :: Lens' DescribeScalingPolicies [Text]
- dScalableDimension :: Lens' DescribeScalingPolicies (Maybe ScalableDimension)
- dResourceId :: Lens' DescribeScalingPolicies (Maybe Text)
- dNextToken :: Lens' DescribeScalingPolicies (Maybe Text)
- dMaxResults :: Lens' DescribeScalingPolicies (Maybe Int)
- dServiceNamespace :: Lens' DescribeScalingPolicies ServiceNamespace
- describeScalingPoliciesResponse :: Int -> DescribeScalingPoliciesResponse
- data DescribeScalingPoliciesResponse
- drsNextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text)
- drsScalingPolicies :: Lens' DescribeScalingPoliciesResponse [ScalingPolicy]
- drsResponseStatus :: Lens' DescribeScalingPoliciesResponse Int
Creating a Request
describeScalingPolicies Source #
Arguments
| :: ServiceNamespace | |
| -> DescribeScalingPolicies |
Creates a value of DescribeScalingPolicies with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dPolicyNames- The names of the scaling policies to describe.dScalableDimension- The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. *ecs:service:DesiredCount- The desired task count of an ECS service. *ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot fleet request. *elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.dResourceId- The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. * ECS service - The resource type isserviceand the unique identifier is the cluster name and service name. Example:servicedefaultsample-webapp. * Spot fleet request - The resource type isspot-fleet-requestand the unique identifier is the Spot fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. * EMR cluster - The resource type isinstancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0.dNextToken- The token for the next set of results.dMaxResults- The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up toMaxResultsresults at a time, along with aNextTokenvalue. To get the next set of results, include theNextTokenvalue in a subsequent call. If this parameter is not used, the operation returns up to 50 results and aNextTokenvalue, if applicable.dServiceNamespace- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
data DescribeScalingPolicies Source #
See: describeScalingPolicies smart constructor.
Instances
Request Lenses
dPolicyNames :: Lens' DescribeScalingPolicies [Text] Source #
The names of the scaling policies to describe.
dScalableDimension :: Lens' DescribeScalingPolicies (Maybe ScalableDimension) Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID. * ecs:service:DesiredCount - The desired task count of an ECS service. * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request. * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
dResourceId :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID. * ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: servicedefaultsample-webapp . * Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE . * EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroupj-2EEZNYKUA1NTVig-1791Y4E1L8YI0 .
dNextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The token for the next set of results.
dMaxResults :: Lens' DescribeScalingPolicies (Maybe Int) Source #
The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50. If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
dServiceNamespace :: Lens' DescribeScalingPolicies ServiceNamespace Source #
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
Destructuring the Response
describeScalingPoliciesResponse Source #
Arguments
| :: Int | |
| -> DescribeScalingPoliciesResponse |
Creates a value of DescribeScalingPoliciesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drsNextToken- The token required to get the next set of results. This value isnullif there are no more results to return.drsScalingPolicies- A list of scaling policy objects.drsResponseStatus- -- | The response status code.
data DescribeScalingPoliciesResponse Source #
See: describeScalingPoliciesResponse smart constructor.
Instances
Response Lenses
drsNextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text) Source #
The token required to get the next set of results. This value is null if there are no more results to return.
drsScalingPolicies :: Lens' DescribeScalingPoliciesResponse [ScalingPolicy] Source #
A list of scaling policy objects.
drsResponseStatus :: Lens' DescribeScalingPoliciesResponse Int Source #
- - | The response status code.