Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EKS.ListAddons

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the available add-ons.

This operation returns paginated results.

Synopsis

data ListAddons = ListAddons' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- clusterName :: Text
}
newListAddons :: Text -> ListAddons
listAddons_maxResults :: Lens' ListAddons (Maybe Natural)
listAddons_nextToken :: Lens' ListAddons (Maybe Text)
listAddons_clusterName :: Lens' ListAddons Text
data ListAddonsResponse = ListAddonsResponse' {
- addons :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAddonsResponse :: Int -> ListAddonsResponse
listAddonsResponse_addons :: Lens' ListAddonsResponse (Maybe [Text])
listAddonsResponse_nextToken :: Lens' ListAddonsResponse (Maybe Text)
listAddonsResponse_httpStatus :: Lens' ListAddonsResponse Int

Creating a Request

data ListAddons Source #

See: newListAddons smart constructor.

Constructors

ListAddons'

Fields

maxResults :: Maybe Natural
The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use this parameter, ListAddonsRequest 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 ListAddonsRequest request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListAddonsRequest returns up to 100 results and a nextToken value, if applicable.
nextToken :: Maybe Text
The nextToken value returned from a previous paginated ListAddonsRequest 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.
clusterName :: Text
The name of the cluster.

Instances

Instances details

ToHeaders ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods toHeaders :: ListAddons -> [Header] #
ToPath ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods toPath :: ListAddons -> ByteString #
ToQuery ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods toQuery :: ListAddons -> QueryString #
AWSPager ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods page :: ListAddons -> AWSResponse ListAddons -> Maybe ListAddons #
AWSRequest ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Associated Types type AWSResponse ListAddons # Methods request :: (Service -> Service) -> ListAddons -> Request ListAddons # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAddons -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAddons))) #
Generic ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Associated Types type Rep ListAddons :: Type -> Type # Methods from :: ListAddons -> Rep ListAddons x # to :: Rep ListAddons x -> ListAddons #
Read ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods readsPrec :: Int -> ReadS ListAddons # readList :: ReadS [ListAddons] # readPrec :: ReadPrec ListAddons # readListPrec :: ReadPrec [ListAddons] #
Show ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods showsPrec :: Int -> ListAddons -> ShowS # show :: ListAddons -> String # showList :: [ListAddons] -> ShowS #
NFData ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods rnf :: ListAddons -> () #
Eq ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods (==) :: ListAddons -> ListAddons -> Bool # (/=) :: ListAddons -> ListAddons -> Bool #
Hashable ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods hashWithSalt :: Int -> ListAddons -> Int # hash :: ListAddons -> Int #
type AWSResponse ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons type AWSResponse ListAddons = ListAddonsResponse
type Rep ListAddons Source #
Instance details Defined in Amazonka.EKS.ListAddons type Rep ListAddons = D1 ('MetaData "ListAddons" "Amazonka.EKS.ListAddons" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "ListAddons'" '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))))

newListAddons Source #

Arguments

:: Text	`ListAddons`
-> ListAddons

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

ListAddons, listAddons_nextToken - The nextToken value returned from a previous paginated ListAddonsRequest 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.

ListAddons, listAddons_clusterName - The name of the cluster.

Request Lenses

listAddons_maxResults :: Lens' ListAddons (Maybe Natural) Source #

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

listAddons_nextToken :: Lens' ListAddons (Maybe Text) Source #

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

listAddons_clusterName :: Lens' ListAddons Text Source #

The name of the cluster.

Destructuring the Response

data ListAddonsResponse Source #

See: newListAddonsResponse smart constructor.

Constructors

ListAddonsResponse'

Fields

addons :: Maybe [Text]
A list of available add-ons.
nextToken :: Maybe Text
The nextToken value returned from a previous paginated ListAddonsResponse 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListAddonsResponse Source #
Instance details Defined in Amazonka.EKS.ListAddons Associated Types type Rep ListAddonsResponse :: Type -> Type # Methods from :: ListAddonsResponse -> Rep ListAddonsResponse x # to :: Rep ListAddonsResponse x -> ListAddonsResponse #
Read ListAddonsResponse Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods readsPrec :: Int -> ReadS ListAddonsResponse # readList :: ReadS [ListAddonsResponse] # readPrec :: ReadPrec ListAddonsResponse # readListPrec :: ReadPrec [ListAddonsResponse] #
Show ListAddonsResponse Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods showsPrec :: Int -> ListAddonsResponse -> ShowS # show :: ListAddonsResponse -> String # showList :: [ListAddonsResponse] -> ShowS #
NFData ListAddonsResponse Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods rnf :: ListAddonsResponse -> () #
Eq ListAddonsResponse Source #
Instance details Defined in Amazonka.EKS.ListAddons Methods (==) :: ListAddonsResponse -> ListAddonsResponse -> Bool # (/=) :: ListAddonsResponse -> ListAddonsResponse -> Bool #
type Rep ListAddonsResponse Source #
Instance details Defined in Amazonka.EKS.ListAddons type Rep ListAddonsResponse = D1 ('MetaData "ListAddonsResponse" "Amazonka.EKS.ListAddons" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "ListAddonsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "addons") '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))))

newListAddonsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAddonsResponse'`
-> ListAddonsResponse

Create a value of ListAddonsResponse 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:addons:ListAddonsResponse', listAddonsResponse_addons - A list of available add-ons.

ListAddons, listAddonsResponse_nextToken - The nextToken value returned from a previous paginated ListAddonsResponse 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.

$sel:httpStatus:ListAddonsResponse', listAddonsResponse_httpStatus - The response's http status code.

Response Lenses

listAddonsResponse_addons :: Lens' ListAddonsResponse (Maybe [Text]) Source #

A list of available add-ons.

listAddonsResponse_nextToken :: Lens' ListAddonsResponse (Maybe Text) Source #

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

listAddonsResponse_httpStatus :: Lens' ListAddonsResponse Int Source #

The response's http status code.