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 scalable targets with a specified service namespace.
You can filter the results in a service namespace with the ResourceIds
and ScalableDimension
parameters.
To create a new scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.
- describeScalableTargets :: ServiceNamespace -> DescribeScalableTargets
- data DescribeScalableTargets
- dstResourceIds :: Lens' DescribeScalableTargets [Text]
- dstScalableDimension :: Lens' DescribeScalableTargets (Maybe ScalableDimension)
- dstNextToken :: Lens' DescribeScalableTargets (Maybe Text)
- dstMaxResults :: Lens' DescribeScalableTargets (Maybe Int)
- dstServiceNamespace :: Lens' DescribeScalableTargets ServiceNamespace
- describeScalableTargetsResponse :: Int -> DescribeScalableTargetsResponse
- data DescribeScalableTargetsResponse
- dstsrsNextToken :: Lens' DescribeScalableTargetsResponse (Maybe Text)
- dstsrsScalableTargets :: Lens' DescribeScalableTargetsResponse [ScalableTarget]
- dstsrsResponseStatus :: Lens' DescribeScalableTargetsResponse Int
Creating a Request
describeScalableTargets Source #
Creates a value of DescribeScalableTargets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeScalableTargets Source #
See: describeScalableTargets
smart constructor.
Request Lenses
dstResourceIds :: Lens' DescribeScalableTargets [Text] Source #
The unique identifier string for the resource associated with the scalable target. 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.
dstScalableDimension :: Lens' DescribeScalableTargets (Maybe ScalableDimension) Source #
The scalable dimension associated with the scalable target. 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.
dstNextToken :: Lens' DescribeScalableTargets (Maybe Text) Source #
The NextToken
value returned from a previous paginated DescribeScalableTargets
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.
dstMaxResults :: Lens' DescribeScalableTargets (Maybe Int) Source #
The maximum number of scalable target results returned by DescribeScalableTargets
in paginated output. When this parameter is used, DescribeScalableTargets
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 DescribeScalableTargets
request with the returned NextToken
value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets
returns up to 50 results and a NextToken
value, if applicable.
dstServiceNamespace :: Lens' DescribeScalableTargets ServiceNamespace Source #
The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
Destructuring the Response
describeScalableTargetsResponse Source #
Creates a value of DescribeScalableTargetsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeScalableTargetsResponse Source #
See: describeScalableTargetsResponse
smart constructor.
Response Lenses
dstsrsNextToken :: Lens' DescribeScalableTargetsResponse (Maybe Text) Source #
The NextToken
value to include in a future DescribeScalableTargets
request. When the results of a DescribeScalableTargets
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.
dstsrsScalableTargets :: Lens' DescribeScalableTargetsResponse [ScalableTarget] Source #
The list of scalable targets that matches the request parameters.
dstsrsResponseStatus :: Lens' DescribeScalableTargetsResponse Int Source #
The response status code.