Class: Aws::PersonalizeRuntime::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PersonalizeRuntime::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/client.rb
Overview
An API client for PersonalizeRuntime. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PersonalizeRuntime::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#get_personalized_ranking(params = {}) ⇒ Types::GetPersonalizedRankingResponse
Re-ranks a list of recommended items for the given user.
-
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
Returns a list of recommended items.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
Parameters:
- options (Hash)
Options Hash (options):
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials. This can be an instance of any one of the following classes:
Aws::Credentials
- Used for configuring static, non-refreshing credentials.Aws::SharedCredentials
- Used for loading static credentials from a shared file, such as~/.aws/config
.Aws::AssumeRoleCredentials
- Used when you need to assume a role.Aws::AssumeRoleWebIdentityCredentials
- Used when you need to assume a role after providing credentials via the web.Aws::SSOCredentials
- Used for loading credentials from AWS SSO using an access token generated fromaws login
.Aws::ProcessCredentials
- Used for loading credentials from a process that outputs to stdout.Aws::InstanceProfileCredentials
- Used for loading credentials from an EC2 IMDS on an EC2 instance.Aws::ECSCredentials
- Used for loading credentials from instances running in ECS.Aws::CognitoIdentityCredentials
- Used for loading credentials from the Cognito Identity service.
When
:credentials
are not configured directly, the following locations will be searched for credentials:Aws.config[:credentials]
- The
:access_key_id
,:secret_access_key
, and:session_token
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
~/.aws/credentials
~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts
are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentails
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:region
is used to determine the service:endpoint
. When not passed, a default:region
is searched for in the following locations:Aws.config[:region]
ENV['AWS_REGION']
ENV['AMAZON_REGION']
ENV['AWS_DEFAULT_REGION']
~/.aws/credentials
~/.aws/config
- :access_key_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to
true
, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults tofalse
. -
:adaptive_retry_wait_to_fill
(Boolean)
— default:
true
—
Used only in
adaptive
retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableError
and will not retry instead of sleeping. -
:client_side_monitoring
(Boolean)
— default:
false
—
When
true
, client-side metrics will be collected for all API requests from this client. -
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_host
(String)
— default:
"127.0.0.1"
—
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When
true
, an attempt is made to coerce request parameters into the required types. -
:correct_clock_skew
(Boolean)
— default:
true
—
Used only in
standard
and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:endpoint
(String)
—
The client endpoint is normally constructed from the
:region
option. You should only configure an:endpoint
when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. -
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to
true
, endpoint discovery will be enabled for operations when available. -
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the
:logger
at. -
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:max_attempts
(Integer)
— default:
3
—
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in
standard
andadaptive
retry modes. -
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacy
retry mode. -
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the
legacy
retry mode.@see https://www.awsarchitectureblog.com/2015/03/backoff.html
-
:retry_limit
(Integer)
— default:
3
—
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the
legacy
retry mode. -
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_mode
(String)
— default:
"legacy"
—
Specifies which retry algorithm to use. Values are:
legacy
- The pre-existing retry behavior. This is default value if no retry mode is provided.standard
- A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.adaptive
- An experimental retry mode that includes all the functionality ofstandard
mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
-
:sdk_ua_app_id
(String)
—
A unique and opaque application ID that is appended to the User-Agent header as app/
. It should have a maximum length of 50. - :secret_access_key (String)
- :session_token (String)
-
:stub_responses
(Boolean)
— default:
false
—
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.
Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
-
:token_provider
(Aws::TokenProvider)
—
A Bearer Token Provider. This can be an instance of any one of the following classes:
Aws::StaticTokenProvider
- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider
- Used for loading tokens from AWS SSO using an access token generated fromaws login
.
When
:token_provider
is not configured directly, theAws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true
, dualstack enabled endpoints (with.aws
TLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true
, fips compatible endpoints will be used if available. When afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::PersonalizeRuntime::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::PersonalizeRuntime::EndpointParameters
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_open_timeout
(Float)
— default:
15
—
The number of seconds to wait when opening a HTTP session before raising a
Timeout::Error
. -
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_idle_timeout
(Float)
— default:
5
—
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
-
:http_continue_timeout
(Float)
— default:
1
—
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to
nil
which disables this behaviour. This value can safely be set per request on the session. -
:ssl_timeout
(Float)
— default:
nil
—
Sets the SSL timeout in seconds.
-
:http_wire_trace
(Boolean)
— default:
false
—
When
true
, HTTP debug output will be sent to the:logger
. -
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true
, SSL peer certificates are verified when establishing a connection. -
:ssl_ca_bundle
(String)
—
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_directory
(String)
—
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available.
370 371 372 |
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/client.rb', line 370 def initialize(*args) super end |
Instance Method Details
#get_personalized_ranking(params = {}) ⇒ Types::GetPersonalizedRankingResponse
Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_personalized_ranking({
campaign_arn: "Arn", # required
input_list: ["ItemID"], # required
user_id: "UserID", # required
context: {
"AttributeName" => "AttributeValue",
},
filter_arn: "Arn",
filter_values: {
"FilterAttributeName" => "FilterAttributeValue",
},
})
Response structure
Response structure
resp.personalized_ranking #=> Array
resp.personalized_ranking[0].item_id #=> String
resp.personalized_ranking[0].score #=> Float
resp.personalized_ranking[0].promotion_name #=> String
resp.recommendation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:campaign_arn
(required, String)
—
The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
-
:input_list
(required, Array<String>)
—
A list of items (by
itemId
) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500. -
:user_id
(required, String)
—
The user for which you want the campaign to provide a personalized ranking.
-
:context
(Hash<String,String>)
—
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.
-
:filter_arn
(String)
—
The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.
-
: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 items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDE
element to exclude items, you can omit thefilter-values
.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.For more information, see Filtering Recommendations.
Returns:
-
(Types::GetPersonalizedRankingResponse)
—
Returns a response object which responds to the following methods:
- #personalized_ranking => Array<Types::PredictedItem>
- #recommendation_id => String
See Also:
464 465 466 467 |
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/client.rb', line 464 def get_personalized_ranking(params = {}, options = {}) req = build_request(:get_personalized_ranking, params) req.send_request(options) end |
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
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 usedRELATED_ITEMS -
itemId
required,userId
not used
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.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_recommendations({
campaign_arn: "Arn",
item_id: "ItemID",
user_id: "UserID",
num_results: 1,
context: {
"AttributeName" => "AttributeValue",
},
filter_arn: "Arn",
filter_values: {
"FilterAttributeName" => "FilterAttributeValue",
},
recommender_arn: "Arn",
promotions: [
{
name: "Name",
percent_promoted_items: 1,
filter_arn: "Arn",
filter_values: {
"FilterAttributeName" => "FilterAttributeValue",
},
},
],
})
Response structure
Response structure
resp.item_list #=> Array
resp.item_list[0].item_id #=> String
resp.item_list[0].score #=> Float
resp.item_list[0].promotion_name #=> String
resp.recommendation_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:campaign_arn
(String)
—
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
-
:item_id
(String)
—
The item ID to provide recommendations for.
Required for
RELATED_ITEMS
recipe type. -
:user_id
(String)
—
The user ID to provide recommendations for.
Required for
USER_PERSONALIZATION
recipe type. -
:num_results
(Integer)
—
The number of results to return. The default is 25. The maximum is 500.
-
:context
(Hash<String,String>)
—
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.
-
: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
. -
: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 items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDE
element to exclude items, you can omit thefilter-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.
-
:recommender_arn
(String)
—
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.
-
:promotions
(Array<Types::Promotion>)
—
The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
Returns:
-
(Types::GetRecommendationsResponse)
—
Returns a response object which responds to the following methods:
- #item_list => Array<Types::PredictedItem>
- #recommendation_id => String
See Also:
600 601 602 603 |
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/client.rb', line 600 def get_recommendations(params = {}, options = {}) req = build_request(:get_recommendations, params) req.send_request(options) end |