| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.OpsWorks.DescribeEcsClusters
Description
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 Stacks
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 about user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
This operation returns paginated results.
Synopsis
- data DescribeEcsClusters = DescribeEcsClusters' {}
- newDescribeEcsClusters :: DescribeEcsClusters
- describeEcsClusters_nextToken :: Lens' DescribeEcsClusters (Maybe Text)
- describeEcsClusters_stackId :: Lens' DescribeEcsClusters (Maybe Text)
- describeEcsClusters_maxResults :: Lens' DescribeEcsClusters (Maybe Int)
- describeEcsClusters_ecsClusterArns :: Lens' DescribeEcsClusters (Maybe [Text])
- data DescribeEcsClustersResponse = DescribeEcsClustersResponse' {
- nextToken :: Maybe Text
- ecsClusters :: Maybe [EcsCluster]
- httpStatus :: Int
- newDescribeEcsClustersResponse :: Int -> DescribeEcsClustersResponse
- describeEcsClustersResponse_nextToken :: Lens' DescribeEcsClustersResponse (Maybe Text)
- describeEcsClustersResponse_ecsClusters :: Lens' DescribeEcsClustersResponse (Maybe [EcsCluster])
- describeEcsClustersResponse_httpStatus :: Lens' DescribeEcsClustersResponse Int
Creating a Request
data DescribeEcsClusters Source #
See: newDescribeEcsClusters smart constructor.
Constructors
| DescribeEcsClusters' | |
Fields
| |
Instances
newDescribeEcsClusters :: DescribeEcsClusters Source #
Create a value of DescribeEcsClusters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeEcsClusters', describeEcsClusters_nextToken - 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.
$sel:stackId:DescribeEcsClusters', describeEcsClusters_stackId - A stack ID. DescribeEcsClusters returns a description of the cluster
that is registered with the stack.
$sel:maxResults:DescribeEcsClusters', describeEcsClusters_maxResults - 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.
$sel:ecsClusterArns:DescribeEcsClusters', describeEcsClusters_ecsClusterArns - A list of ARNs, one for each cluster to be described.
Request Lenses
describeEcsClusters_nextToken :: 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.
describeEcsClusters_stackId :: Lens' DescribeEcsClusters (Maybe Text) Source #
A stack ID. DescribeEcsClusters returns a description of the cluster
that is registered with the stack.
describeEcsClusters_maxResults :: 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.
describeEcsClusters_ecsClusterArns :: Lens' DescribeEcsClusters (Maybe [Text]) Source #
A list of ARNs, one for each cluster to be described.
Destructuring the Response
data DescribeEcsClustersResponse Source #
Contains the response to a DescribeEcsClusters request.
See: newDescribeEcsClustersResponse smart constructor.
Constructors
| DescribeEcsClustersResponse' | |
Fields
| |
Instances
newDescribeEcsClustersResponse Source #
Create a value of DescribeEcsClustersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeEcsClusters', describeEcsClustersResponse_nextToken - 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.
$sel:ecsClusters:DescribeEcsClustersResponse', describeEcsClustersResponse_ecsClusters - A list of EcsCluster objects containing the cluster descriptions.
$sel:httpStatus:DescribeEcsClustersResponse', describeEcsClustersResponse_httpStatus - The response's http status code.
Response Lenses
describeEcsClustersResponse_nextToken :: 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.
describeEcsClustersResponse_ecsClusters :: Lens' DescribeEcsClustersResponse (Maybe [EcsCluster]) Source #
A list of EcsCluster objects containing the cluster descriptions.
describeEcsClustersResponse_httpStatus :: Lens' DescribeEcsClustersResponse Int Source #
The response's http status code.