Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetJobCommandOutput

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

algorithmSpecification

algorithmSpecification: AlgorithmSpecification | undefined

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.

Optional billableDuration

billableDuration: undefined | number

The billable time the Amazon Braket job used to complete.

Optional checkpointConfig

checkpointConfig: JobCheckpointConfig

Information about the output locations for job checkpoint data.

createdAt

createdAt: Date | undefined

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

Optional deviceConfig

deviceConfig: DeviceConfig

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

Optional endedAt

endedAt: Date

The date and time that the Amazon Braket job ended.

Optional events

events: JobEventDetails[]

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

Optional failureReason

failureReason: undefined | string

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

Optional hyperParameters

hyperParameters: Record<string, string>

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.

Optional inputDataConfig

inputDataConfig: InputFileConfig[]

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

instanceConfig

instanceConfig: InstanceConfig | undefined

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

jobArn

jobArn: string | undefined

The ARN of the Amazon Braket job.

jobName

jobName: string | undefined

The name of the Amazon Braket job.

outputDataConfig

outputDataConfig: JobOutputDataConfig | undefined

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

roleArn

roleArn: string | undefined

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.

Optional startedAt

startedAt: Date

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

status

status: JobPrimaryStatus | string | undefined

The status of the Amazon Braket job.

Optional stoppingCondition

stoppingCondition: JobStoppingCondition

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

Optional tags

tags: Record<string, string>

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