Class: Aws::PersonalizeRuntime::Types::GetActionRecommendationsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-personalizeruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:filter_values]

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_arn ⇒ String

The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

Returns:

  • (String) 


63
64
65
66
67
68
69
70
71
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 63

class GetActionRecommendationsRequest < Struct.new(
  :campaign_arn,
  :user_id,
  :num_results,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#filter_arn ⇒ String

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

[1]: docs.aws.amazon.com/personalize/latest/dg/filter.html

Returns:

  • (String) 


63
64
65
66
67
68
69
70
71
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 63

class GetActionRecommendationsRequest < Struct.new(
  :campaign_arn,
  :user_id,
  :num_results,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#filter_values ⇒ Hash<String,String>

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 actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an `EXCLUDE` element to exclude actions, 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].

[1]: docs.aws.amazon.com/personalize/latest/dg/filter.html

Returns:

  • (Hash<String,String>) 


63
64
65
66
67
68
69
70
71
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 63

class GetActionRecommendationsRequest < Struct.new(
  :campaign_arn,
  :user_id,
  :num_results,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#num_results ⇒ Integer

The number of results to return. The default is 5. The maximum is 100.

Returns:

  • (Integer) 


63
64
65
66
67
68
69
70
71
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 63

class GetActionRecommendationsRequest < Struct.new(
  :campaign_arn,
  :user_id,
  :num_results,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#user_id ⇒ String

The user ID of the user to provide action recommendations for.

Returns:

  • (String) 


63
64
65
66
67
68
69
70
71
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 63

class GetActionRecommendationsRequest < Struct.new(
  :campaign_arn,
  :user_id,
  :num_results,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end