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 |
Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the
DescribeComputeEnvironment
operation to determine the ecsClusterArn
that you should launch your Amazon ECS container instances into.
This operation returns paginated results.
Synopsis
- data DescribeComputeEnvironments = DescribeComputeEnvironments' {
- computeEnvironments :: Maybe [Text]
- nextToken :: Maybe Text
- maxResults :: Maybe Int
- newDescribeComputeEnvironments :: DescribeComputeEnvironments
- describeComputeEnvironments_computeEnvironments :: Lens' DescribeComputeEnvironments (Maybe [Text])
- describeComputeEnvironments_nextToken :: Lens' DescribeComputeEnvironments (Maybe Text)
- describeComputeEnvironments_maxResults :: Lens' DescribeComputeEnvironments (Maybe Int)
- data DescribeComputeEnvironmentsResponse = DescribeComputeEnvironmentsResponse' {}
- newDescribeComputeEnvironmentsResponse :: Int -> DescribeComputeEnvironmentsResponse
- describeComputeEnvironmentsResponse_computeEnvironments :: Lens' DescribeComputeEnvironmentsResponse (Maybe [ComputeEnvironmentDetail])
- describeComputeEnvironmentsResponse_nextToken :: Lens' DescribeComputeEnvironmentsResponse (Maybe Text)
- describeComputeEnvironmentsResponse_httpStatus :: Lens' DescribeComputeEnvironmentsResponse Int
Creating a Request
data DescribeComputeEnvironments Source #
Contains the parameters for DescribeComputeEnvironments
.
See: newDescribeComputeEnvironments
smart constructor.
DescribeComputeEnvironments' | |
|
Instances
newDescribeComputeEnvironments :: DescribeComputeEnvironments Source #
Create a value of DescribeComputeEnvironments
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:computeEnvironments:DescribeComputeEnvironments'
, describeComputeEnvironments_computeEnvironments
- A list of up to 100 compute environment names or full Amazon Resource
Name (ARN) entries.
$sel:nextToken:DescribeComputeEnvironments'
, describeComputeEnvironments_nextToken
- The nextToken
value returned from a previous paginated
DescribeComputeEnvironments
request where maxResults
was used and
the results exceeded the value of that parameter. 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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:DescribeComputeEnvironments'
, describeComputeEnvironments_maxResults
- The maximum number of cluster results returned by
DescribeComputeEnvironments
in paginated output. When this parameter
is used, DescribeComputeEnvironments
only returns 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
DescribeComputeEnvironments
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter isn't
used, then DescribeComputeEnvironments
returns up to 100 results and a
nextToken
value if applicable.
Request Lenses
describeComputeEnvironments_computeEnvironments :: Lens' DescribeComputeEnvironments (Maybe [Text]) Source #
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
describeComputeEnvironments_nextToken :: Lens' DescribeComputeEnvironments (Maybe Text) Source #
The nextToken
value returned from a previous paginated
DescribeComputeEnvironments
request where maxResults
was used and
the results exceeded the value of that parameter. 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.
This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
describeComputeEnvironments_maxResults :: Lens' DescribeComputeEnvironments (Maybe Int) Source #
The maximum number of cluster results returned by
DescribeComputeEnvironments
in paginated output. When this parameter
is used, DescribeComputeEnvironments
only returns 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
DescribeComputeEnvironments
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter isn't
used, then DescribeComputeEnvironments
returns up to 100 results and a
nextToken
value if applicable.
Destructuring the Response
data DescribeComputeEnvironmentsResponse Source #
See: newDescribeComputeEnvironmentsResponse
smart constructor.
DescribeComputeEnvironmentsResponse' | |
|
Instances
newDescribeComputeEnvironmentsResponse Source #
Create a value of DescribeComputeEnvironmentsResponse
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:computeEnvironments:DescribeComputeEnvironments'
, describeComputeEnvironmentsResponse_computeEnvironments
- The list of compute environments.
$sel:nextToken:DescribeComputeEnvironments'
, describeComputeEnvironmentsResponse_nextToken
- The nextToken
value to include in a future
DescribeComputeEnvironments
request. When the results of a
DescribeJobDefinitions
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.
$sel:httpStatus:DescribeComputeEnvironmentsResponse'
, describeComputeEnvironmentsResponse_httpStatus
- The response's http status code.
Response Lenses
describeComputeEnvironmentsResponse_computeEnvironments :: Lens' DescribeComputeEnvironmentsResponse (Maybe [ComputeEnvironmentDetail]) Source #
The list of compute environments.
describeComputeEnvironmentsResponse_nextToken :: Lens' DescribeComputeEnvironmentsResponse (Maybe Text) Source #
The nextToken
value to include in a future
DescribeComputeEnvironments
request. When the results of a
DescribeJobDefinitions
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.
describeComputeEnvironmentsResponse_httpStatus :: Lens' DescribeComputeEnvironmentsResponse Int Source #
The response's http status code.