Copyright | (c) 2013-2015 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 |
Describes Amazon ECS clusters that are registered with a stack. If you
specify only a stack ID, you can use the MaxResults
and NextToken
parameters to paginate the response. However, AWS OpsWorks currently
supports only one cluster per layer, so the result set has a maximum of
one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.
See: AWS API Reference for DescribeEcsClusters.
- describeEcsClusters :: DescribeEcsClusters
- data DescribeEcsClusters
- decNextToken :: Lens' DescribeEcsClusters (Maybe Text)
- decStackId :: Lens' DescribeEcsClusters (Maybe Text)
- decMaxResults :: Lens' DescribeEcsClusters (Maybe Int)
- decEcsClusterARNs :: Lens' DescribeEcsClusters [Text]
- describeEcsClustersResponse :: Int -> DescribeEcsClustersResponse
- data DescribeEcsClustersResponse
- decrsNextToken :: Lens' DescribeEcsClustersResponse (Maybe Text)
- decrsEcsClusters :: Lens' DescribeEcsClustersResponse [EcsCluster]
- decrsResponseStatus :: Lens' DescribeEcsClustersResponse Int
Creating a Request
describeEcsClusters :: DescribeEcsClusters Source
Creates a value of DescribeEcsClusters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeEcsClusters Source
See: describeEcsClusters
smart constructor.
Request Lenses
decNextToken :: Lens' DescribeEcsClusters (Maybe Text) Source
If the previous paginated request did not return all of the remaining
results, the response object'sNextToken
parameter value is set to a
token. To retrieve the next set of results, call DescribeEcsClusters
again and assign that token to the request object's NextToken
parameter. If there are no remaining results, the previous response
object's NextToken
parameter is set to null
.
decStackId :: Lens' DescribeEcsClusters (Maybe Text) Source
A stack ID. DescribeEcsClusters
returns a description of the cluster
that is registered with the stack.
decMaxResults :: Lens' DescribeEcsClusters (Maybe Int) Source
To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken
value that you can assign to the NextToken
request
parameter to get the next set of results.
decEcsClusterARNs :: Lens' DescribeEcsClusters [Text] Source
A list of ARNs, one for each cluster to be described.
Destructuring the Response
describeEcsClustersResponse Source
Creates a value of DescribeEcsClustersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeEcsClustersResponse Source
Contains the response to a DescribeEcsClusters
request.
See: describeEcsClustersResponse
smart constructor.
Response Lenses
decrsNextToken :: Lens' DescribeEcsClustersResponse (Maybe Text) Source
If a paginated request does not return all of the remaining results,
this parameter is set to a token that you can assign to the request
object's NextToken
parameter to retrieve the next set of results. If
the previous paginated request returned all of the remaining results,
this parameter is set to null
.
decrsEcsClusters :: Lens' DescribeEcsClustersResponse [EcsCluster] Source
A list of EcsCluster
objects containing the cluster descriptions.
decrsResponseStatus :: Lens' DescribeEcsClustersResponse Int Source
The response status code.