Skip to content
AWS for Query.Farm

aws.sagemaker.list_training_jobs

Example SQL Queries

SELECT * FROM
aws.sagemaker.list_training_jobs;

Description

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

Table Definition

Column NameColumn Data Type
creation_time_after Input Column

A filter that returns only training jobs created after the specified time (timestamp).

TIMESTAMP_S
creation_time_before Input Column

A filter that returns only training jobs created before the specified time (timestamp).

TIMESTAMP_S
last_modified_time_after Input Column

A filter that returns only training jobs modified after the specified time (timestamp).

TIMESTAMP_S
last_modified_time_before Input Column

A filter that returns only training jobs modified before the specified time (timestamp).

TIMESTAMP_S
name_contains Input Column

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

VARCHAR
sort_by Input Column

The field to sort results by. The default is CreationTime.

VARCHAR
sort_order Input Column

The sort order for results. The default is Ascending.

VARCHAR
status_equals Input Column

A filter that retrieves only training jobs with a specific status.

VARCHAR
warm_pool_status_equals Input Column

A filter that retrieves only training jobs with a specific warm pool status.

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.

creation_time

A timestamp that shows when the training job was created.

TIMESTAMP_S
last_modified_time

Timestamp when the training job was last modified. 

TIMESTAMP_S
training_end_time

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped). 

TIMESTAMP_S
training_job_arn

The Amazon Resource Name (ARN) of the training job.

VARCHAR
training_job_name

The name of the training job that you want a summary for.

VARCHAR
training_job_status

The status of the training job.

VARCHAR
warm_pool_status

The status of the warm pool associated with the training job.

STRUCT(
    "status" VARCHAR,
    "resource_retained_billable_time_in_seconds" BIGINT,
    "reused_by_job" VARCHAR
)
Show child fields
warm_pool_status.resource_retained_billable_time_in_seconds

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

warm_pool_status.reused_by_job

The name of the matching training job that reused the warm pool.

warm_pool_status.status

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.

  • Available: The warm pool is available to reuse for a matching training job.

  • Reused: The warm pool moved to a matching training job for reuse.

  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.