| 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.Snowball.ListClusters
Description
Returns an array of ClusterListEntry objects of the specified length.
Each ClusterListEntry object contains a cluster's state, a cluster's
ID, and other important status information.
This operation returns paginated results.
Synopsis
- data ListClusters = ListClusters' {}
- newListClusters :: ListClusters
- listClusters_maxResults :: Lens' ListClusters (Maybe Natural)
- listClusters_nextToken :: Lens' ListClusters (Maybe Text)
- data ListClustersResponse = ListClustersResponse' {}
- newListClustersResponse :: Int -> ListClustersResponse
- listClustersResponse_clusterListEntries :: Lens' ListClustersResponse (Maybe [ClusterListEntry])
- listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_httpStatus :: Lens' ListClustersResponse Int
Creating a Request
data ListClusters Source #
See: newListClusters smart constructor.
Constructors
| ListClusters' | |
Fields | |
Instances
newListClusters :: ListClusters Source #
Create a value of ListClusters 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:maxResults:ListClusters', listClusters_maxResults - The number of ClusterListEntry objects to return.
ListClusters, listClusters_nextToken - HTTP requests are stateless. To identify what object comes "next" in
the list of ClusterListEntry objects, you have the option of
specifying NextToken as the starting point for your returned list.
Request Lenses
listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #
The number of ClusterListEntry objects to return.
listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #
HTTP requests are stateless. To identify what object comes "next" in
the list of ClusterListEntry objects, you have the option of
specifying NextToken as the starting point for your returned list.
Destructuring the Response
data ListClustersResponse Source #
See: newListClustersResponse smart constructor.
Constructors
| ListClustersResponse' | |
Fields
| |
Instances
newListClustersResponse Source #
Arguments
| :: Int | |
| -> ListClustersResponse |
Create a value of ListClustersResponse 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:clusterListEntries:ListClustersResponse', listClustersResponse_clusterListEntries - Each ClusterListEntry object contains a cluster's state, a cluster's
ID, and other important status information.
ListClusters, listClustersResponse_nextToken - HTTP requests are stateless. If you use the automatically generated
NextToken value in your next ClusterListEntry call, your list of
returned clusters will start from this point in the array.
$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.
Response Lenses
listClustersResponse_clusterListEntries :: Lens' ListClustersResponse (Maybe [ClusterListEntry]) Source #
Each ClusterListEntry object contains a cluster's state, a cluster's
ID, and other important status information.
listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #
HTTP requests are stateless. If you use the automatically generated
NextToken value in your next ClusterListEntry call, your list of
returned clusters will start from this point in the array.
listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #
The response's http status code.