Amazonka.EMR.ListClusters

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.

Creating a Request

data ListClusters

This input determines how the ListClusters action filters the list of clusters that it returns.

See: newListClusters smart constructor.

Constructors

ListClusters'

Fields

• clusterStates :: Maybe [ClusterState]

  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.

• createdAfter :: Maybe POSIX

  The creation date and time beginning value filter for listing clusters.

• createdBefore :: Maybe POSIX

  The creation date and time end value filter for listing clusters.

• marker :: Maybe Text

  The pagination token that indicates the next set of results to retrieve.

Instances

ToJSON ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

toJSON :: ListClusters -> Value

toEncoding :: ListClusters -> Encoding

toJSONList :: [ListClusters] -> Value

toEncodingList :: [ListClusters] -> Encoding

ToHeaders ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

toHeaders :: ListClusters -> [Header]

ToPath ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

toPath :: ListClusters -> ByteString

ToQuery ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

toQuery :: ListClusters -> QueryString

AWSPager ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

page :: ListClusters -> AWSResponse ListClusters -> Maybe ListClusters

AWSRequest ListClusters

Defined in Amazonka.EMR.ListClusters

Associated Types

type AWSResponse ListClusters

Methods

request :: (Service -> Service) -> ListClusters -> Request ListClusters

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListClusters)))

Generic ListClusters

Defined in Amazonka.EMR.ListClusters

Associated Types

type Rep ListClusters :: Type -> Type

Methods

from :: ListClusters -> Rep ListClusters x

to :: Rep ListClusters x -> ListClusters

Read ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

readsPrec :: Int -> ReadS ListClusters

readList :: ReadS [ListClusters]

readPrec :: ReadPrec ListClusters

readListPrec :: ReadPrec [ListClusters]

Show ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

showsPrec :: Int -> ListClusters -> ShowS

show :: ListClusters -> String

showList :: [ListClusters] -> ShowS

NFData ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

rnf :: ListClusters -> ()

Eq ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

(==) :: ListClusters -> ListClusters -> Bool

(/=) :: ListClusters -> ListClusters -> Bool

Hashable ListClusters

Defined in Amazonka.EMR.ListClusters

Methods

hashWithSalt :: Int -> ListClusters -> Int

hash :: ListClusters -> Int

type AWSResponse ListClusters

Defined in Amazonka.EMR.ListClusters

type AWSResponse ListClusters = ListClustersResponse

type Rep ListClusters

Defined in Amazonka.EMR.ListClusters

type Rep ListClusters = D1 ('MetaData "ListClusters" "Amazonka.EMR.ListClusters" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "ListClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterState])) :*: S1 ('MetaSel ('Just "createdAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "createdBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListClusters :: ListClusters

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: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:createdAfter:ListClusters', listClusters_createdAfter - The creation date and time beginning value filter for listing clusters.

$sel:createdBefore:ListClusters', listClusters_createdBefore - The creation date and time end value filter for listing clusters.

ListClusters, listClusters_marker - The pagination token that indicates the next set of results to retrieve.

Request Lenses

listClusters_clusterStates :: Lens' ListClusters (Maybe [ClusterState])

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_createdAfter :: Lens' ListClusters (Maybe UTCTime)

The creation date and time beginning value filter for listing clusters.

listClusters_createdBefore :: Lens' ListClusters (Maybe UTCTime)

The creation date and time end value filter for listing clusters.

listClusters_marker :: Lens' ListClusters (Maybe Text)

The pagination token that indicates the next set of results to retrieve.

Destructuring the Response

data ListClustersResponse

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'

Fields

• clusters :: Maybe [ClusterSummary]

  The list of clusters for the account based on the given filters.

• marker :: Maybe Text

  The pagination token that indicates the next set of results to retrieve.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListClustersResponse

Defined in Amazonka.EMR.ListClusters

Associated Types

type Rep ListClustersResponse :: Type -> Type

Methods

from :: ListClustersResponse -> Rep ListClustersResponse x

to :: Rep ListClustersResponse x -> ListClustersResponse

Read ListClustersResponse

Defined in Amazonka.EMR.ListClusters

Methods

readsPrec :: Int -> ReadS ListClustersResponse

readList :: ReadS [ListClustersResponse]

readPrec :: ReadPrec ListClustersResponse

readListPrec :: ReadPrec [ListClustersResponse]

Show ListClustersResponse

Defined in Amazonka.EMR.ListClusters

Methods

showsPrec :: Int -> ListClustersResponse -> ShowS

show :: ListClustersResponse -> String

showList :: [ListClustersResponse] -> ShowS

NFData ListClustersResponse

Defined in Amazonka.EMR.ListClusters

Methods

rnf :: ListClustersResponse -> ()

Eq ListClustersResponse

Defined in Amazonka.EMR.ListClusters

Methods

(==) :: ListClustersResponse -> ListClustersResponse -> Bool

(/=) :: ListClustersResponse -> ListClustersResponse -> Bool

type Rep ListClustersResponse

Defined in Amazonka.EMR.ListClusters

type Rep ListClustersResponse = D1 ('MetaData "ListClustersResponse" "Amazonka.EMR.ListClusters" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "ListClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterSummary])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListClustersResponse

Arguments

:: Int

$sel:httpStatus:ListClustersResponse'

-> 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:clusters:ListClustersResponse', listClustersResponse_clusters - The list of clusters for the account based on the given filters.

ListClusters, listClustersResponse_marker - The pagination token that indicates the next set of results to retrieve.

$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.

Response Lenses

listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [ClusterSummary])

The list of clusters for the account based on the given filters.

listClustersResponse_marker :: Lens' ListClustersResponse (Maybe Text)

The pagination token that indicates the next set of results to retrieve.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int

The response's http status code.