Skip to content
AWS for Query.Farm

aws.sagemaker.get_search_suggestions

Example SQL Queries

SELECT * FROM
aws.sagemaker.get_search_suggestions
WHERE
"resource" = 'VALUE';

Description

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

Table Definition

Column NameColumn Data Type
resource Required Input Column

The name of the SageMaker resource to search for.

VARCHAR
suggestion_query Input Column

Limits the property names that are included in the response.

STRUCT(
    "property_name_query" STRUCT(
        "property_name_hint" VARCHAR
    )
)
Show child fields
suggestion_query.property_name_query

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

Show child fields
suggestion_query.property_name_query.property_name_hint

Text that begins a property's name.

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

property_name_suggestions

A list of property names for a Resource that match a SuggestionQuery.

STRUCT(
    "property_name" VARCHAR
)[]
Show child fields
property_name_suggestions[]
Show child fields
property_name_suggestions[].property_name

A suggested property name based on what you entered in the search textbox in the SageMaker console.