Skip to content
AWS for Query.Farm

aws.braket.get_job

Example SQL Queries

SELECT * FROM
aws.braket.get_job
WHERE
"job_arn" = 'VALUE';

Description

Retrieves the specified Amazon Braket job.

Table Definition

Column NameColumn Data Type
job_arn Required Input Column

The ARN of the Amazon Braket job.

VARCHAR
additional_attribute_names Input Column

A list of attributes to return information for.

VARCHAR[]
Show child fields
additional_attribute_names[]
_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_specification

Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

STRUCT(
    "container_image" STRUCT(
        "uri" VARCHAR
    ),
    "script_mode_config" STRUCT(
        "compression_type" VARCHAR,
        "entry_point" VARCHAR,
        "s3_uri" VARCHAR
    )
)
Show child fields
algorithm_specification.container_image

The container image used to create an Amazon Braket job.

Show child fields
algorithm_specification.container_image.uri

The URI locating the container image.

algorithm_specification.script_mode_config

Configures the paths to the Python scripts used for entry and training.

Show child fields
algorithm_specification.script_mode_config.compression_type

The type of compression used by the Python scripts for an Amazon Braket job.

algorithm_specification.script_mode_config.entry_point

The path to the Python script that serves as the entry point for an Amazon Braket job.

algorithm_specification.script_mode_config.s3_uri

The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.

associations

The list of Amazon Braket resources associated with the hybrid job.

STRUCT(
    "arn" VARCHAR,
    "type" VARCHAR
)[]
Show child fields
associations[]
Show child fields
associations[].arn

The Amazon Braket resource arn.

associations[].type

The association type for the specified Amazon Braket resource arn.

billable_duration

The billable time the Amazon Braket job used to complete.

BIGINT
checkpoint_config

Information about the output locations for job checkpoint data.

STRUCT(
    "local_path" VARCHAR,
    "s3_uri" VARCHAR
)
Show child fields
checkpoint_config.local_path

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

checkpoint_config.s3_uri

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

created_at

The date and time that the Amazon Braket job was created.

TIMESTAMP_S
device_config

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

STRUCT(
    "device" VARCHAR
)
Show child fields
device_config.device

The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.

ended_at

The date and time that the Amazon Braket job ended.

TIMESTAMP_S
events

Details about the type and time events occurred related to the Amazon Braket job.

STRUCT(
    "event_type" VARCHAR,
    "message" VARCHAR,
    "time_of_event" TIMESTAMP_S
)[]
Show child fields
events[]
Show child fields
events[].event_type

The type of event that occurred related to the Amazon Braket job.

events[].message

A message describing the event that occurred related to the Amazon Braket job.

events[].time_of_event

The type of event that occurred related to the Amazon Braket job.

failure_reason

A description of the reason why an Amazon Braket job failed, if it failed.

VARCHAR
hyper_parameters

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

MAP(VARCHAR, VARCHAR)
input_data_config

A list of parameters that specify the name and type of input data and where it is located.

STRUCT(
    "channel_name" VARCHAR,
    "content_type" VARCHAR,
    "data_source" STRUCT(
        "s3_data_source" STRUCT(
            "s3_uri" VARCHAR
        )
    )
)[]
Show child fields
input_data_config[]
Show child fields
input_data_config[].channel_name

A named input source that an Amazon Braket job can consume.

input_data_config[].content_type

The MIME type of the data.

input_data_config[].data_source

The location of the channel data.

Show child fields
input_data_config[].data_source.s3_data_source

Information about the data stored in Amazon S3 used by the Amazon Braket job.

Show child fields
input_data_config[].data_source.s3_data_source.s3_uri

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.

instance_config

The resource instances to use while running the hybrid job on Amazon Braket.

STRUCT(
    "instance_count" BIGINT,
    "instance_type" VARCHAR,
    "volume_size_in_gb" BIGINT
)
Show child fields
instance_config.instance_count

Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.

instance_config.instance_type

Configures the type resource instances to use while running an Amazon Braket hybrid job.

instance_config.volume_size_in_gb

The size of the storage volume, in GB, that user wants to provision.

job_name

The name of the Amazon Braket job.

VARCHAR
output_data_config

The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

STRUCT(
    "kms_key_id" VARCHAR,
    "s3_path" VARCHAR
)
Show child fields
output_data_config.kms_key_id

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.

output_data_config.s3_path

Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.

queue_info

Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

STRUCT(
    "message" VARCHAR,
    "position" VARCHAR,
    "queue" VARCHAR
)
Show child fields
queue_info.message

Optional. Provides more information about the queue position. For example, if the job is complete and no longer in the queue, the message field contains that information.

queue_info.position

Current position of the job in the jobs queue.

queue_info.queue

The name of the queue.

role_arn

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.

VARCHAR
started_at

The date and time that the Amazon Braket job was started.

TIMESTAMP_S
status

The status of the Amazon Braket job.

VARCHAR
stopping_condition

The user-defined criteria that specifies when to stop a job running.

STRUCT(
    "max_runtime_in_seconds" BIGINT
)
Show child fields
stopping_condition.max_runtime_in_seconds

The maximum length of time, in seconds, that an Amazon Braket job can run.

tags

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

MAP(VARCHAR, VARCHAR)