get-job¶
Description¶
Retrieves the specified Amazon Braket job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-job
--job-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--job-arn (string)
The ARN of the job to retrieve.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
algorithmSpecification -> (structure)
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.
containerImage -> (structure)
The container image used to create an Amazon Braket job.
uri -> (string)
The URI locating the container image.
scriptModeConfig -> (structure)
Configures the paths to the Python scripts used for entry and training.
compressionType -> (string)
The type of compression used by the Python scripts for an Amazon Braket job.
entryPoint -> (string)
The path to the Python script that serves as the entry point for an Amazon Braket job.
s3Uri -> (string)
The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.
billableDuration -> (integer)
The billable time the Amazon Braket job used to complete.
checkpointConfig -> (structure)
Information about the output locations for job checkpoint data.
localPath -> (string)
(Optional) The local directory where checkpoints are written. The default directory is
/opt/braket/checkpoints/.s3Uri -> (string)
Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,
s3://bucket-name/key-name-prefix.
createdAt -> (timestamp)
The date and time that the Amazon Braket job was created.
deviceConfig -> (structure)
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
device -> (string)
The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
endedAt -> (timestamp)
The date and time that the Amazon Braket job ended.
events -> (list)
Details about the type and time events occurred related to the Amazon Braket job.
(structure)
Details about the type and time events occurred related to the Amazon Braket job.
eventType -> (string)
The type of event that occurred related to the Amazon Braket job.
message -> (string)
A message describing the event that occurred related to the Amazon Braket job.
timeOfEvent -> (timestamp)
TThe type of event that occurred related to the Amazon Braket job.
failureReason -> (string)
A description of the reason why an Amazon Braket job failed, if it failed.
hyperParameters -> (map)
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.
key -> (string)
value -> (string)
inputDataConfig -> (list)
A list of parameters that specify the name and type of input data and where it is located.
(structure)
A list of parameters that specify the input channels, type of input data, and where it is located.
channelName -> (string)
A named input source that an Amazon Braket job can consume.
contentType -> (string)
The MIME type of the data.
dataSource -> (structure)
The location of the channel data.
s3DataSource -> (structure)
Information about the data stored in Amazon S3 used by the Amazon Braket job.
s3Uri -> (string)
Depending on the value specified for the
S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.
instanceConfig -> (structure)
The resource instances to use while running the hybrid job on Amazon Braket.
instanceCount -> (integer)
Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.
instanceType -> (string)
Configures the type resource instances to use while running an Amazon Braket hybrid job.
volumeSizeInGb -> (integer)
The size of the storage volume, in GB, that user wants to provision.
jobArn -> (string)
The ARN of the Amazon Braket job.
jobName -> (string)
The name of the Amazon Braket job.
outputDataConfig -> (structure)
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
kmsKeyId -> (string)
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.
s3Path -> (string)
Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example,
s3://bucket-name/key-name-prefix.
roleArn -> (string)
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.
startedAt -> (timestamp)
The date and time that the Amazon Braket job was started.
status -> (string)
The status of the Amazon Braket job.
stoppingCondition -> (structure)
The user-defined criteria that specifies when to stop a job running.
maxRuntimeInSeconds -> (integer)
The maximum length of time, in seconds, that an Amazon Braket job can run.
tags -> (map)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
key -> (string)
value -> (string)