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.ListFargateProfiles

Description

Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFargateProfiles Source #

See: newListFargateProfiles smart constructor.

Constructors

ListFargateProfiles' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles 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 ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated ListFargateProfiles 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.

  • clusterName :: Text

    The name of the Amazon EKS cluster that you would like to list Fargate profiles in.

Instances

Instances details
ToHeaders ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

ToPath ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

ToQuery ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

AWSPager ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

AWSRequest ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Associated Types

type AWSResponse ListFargateProfiles #

Generic ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Associated Types

type Rep ListFargateProfiles :: Type -> Type #

Read ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Show ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

NFData ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Methods

rnf :: ListFargateProfiles -> () #

Eq ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Hashable ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

type AWSResponse ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

type Rep ListFargateProfiles Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

type Rep ListFargateProfiles = D1 ('MetaData "ListFargateProfiles" "Amazonka.EKS.ListFargateProfiles" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "ListFargateProfiles'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListFargateProfiles Source #

Create a value of ListFargateProfiles 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:ListFargateProfiles', listFargateProfiles_maxResults - The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles 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 ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

ListFargateProfiles, listFargateProfiles_nextToken - The nextToken value returned from a previous paginated ListFargateProfiles 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.

ListFargateProfiles, listFargateProfiles_clusterName - The name of the Amazon EKS cluster that you would like to list Fargate profiles in.

Request Lenses

listFargateProfiles_maxResults :: Lens' ListFargateProfiles (Maybe Natural) Source #

The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles 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 ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

listFargateProfiles_nextToken :: Lens' ListFargateProfiles (Maybe Text) Source #

The nextToken value returned from a previous paginated ListFargateProfiles 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.

listFargateProfiles_clusterName :: Lens' ListFargateProfiles Text Source #

The name of the Amazon EKS cluster that you would like to list Fargate profiles in.

Destructuring the Response

data ListFargateProfilesResponse Source #

See: newListFargateProfilesResponse smart constructor.

Constructors

ListFargateProfilesResponse' 

Fields

  • fargateProfileNames :: Maybe [Text]

    A list of all of the Fargate profiles associated with the specified cluster.

  • nextToken :: Maybe Text

    The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles 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 ListFargateProfilesResponse Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Associated Types

type Rep ListFargateProfilesResponse :: Type -> Type #

Read ListFargateProfilesResponse Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Show ListFargateProfilesResponse Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

NFData ListFargateProfilesResponse Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

Eq ListFargateProfilesResponse Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

type Rep ListFargateProfilesResponse Source # 
Instance details

Defined in Amazonka.EKS.ListFargateProfiles

type Rep ListFargateProfilesResponse = D1 ('MetaData "ListFargateProfilesResponse" "Amazonka.EKS.ListFargateProfiles" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "ListFargateProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fargateProfileNames") '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))))

newListFargateProfilesResponse Source #

Create a value of ListFargateProfilesResponse 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:fargateProfileNames:ListFargateProfilesResponse', listFargateProfilesResponse_fargateProfileNames - A list of all of the Fargate profiles associated with the specified cluster.

ListFargateProfiles, listFargateProfilesResponse_nextToken - The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles 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:ListFargateProfilesResponse', listFargateProfilesResponse_httpStatus - The response's http status code.

Response Lenses

listFargateProfilesResponse_fargateProfileNames :: Lens' ListFargateProfilesResponse (Maybe [Text]) Source #

A list of all of the Fargate profiles associated with the specified cluster.

listFargateProfilesResponse_nextToken :: Lens' ListFargateProfilesResponse (Maybe Text) Source #

The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles 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.