[ aws . customer-profiles ]

get-recommender

Description

Retrieves a recommender.

See also: AWS API Documentation

Synopsis

  get-recommender
--domain-name <value>
--recommender-name <value>
[--training-metrics-count <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--domain-name (string) [required]

The unique name of the domain.

Constraints:

• min: 1
• max: 64
• pattern: ^[a-zA-Z0-9_-]+$

--recommender-name (string) [required]

The name of the recommender.

Constraints:

• min: 1
• max: 64
• pattern: ^[a-zA-Z0-9_-]+$

--training-metrics-count (integer)

The number of training metrics to retrieve for the recommender.

Constraints:

• min: 0
• max: 5

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

RecommenderName -> (string)

The name of the recommender.

Constraints:

• min: 1
• max: 64
• pattern: ^[a-zA-Z0-9_-]+$

RecommenderRecipeName -> (string)

The name of the recipe used by the recommender to generate recommendations.

Possible values:

• recommended-for-you
• similar-items
• frequently-paired-items
• popular-items
• trending-now

RecommenderConfig -> (structure)

The configuration settings for the recommender, including parameters and settings that define its behavior.

EventsConfig -> (structure) [required]

Configuration settings for how the recommender processes and uses events.

EventParametersList -> (list) [required]

A list of event parameters configurations that specify how different event types should be handled.

Constraints:

• min: 1
• max: 5

(structure)

Configuration parameters for events in the personalization system.

EventType -> (string) [required]

The type of event being tracked (e.g., ‘click’, ‘purchase’, ‘view’).

Constraints:

• min: 0
• max: 256

EventValueThreshold -> (double)

The minimum value threshold that an event must meet to be considered valid.

TrainingFrequency -> (integer)

How often the recommender should retrain its model with new data.

Constraints:

• min: 7
• max: 7

Description -> (string)

A detailed description of the recommender providing information about its purpose and functionality.

Constraints:

• min: 1
• max: 1000

Status -> (string)

The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

Possible values:

• PENDING
• IN_PROGRESS
• ACTIVE
• FAILED
• STOPPING
• INACTIVE
• STARTING
• DELETING

LastUpdatedAt -> (timestamp)

The timestamp of when the recommender was edited.

CreatedAt -> (timestamp)

The timestamp of when the recommender was created.

FailureReason -> (string)

If the recommender fails, provides the reason for the failure.

LatestRecommenderUpdate -> (structure)

Information about the most recent update performed on the recommender, including status and timestamp.

RecommenderConfig -> (structure)

The updated configuration settings applied to the recommender during this update.

EventsConfig -> (structure) [required]

Configuration settings for how the recommender processes and uses events.

EventParametersList -> (list) [required]

A list of event parameters configurations that specify how different event types should be handled.

Constraints:

• min: 1
• max: 5

(structure)

Configuration parameters for events in the personalization system.

EventType -> (string) [required]

The type of event being tracked (e.g., ‘click’, ‘purchase’, ‘view’).

Constraints:

• min: 0
• max: 256

EventValueThreshold -> (double)

The minimum value threshold that an event must meet to be considered valid.

TrainingFrequency -> (integer)

How often the recommender should retrain its model with new data.

Constraints:

• min: 7
• max: 7

Status -> (string)

The current status of the recommender update operation.

Possible values:

• PENDING
• IN_PROGRESS
• ACTIVE
• FAILED
• STOPPING
• INACTIVE
• STARTING
• DELETING

CreatedAt -> (timestamp)

The timestamp when this recommender update was initiated.

LastUpdatedAt -> (timestamp)

The timestamp of when the recommender was edited.

FailureReason -> (string)

If the update operation failed, provides the reason for the failure.

TrainingMetrics -> (list)

A set of metrics that provide information about the recommender’s training performance and accuracy.

(structure)

Contains metrics and performance indicators from the training of a recommender model.

Time -> (timestamp)

The timestamp when these training metrics were recorded.

Metrics -> (map)

A collection of performance metrics and statistics from the training process.

key -> (string)

Possible values:

• hit
• coverage
• recall
• popularity
• freshness
• similarity

value -> (double)

Tags -> (map)

The tags used to organize, track, or control access for this resource.

Constraints:

• min: 1
• max: 50

key -> (string)

Constraints:

• min: 1
• max: 128
• pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

value -> (string)

Constraints:

• max: 256