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 |
Provides descriptive information for scaling policies with a specified service namespace.
You can filter the results in a service namespace with the ResourceId
, ScalableDimension
, and PolicyNames
parameters.
To create a new scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.
- 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 #
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:
data DescribeScalingPolicies Source #
See: describeScalingPolicies
smart constructor.
Request Lenses
dPolicyNames :: Lens' DescribeScalingPolicies [Text] Source #
The names of the scaling policies to describe.
dScalableDimension :: Lens' DescribeScalingPolicies (Maybe ScalableDimension) Source #
The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as 'ecs:service:DesiredCount' for the desired task count of an Amazon ECS service. If you specify a scalable dimension, you must also specify a resource ID.
dResourceId :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as 'service\/default\/sample-webapp'. If you specify a scalable dimension, you must also specify a resource ID.
dNextToken :: Lens' DescribeScalingPolicies (Maybe Text) Source #
The NextToken
value returned from a previous paginated DescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
dMaxResults :: Lens' DescribeScalingPolicies (Maybe Int) Source #
The maximum number of scaling policy results returned by DescribeScalingPolicies
in paginated output. When this parameter is used, DescribeScalingPolicies
returns up to MaxResults
results in a single page along with a NextToken
response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies
request with the returned NextToken
value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies
returns up to 50 results and a NextToken
value, if applicable.
dServiceNamespace :: Lens' DescribeScalingPolicies ServiceNamespace Source #
The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
Destructuring the Response
describeScalingPoliciesResponse Source #
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:
data DescribeScalingPoliciesResponse Source #
See: describeScalingPoliciesResponse
smart constructor.
Response Lenses
drsNextToken :: Lens' DescribeScalingPoliciesResponse (Maybe Text) Source #
The NextToken
value to include in a future DescribeScalingPolicies
request. When the results of a DescribeScalingPolicies
request exceed MaxResults
, this value can be used to retrieve the next page of results. This value is null
when 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.