amazonka-eks-2.0: Amazon Elastic Kubernetes Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EKS.ListClusters

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListClusters Source #

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

Instances details
ToHeaders ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

ToPath ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

ToQuery ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

AWSPager ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

AWSRequest ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Associated Types

type AWSResponse ListClusters #

Generic ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Associated Types

type Rep ListClusters :: Type -> Type #

Read ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Show ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

NFData ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Methods

rnf :: ListClusters -> () #

Eq ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Hashable ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

type AWSResponse ListClusters Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

type Rep ListClusters Source # 
Instance details

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 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: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]) Source #

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) Source #

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) Source #

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 Source #

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

Instances details
Generic ListClustersResponse Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Associated Types

type Rep ListClustersResponse :: Type -> Type #

Read ListClustersResponse Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Show ListClustersResponse Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

NFData ListClustersResponse Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

Methods

rnf :: ListClustersResponse -> () #

Eq ListClustersResponse Source # 
Instance details

Defined in Amazonka.EKS.ListClusters

type Rep ListClustersResponse Source # 
Instance details

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 Source #

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]) Source #

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

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #

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.