Skip to content
AWS for Query.Farm

aws.personalize.describe_algorithm

Example SQL Queries

SELECT * FROM
aws.personalize.describe_algorithm
WHERE
"algorithm_arn" = 'VALUE';

Description

Describes the given algorithm.

Table Definition

Column NameColumn Data Type
algorithm_arn Required Input Column

The Amazon Resource Name (ARN) of the algorithm to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
algorithm

A listing of the properties of the algorithm.

STRUCT(
    "name" VARCHAR,
    "algorithm_arn" VARCHAR,
    "algorithm_image" STRUCT(
        "name" VARCHAR,
        "docker_uri" VARCHAR
    ),
    "default_hyper_parameters" MAP(VARCHAR, VARCHAR),
    "default_hyper_parameter_ranges" STRUCT(
        "integer_hyper_parameter_ranges" STRUCT(
            "name" VARCHAR,
            "min_value" BIGINT,
            "max_value" BIGINT,
            "is_tunable" BOOLEAN
        )[],
        "continuous_hyper_parameter_ranges" STRUCT(
            "name" VARCHAR,
            "min_value" DOUBLE,
            "max_value" DOUBLE,
            "is_tunable" BOOLEAN
        )[],
        "categorical_hyper_parameter_ranges" STRUCT(
            "name" VARCHAR,
            "values" VARCHAR[],
            "is_tunable" BOOLEAN
        )[]
    ),
    "default_resource_config" MAP(VARCHAR, VARCHAR),
    "training_input_mode" VARCHAR,
    "role_arn" VARCHAR,
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S
)
Show child fields
algorithm.algorithm_arn

The Amazon Resource Name (ARN) of the algorithm.

algorithm.algorithm_image

The URI of the Docker container for the algorithm image.

Show child fields
algorithm.algorithm_image.docker_uri

The URI of the Docker container for the algorithm image.

algorithm.algorithm_image.name

The name of the algorithm image.

algorithm.creation_date_time

The date and time (in Unix time) that the algorithm was created.

algorithm.default_hyper_parameter_ranges

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

Show child fields
algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[]
Show child fields
algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[].is_tunable

Whether the hyperparameter is tunable.

algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[].name

The name of the hyperparameter.

algorithm.default_hyper_parameter_ranges.categorical_hyper_parameter_ranges[].values[]
algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[]
Show child fields
algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[].is_tunable

Whether the hyperparameter is tunable.

algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[].max_value

The maximum allowable value for the hyperparameter.

algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[].min_value

The minimum allowable value for the hyperparameter.

algorithm.default_hyper_parameter_ranges.continuous_hyper_parameter_ranges[].name

The name of the hyperparameter.

algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[]
Show child fields
algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[].is_tunable

Indicates whether the hyperparameter is tunable.

algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[].max_value

The maximum allowable value for the hyperparameter.

algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[].min_value

The minimum allowable value for the hyperparameter.

algorithm.default_hyper_parameter_ranges.integer_hyper_parameter_ranges[].name

The name of the hyperparameter.

algorithm.default_hyper_parameters

Specifies the default hyperparameters.

algorithm.default_resource_config

Specifies the default maximum number of training jobs and parallel training jobs.

algorithm.last_updated_date_time

The date and time (in Unix time) that the algorithm was last updated.

algorithm.name

The name of the algorithm.

algorithm.role_arn

The Amazon Resource Name (ARN) of the role.

algorithm.training_input_mode

The training input mode.