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 |
Returns a list of container instances in a specified cluster.
See: AWS API Reference for ListContainerInstances.
This operation returns paginated results.
- listContainerInstances :: ListContainerInstances
- data ListContainerInstances
- lciCluster :: Lens' ListContainerInstances (Maybe Text)
- lciNextToken :: Lens' ListContainerInstances (Maybe Text)
- lciMaxResults :: Lens' ListContainerInstances (Maybe Int)
- listContainerInstancesResponse :: Int -> ListContainerInstancesResponse
- data ListContainerInstancesResponse
- lcirsContainerInstanceARNs :: Lens' ListContainerInstancesResponse [Text]
- lcirsNextToken :: Lens' ListContainerInstancesResponse (Maybe Text)
- lcirsResponseStatus :: Lens' ListContainerInstancesResponse Int
Creating a Request
listContainerInstances :: ListContainerInstances Source
Creates a value of ListContainerInstances
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListContainerInstances Source
See: listContainerInstances
smart constructor.
Request Lenses
lciCluster :: 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..
lciNextToken :: Lens' ListContainerInstances (Maybe Text) Source
The nextToken
value returned from a previous paginated
ListContainerInstances
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.
lciMaxResults :: Lens' ListContainerInstances (Maybe Int) Source
The maximum number of container instance results returned by
ListContainerInstances
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 is not used, then
ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
Destructuring the Response
listContainerInstancesResponse Source
Creates a value of ListContainerInstancesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListContainerInstancesResponse Source
See: listContainerInstancesResponse
smart constructor.
Response Lenses
lcirsContainerInstanceARNs :: Lens' ListContainerInstancesResponse [Text] Source
The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.
lcirsNextToken :: 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.
lcirsResponseStatus :: Lens' ListContainerInstancesResponse Int Source
The response status code.