Amazonka.EKS.ListClusters

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.

This operation returns paginated results.

Creating a Request

data ListClusters

See: newListClusters smart constructor.

Constructors

ListClusters'

Fields

• include :: Maybe [Text]

  Indicates whether external clusters are included in the returned list. Use 'all' to return connected clusters, or blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.

• maxResults :: Maybe Natural

  The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

• nextToken :: Maybe Text

  The nextToken value returned from a previous paginated ListClusters 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 token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Instances

ToHeaders ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

toHeaders :: ListClusters -> [Header]

ToPath ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

toPath :: ListClusters -> ByteString

ToQuery ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

toQuery :: ListClusters -> QueryString

AWSPager ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

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

AWSRequest ListClusters

Defined in Amazonka.EKS.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.EKS.ListClusters

Associated Types

type Rep ListClusters :: Type -> Type

Methods

from :: ListClusters -> Rep ListClusters x

to :: Rep ListClusters x -> ListClusters

Read ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

readsPrec :: Int -> ReadS ListClusters

readList :: ReadS [ListClusters]

readPrec :: ReadPrec ListClusters

readListPrec :: ReadPrec [ListClusters]

Show ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

showsPrec :: Int -> ListClusters -> ShowS

show :: ListClusters -> String

showList :: [ListClusters] -> ShowS

NFData ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

rnf :: ListClusters -> ()

Eq ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

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

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

Hashable ListClusters

Defined in Amazonka.EKS.ListClusters

Methods

hashWithSalt :: Int -> ListClusters -> Int

hash :: ListClusters -> Int

type AWSResponse ListClusters

Defined in Amazonka.EKS.ListClusters

type AWSResponse ListClusters = ListClustersResponse

type Rep ListClusters

Defined in Amazonka.EKS.ListClusters

type Rep ListClusters = D1 ('MetaData "ListClusters" "Amazonka.EKS.ListClusters" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "ListClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") '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:include:ListClusters', listClusters_include - Indicates whether external clusters are included in the returned list. Use 'all' to return connected clusters, or blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.

$sel:maxResults:ListClusters', listClusters_maxResults - The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

ListClusters, listClusters_nextToken - The nextToken value returned from a previous paginated ListClusters 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 token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Request Lenses

listClusters_include :: Lens' ListClusters (Maybe [Text])

Indicates whether external clusters are included in the returned list. Use 'all' to return connected clusters, or blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.

listClusters_maxResults :: Lens' ListClusters (Maybe Natural)

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

listClusters_nextToken :: Lens' ListClusters (Maybe Text)

The nextToken value returned from a previous paginated ListClusters 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 token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Destructuring the Response

data ListClustersResponse

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'

Fields

• clusters :: Maybe [Text]

  A list of all of the clusters for your account in the specified Region.

• nextToken :: Maybe Text

  The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListClustersResponse

Defined in Amazonka.EKS.ListClusters

Associated Types

type Rep ListClustersResponse :: Type -> Type

Methods

from :: ListClustersResponse -> Rep ListClustersResponse x

to :: Rep ListClustersResponse x -> ListClustersResponse

Read ListClustersResponse

Defined in Amazonka.EKS.ListClusters

Methods

readsPrec :: Int -> ReadS ListClustersResponse

readList :: ReadS [ListClustersResponse]

readPrec :: ReadPrec ListClustersResponse

readListPrec :: ReadPrec [ListClustersResponse]

Show ListClustersResponse

Defined in Amazonka.EKS.ListClusters

Methods

showsPrec :: Int -> ListClustersResponse -> ShowS

show :: ListClustersResponse -> String

showList :: [ListClustersResponse] -> ShowS

NFData ListClustersResponse

Defined in Amazonka.EKS.ListClusters

Methods

rnf :: ListClustersResponse -> ()

Eq ListClustersResponse

Defined in Amazonka.EKS.ListClusters

Methods

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

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

type Rep ListClustersResponse

Defined in Amazonka.EKS.ListClusters

type Rep ListClustersResponse = D1 ('MetaData "ListClustersResponse" "Amazonka.EKS.ListClusters" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "ListClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") '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 - A list of all of the clusters for your account in the specified Region.

ListClusters, listClustersResponse_nextToken - The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

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

Response Lenses

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

A list of all of the clusters for your account in the specified Region.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int

The response's http status code.