algorithms

Creates, updates, deletes, gets or lists an algorithms resource.

Overview

Name	algorithms
Type	Resource
Id	aws.personalize.algorithms

Fields

The following fields are returned by SELECT queries:

describe_algorithm

Name	Datatype	Description
name	string	The name of the algorithm. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
algorithm_arn	string	The Amazon Resource Name (ARN) of the algorithm. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
algorithm_image	object	The URI of the Docker container for the algorithm image.
creation_date_time	string (date-time)	The date and time (in Unix time) that the algorithm was created.
default_hyper_parameter_ranges	object	Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
default_hyper_parameters	object	Specifies the default hyperparameters.
default_resource_config	object	Specifies the default maximum number of training jobs and parallel training jobs.
last_updated_date_time	string (date-time)	The date and time (in Unix time) that the algorithm was last updated.
role_arn	string	The Amazon Resource Name (ARN) of the role. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
training_input_mode	string	The training input mode.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_algorithm	select	region		Describes the given algorithm.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_algorithm

Describes the given algorithm.

SELECT
name,
algorithm_arn,
algorithm_image,
creation_date_time,
default_hyper_parameter_ranges,
default_hyper_parameters,
default_resource_config,
last_updated_date_time,
role_arn,
training_input_mode
FROM aws.personalize.algorithms
WHERE region = '{{ region }}' -- required
;