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 |
Returns a list of container instances in a specified cluster. You can
filter the results of a ListContainerInstances
operation with cluster
query language statements inside the filter
parameter. For more
information, see
Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
This operation returns paginated results.
Synopsis
- data ListContainerInstances = ListContainerInstances' {}
- newListContainerInstances :: ListContainerInstances
- listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text)
- listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text)
- listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int)
- listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text)
- listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus)
- data ListContainerInstancesResponse = ListContainerInstancesResponse' {
- containerInstanceArns :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListContainerInstancesResponse :: Int -> ListContainerInstancesResponse
- listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text])
- listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text)
- listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int
Creating a Request
data ListContainerInstances Source #
See: newListContainerInstances
smart constructor.
ListContainerInstances' | |
|
Instances
newListContainerInstances :: ListContainerInstances Source #
Create a value of ListContainerInstances
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:cluster:ListContainerInstances'
, listContainerInstances_cluster
- The short name or full Amazon Resource Name (ARN) of the cluster that
hosts the container instances to list. If you do not specify a cluster,
the default cluster is assumed.
$sel:filter':ListContainerInstances'
, listContainerInstances_filter
- You can filter the results of a ListContainerInstances
operation with
cluster query language statements. For more information, see
Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
$sel:maxResults:ListContainerInstances'
, listContainerInstances_maxResults
- The maximum number of container instance results that
ListContainerInstances
returned in paginated output. When this
parameter is used, ListContainerInstances
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
ListContainerInstances
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter isn't used, then
ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
ListContainerInstances
, listContainerInstances_nextToken
- The nextToken
value returned from a ListContainerInstances
request
indicating that more results are available to fulfill the request and
further calls are needed. If maxResults
was provided, it's possible
the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
ListContainerInstances
, listContainerInstances_status
- Filters the container instances by status. For example, if you specify
the DRAINING
status, the results include only container instances that
have been set to DRAINING
using UpdateContainerInstancesState. If you
don't specify this parameter, the default is to include container
instances set to all states other than INACTIVE
.
Request Lenses
listContainerInstances_cluster :: Lens' ListContainerInstances (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
listContainerInstances_filter :: Lens' ListContainerInstances (Maybe Text) Source #
You can filter the results of a ListContainerInstances
operation with
cluster query language statements. For more information, see
Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
listContainerInstances_maxResults :: Lens' ListContainerInstances (Maybe Int) Source #
The maximum number of container instance results that
ListContainerInstances
returned in paginated output. When this
parameter is used, ListContainerInstances
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
ListContainerInstances
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter isn't used, then
ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
listContainerInstances_nextToken :: Lens' ListContainerInstances (Maybe Text) Source #
The nextToken
value returned from a ListContainerInstances
request
indicating that more results are available to fulfill the request and
further calls are needed. If maxResults
was provided, it's possible
the number of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listContainerInstances_status :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus) Source #
Filters the container instances by status. For example, if you specify
the DRAINING
status, the results include only container instances that
have been set to DRAINING
using UpdateContainerInstancesState. If you
don't specify this parameter, the default is to include container
instances set to all states other than INACTIVE
.
Destructuring the Response
data ListContainerInstancesResponse Source #
See: newListContainerInstancesResponse
smart constructor.
ListContainerInstancesResponse' | |
|
Instances
newListContainerInstancesResponse Source #
Create a value of ListContainerInstancesResponse
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:containerInstanceArns:ListContainerInstancesResponse'
, listContainerInstancesResponse_containerInstanceArns
- The list of container instances with full ARN entries for each container
instance associated with the specified cluster.
ListContainerInstances
, listContainerInstancesResponse_nextToken
- The nextToken
value to include in a future ListContainerInstances
request. When the results of a ListContainerInstances
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:ListContainerInstancesResponse'
, listContainerInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
listContainerInstancesResponse_containerInstanceArns :: Lens' ListContainerInstancesResponse (Maybe [Text]) Source #
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
listContainerInstancesResponse_nextToken :: Lens' ListContainerInstancesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListContainerInstances
request. When the results of a ListContainerInstances
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.
listContainerInstancesResponse_httpStatus :: Lens' ListContainerInstancesResponse Int Source #
The response's http status code.