| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Batch.DescribeComputeEnvironments
Description
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 launch your Amazon ECS container instances into.
This operation returns paginated results.
Synopsis
- data DescribeComputeEnvironments = DescribeComputeEnvironments' {
- computeEnvironments :: Maybe [Text]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- newDescribeComputeEnvironments :: DescribeComputeEnvironments
- describeComputeEnvironments_computeEnvironments :: Lens' DescribeComputeEnvironments (Maybe [Text])
- describeComputeEnvironments_maxResults :: Lens' DescribeComputeEnvironments (Maybe Int)
- describeComputeEnvironments_nextToken :: Lens' DescribeComputeEnvironments (Maybe Text)
- 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.
Constructors
| DescribeComputeEnvironments' | |
Fields
| |
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:
DescribeComputeEnvironments, describeComputeEnvironments_computeEnvironments - A list of up to 100 compute environment names or full Amazon Resource
Name (ARN) entries.
$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.
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.
Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
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_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.
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.
Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
Destructuring the Response
data DescribeComputeEnvironmentsResponse Source #
See: newDescribeComputeEnvironmentsResponse smart constructor.
Constructors
| DescribeComputeEnvironmentsResponse' | |
Fields
| |
Instances
newDescribeComputeEnvironmentsResponse Source #
Arguments
| :: Int | |
| -> DescribeComputeEnvironmentsResponse |
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:
DescribeComputeEnvironments, describeComputeEnvironmentsResponse_computeEnvironments - The list of compute environments.
DescribeComputeEnvironments, describeComputeEnvironmentsResponse_nextToken - The nextToken value to include in a future
DescribeComputeEnvironments request. When the results of a
DescribeComputeEnvironments 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
DescribeComputeEnvironments 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.