Jump to Content

Interface CreateJobCommandInputProtected

The input for CreateJobCommand.



algorithmSpecification: undefined | AlgorithmSpecification

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

checkpointConfig?: JobCheckpointConfig

Information about the output locations for job checkpoint data.

clientToken?: string

A unique token that guarantees that the call to this API is idempotent.

deviceConfig: undefined | DeviceConfig

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

hyperParameters?: Record<string, string>

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training 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.

inputDataConfig?: InputFileConfig[]

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

instanceConfig: undefined | InstanceConfig

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

jobName: undefined | string

The name of the Amazon Braket job.

outputDataConfig: undefined | JobOutputDataConfig

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

roleArn: undefined | 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 users' s3 buckets.

stoppingCondition?: JobStoppingCondition

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

tags?: Record<string, string>

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