| 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 |
Amazonka.EMR.ListClusters
Description
Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
This operation returns paginated results.
Synopsis
- data ListClusters = ListClusters' {}
- newListClusters :: ListClusters
- listClusters_createdAfter :: Lens' ListClusters (Maybe UTCTime)
- listClusters_marker :: Lens' ListClusters (Maybe Text)
- listClusters_clusterStates :: Lens' ListClusters (Maybe [ClusterState])
- listClusters_createdBefore :: Lens' ListClusters (Maybe UTCTime)
- data ListClustersResponse = ListClustersResponse' {
- marker :: Maybe Text
- clusters :: Maybe [ClusterSummary]
- httpStatus :: Int
- newListClustersResponse :: Int -> ListClustersResponse
- listClustersResponse_marker :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [ClusterSummary])
- listClustersResponse_httpStatus :: Lens' ListClustersResponse Int
Creating a Request
data ListClusters Source #
This input determines how the ListClusters action filters the list of clusters that it returns.
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:createdAfter:ListClusters', listClusters_createdAfter - The creation date and time beginning value filter for listing clusters.
$sel:marker:ListClusters', listClusters_marker - The pagination token that indicates the next set of results to retrieve.
$sel:clusterStates:ListClusters', listClusters_clusterStates - The cluster state filters to apply when listing clusters. Clusters that
change state while this action runs may be not be returned as expected
in the list of clusters.
$sel:createdBefore:ListClusters', listClusters_createdBefore - The creation date and time end value filter for listing clusters.
Request Lenses
listClusters_createdAfter :: Lens' ListClusters (Maybe UTCTime) Source #
The creation date and time beginning value filter for listing clusters.
listClusters_marker :: Lens' ListClusters (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listClusters_clusterStates :: Lens' ListClusters (Maybe [ClusterState]) Source #
The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.
listClusters_createdBefore :: Lens' ListClusters (Maybe UTCTime) Source #
The creation date and time end value filter for listing clusters.
Destructuring the Response
data ListClustersResponse Source #
This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.
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:marker:ListClusters', listClustersResponse_marker - The pagination token that indicates the next set of results to retrieve.
$sel:clusters:ListClustersResponse', listClustersResponse_clusters - The list of clusters for the account based on the given filters.
$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.
Response Lenses
listClustersResponse_marker :: Lens' ListClustersResponse (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [ClusterSummary]) Source #
The list of clusters for the account based on the given filters.
listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #
The response's http status code.