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.Personalize.ListRecommenders

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.

This operation returns paginated results.

Creating a Request

data ListRecommenders Source #

See: newListRecommenders smart constructor.

Constructors

ListRecommenders'

Fields

datasetGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
maxResults :: Maybe Natural
The maximum number of recommenders to return.
nextToken :: Maybe Text
A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

Instances

Instances details

ToJSON ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods toJSON :: ListRecommenders -> Value # toEncoding :: ListRecommenders -> Encoding # toJSONList :: [ListRecommenders] -> Value # toEncodingList :: [ListRecommenders] -> Encoding #
ToHeaders ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods toHeaders :: ListRecommenders -> [Header] #
ToPath ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods toPath :: ListRecommenders -> ByteString #
ToQuery ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods toQuery :: ListRecommenders -> QueryString #
AWSPager ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods page :: ListRecommenders -> AWSResponse ListRecommenders -> Maybe ListRecommenders #
AWSRequest ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Associated Types type AWSResponse ListRecommenders # Methods request :: (Service -> Service) -> ListRecommenders -> Request ListRecommenders # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRecommenders -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRecommenders))) #
Generic ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Associated Types type Rep ListRecommenders :: Type -> Type # Methods from :: ListRecommenders -> Rep ListRecommenders x # to :: Rep ListRecommenders x -> ListRecommenders #
Read ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods readsPrec :: Int -> ReadS ListRecommenders # readList :: ReadS [ListRecommenders] # readPrec :: ReadPrec ListRecommenders # readListPrec :: ReadPrec [ListRecommenders] #
Show ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods showsPrec :: Int -> ListRecommenders -> ShowS # show :: ListRecommenders -> String # showList :: [ListRecommenders] -> ShowS #
NFData ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods rnf :: ListRecommenders -> () #
Eq ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods (==) :: ListRecommenders -> ListRecommenders -> Bool # (/=) :: ListRecommenders -> ListRecommenders -> Bool #
Hashable ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods hashWithSalt :: Int -> ListRecommenders -> Int # hash :: ListRecommenders -> Int #
type AWSResponse ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders type AWSResponse ListRecommenders = ListRecommendersResponse
type Rep ListRecommenders Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders type Rep ListRecommenders = D1 ('MetaData "ListRecommenders" "Amazonka.Personalize.ListRecommenders" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "ListRecommenders'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetGroupArn") '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)))))

newListRecommenders :: ListRecommenders Source #

Create a value of ListRecommenders 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:

ListRecommenders, listRecommenders_datasetGroupArn - The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.

$sel:maxResults:ListRecommenders', listRecommenders_maxResults - The maximum number of recommenders to return.

ListRecommenders, listRecommenders_nextToken - A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

Request Lenses

listRecommenders_datasetGroupArn :: Lens' ListRecommenders (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.

listRecommenders_maxResults :: Lens' ListRecommenders (Maybe Natural) Source #

The maximum number of recommenders to return.

listRecommenders_nextToken :: Lens' ListRecommenders (Maybe Text) Source #

A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

Destructuring the Response

data ListRecommendersResponse Source #

See: newListRecommendersResponse smart constructor.

Constructors

ListRecommendersResponse'
Fields nextToken :: Maybe Text A token for getting the next set of recommenders (if they exist). recommenders :: Maybe [RecommenderSummary] A list of the recommenders. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListRecommendersResponse Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Associated Types type Rep ListRecommendersResponse :: Type -> Type # Methods from :: ListRecommendersResponse -> Rep ListRecommendersResponse x # to :: Rep ListRecommendersResponse x -> ListRecommendersResponse #
Read ListRecommendersResponse Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods readsPrec :: Int -> ReadS ListRecommendersResponse # readList :: ReadS [ListRecommendersResponse] # readPrec :: ReadPrec ListRecommendersResponse # readListPrec :: ReadPrec [ListRecommendersResponse] #
Show ListRecommendersResponse Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods showsPrec :: Int -> ListRecommendersResponse -> ShowS # show :: ListRecommendersResponse -> String # showList :: [ListRecommendersResponse] -> ShowS #
NFData ListRecommendersResponse Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods rnf :: ListRecommendersResponse -> () #
Eq ListRecommendersResponse Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders Methods (==) :: ListRecommendersResponse -> ListRecommendersResponse -> Bool # (/=) :: ListRecommendersResponse -> ListRecommendersResponse -> Bool #
type Rep ListRecommendersResponse Source #
Instance details Defined in Amazonka.Personalize.ListRecommenders type Rep ListRecommendersResponse = D1 ('MetaData "ListRecommendersResponse" "Amazonka.Personalize.ListRecommenders" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "ListRecommendersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recommenders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecommenderSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRecommendersResponse Source #

Arguments

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

Create a value of ListRecommendersResponse 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:

ListRecommenders, listRecommendersResponse_nextToken - A token for getting the next set of recommenders (if they exist).

$sel:recommenders:ListRecommendersResponse', listRecommendersResponse_recommenders - A list of the recommenders.

$sel:httpStatus:ListRecommendersResponse', listRecommendersResponse_httpStatus - The response's http status code.

Response Lenses

listRecommendersResponse_nextToken :: Lens' ListRecommendersResponse (Maybe Text) Source #

A token for getting the next set of recommenders (if they exist).

listRecommendersResponse_recommenders :: Lens' ListRecommendersResponse (Maybe [RecommenderSummary]) Source #

A list of the recommenders.

listRecommendersResponse_httpStatus :: Lens' ListRecommendersResponse Int Source #

The response's http status code.