Amazonka.PersonalizeRuntime.GetRecommendations

Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:

• USER_PERSONALIZATION - userId required, itemId not used
• RELATED_ITEMS - itemId required, userId not used

Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.

For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases.

Creating a Request

data GetRecommendations

See: newGetRecommendations smart constructor.

Constructors

GetRecommendations'

Fields

• campaignArn :: Maybe Text

  The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

• context :: Maybe (HashMap Text (Sensitive Text))

  The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

• filterArn :: Maybe Text

  The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

  When using this parameter, be sure the filter resource is ACTIVE.

• filterValues :: Maybe (HashMap Text (Sensitive Text))

  The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

  For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

  For more information, see Filtering recommendations and user segments.

• itemId :: Maybe Text

  The item ID to provide recommendations for.

  Required for RELATED_ITEMS recipe type.

• numResults :: Maybe Natural

  The number of results to return. The default is 25. The maximum is 500.

• promotions :: Maybe [Promotion]

  The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

• recommenderArn :: Maybe Text

  The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

• userId :: Maybe Text

  The user ID to provide recommendations for.

  Required for USER_PERSONALIZATION recipe type.

Instances

ToJSON GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

toJSON :: GetRecommendations -> Value

toEncoding :: GetRecommendations -> Encoding

toJSONList :: [GetRecommendations] -> Value

toEncodingList :: [GetRecommendations] -> Encoding

ToHeaders GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

toHeaders :: GetRecommendations -> [Header]

ToPath GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

toPath :: GetRecommendations -> ByteString

ToQuery GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

toQuery :: GetRecommendations -> QueryString

AWSRequest GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Associated Types

type AWSResponse GetRecommendations

Methods

request :: (Service -> Service) -> GetRecommendations -> Request GetRecommendations

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRecommendations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRecommendations)))

Generic GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Associated Types

type Rep GetRecommendations :: Type -> Type

Methods

from :: GetRecommendations -> Rep GetRecommendations x

to :: Rep GetRecommendations x -> GetRecommendations

Show GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

showsPrec :: Int -> GetRecommendations -> ShowS

show :: GetRecommendations -> String

showList :: [GetRecommendations] -> ShowS

NFData GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

rnf :: GetRecommendations -> ()

Eq GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

(==) :: GetRecommendations -> GetRecommendations -> Bool

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

Hashable GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

hashWithSalt :: Int -> GetRecommendations -> Int

hash :: GetRecommendations -> Int

type AWSResponse GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

type AWSResponse GetRecommendations = GetRecommendationsResponse

type Rep GetRecommendations

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

type Rep GetRecommendations = D1 ('MetaData "GetRecommendations" "Amazonka.PersonalizeRuntime.GetRecommendations" "amazonka-personalize-runtime-2.0-F3C1CsdiQVG5CxrVfC5dKS" 'False) (C1 ('MetaCons "GetRecommendations'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "campaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text))))) :*: (S1 ('MetaSel ('Just "filterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filterValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text)))))) :*: ((S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "promotions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Promotion])) :*: (S1 ('MetaSel ('Just "recommenderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newGetRecommendations :: GetRecommendations

Create a value of GetRecommendations 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:campaignArn:GetRecommendations', getRecommendations_campaignArn - The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

$sel:context:GetRecommendations', getRecommendations_context - The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

GetRecommendations, getRecommendations_filterArn - The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

When using this parameter, be sure the filter resource is ACTIVE.

GetRecommendations, getRecommendations_filterValues - The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

GetRecommendations, getRecommendations_itemId - The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

$sel:numResults:GetRecommendations', getRecommendations_numResults - The number of results to return. The default is 25. The maximum is 500.

$sel:promotions:GetRecommendations', getRecommendations_promotions - The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

$sel:recommenderArn:GetRecommendations', getRecommendations_recommenderArn - The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

$sel:userId:GetRecommendations', getRecommendations_userId - The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Request Lenses

getRecommendations_campaignArn :: Lens' GetRecommendations (Maybe Text)

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

getRecommendations_context :: Lens' GetRecommendations (Maybe (HashMap Text Text))

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

getRecommendations_filterArn :: Lens' GetRecommendations (Maybe Text)

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

When using this parameter, be sure the filter resource is ACTIVE.

getRecommendations_filterValues :: Lens' GetRecommendations (Maybe (HashMap Text Text))

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

getRecommendations_itemId :: Lens' GetRecommendations (Maybe Text)

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

getRecommendations_numResults :: Lens' GetRecommendations (Maybe Natural)

The number of results to return. The default is 25. The maximum is 500.

getRecommendations_promotions :: Lens' GetRecommendations (Maybe [Promotion])

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

getRecommendations_recommenderArn :: Lens' GetRecommendations (Maybe Text)

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

getRecommendations_userId :: Lens' GetRecommendations (Maybe Text)

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Destructuring the Response

data GetRecommendationsResponse

See: newGetRecommendationsResponse smart constructor.

Constructors

GetRecommendationsResponse'

Fields

• itemList :: Maybe [PredictedItem]

  A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.

• recommendationId :: Maybe Text

  The ID of the recommendation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRecommendationsResponse

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Associated Types

type Rep GetRecommendationsResponse :: Type -> Type

Methods

from :: GetRecommendationsResponse -> Rep GetRecommendationsResponse x

to :: Rep GetRecommendationsResponse x -> GetRecommendationsResponse

Read GetRecommendationsResponse

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

readsPrec :: Int -> ReadS GetRecommendationsResponse

readList :: ReadS [GetRecommendationsResponse]

readPrec :: ReadPrec GetRecommendationsResponse

readListPrec :: ReadPrec [GetRecommendationsResponse]

Show GetRecommendationsResponse

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

showsPrec :: Int -> GetRecommendationsResponse -> ShowS

show :: GetRecommendationsResponse -> String

showList :: [GetRecommendationsResponse] -> ShowS

NFData GetRecommendationsResponse

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

rnf :: GetRecommendationsResponse -> ()

Eq GetRecommendationsResponse

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

Methods

(==) :: GetRecommendationsResponse -> GetRecommendationsResponse -> Bool

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

type Rep GetRecommendationsResponse

Defined in Amazonka.PersonalizeRuntime.GetRecommendations

type Rep GetRecommendationsResponse = D1 ('MetaData "GetRecommendationsResponse" "Amazonka.PersonalizeRuntime.GetRecommendations" "amazonka-personalize-runtime-2.0-F3C1CsdiQVG5CxrVfC5dKS" 'False) (C1 ('MetaCons "GetRecommendationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "itemList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PredictedItem])) :*: (S1 ('MetaSel ('Just "recommendationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRecommendationsResponse

Arguments

:: Int

$sel:httpStatus:GetRecommendationsResponse'

-> GetRecommendationsResponse

Create a value of GetRecommendationsResponse 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:itemList:GetRecommendationsResponse', getRecommendationsResponse_itemList - A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.

$sel:recommendationId:GetRecommendationsResponse', getRecommendationsResponse_recommendationId - The ID of the recommendation.

$sel:httpStatus:GetRecommendationsResponse', getRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

getRecommendationsResponse_itemList :: Lens' GetRecommendationsResponse (Maybe [PredictedItem])

A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.

getRecommendationsResponse_recommendationId :: Lens' GetRecommendationsResponse (Maybe Text)

The ID of the recommendation.

getRecommendationsResponse_httpStatus :: Lens' GetRecommendationsResponse Int

The response's http status code.