AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateJob operation. Creates an Amazon Braket job.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Braket.AmazonBraketRequest
      Amazon.Braket.Model.CreateJobRequest

Namespace: Amazon.Braket.Model
Assembly: AWSSDK.Braket.dll
Version: 3.x.y.z

Syntax

C#
public class CreateJobRequest : AmazonBraketRequest
         IAmazonWebServiceRequest

The CreateJobRequest type exposes the following members

Constructors

NameDescription
Public Method CreateJobRequest()

Properties

NameTypeDescription
Public Property AlgorithmSpecification Amazon.Braket.Model.AlgorithmSpecification

Gets and sets the property 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.

Public Property Associations System.Collections.Generic.List<Amazon.Braket.Model.Association>

Gets and sets the property Associations.

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

Public Property CheckpointConfig Amazon.Braket.Model.JobCheckpointConfig

Gets and sets the property CheckpointConfig.

Information about the output locations for job checkpoint data.

Public Property ClientToken System.String

Gets and sets the property ClientToken.

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

Public Property DeviceConfig Amazon.Braket.Model.DeviceConfig

Gets and sets the property DeviceConfig.

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

Public Property HyperParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property HyperParameters.

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.

Public Property InputDataConfig System.Collections.Generic.List<Amazon.Braket.Model.InputFileConfig>

Gets and sets the property InputDataConfig.

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

Public Property InstanceConfig Amazon.Braket.Model.InstanceConfig

Gets and sets the property InstanceConfig.

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

Public Property JobName System.String

Gets and sets the property JobName.

The name of the Amazon Braket job.

Public Property OutputDataConfig Amazon.Braket.Model.JobOutputDataConfig

Gets and sets the property OutputDataConfig.

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

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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.

Public Property StoppingCondition Amazon.Braket.Model.JobStoppingCondition

Gets and sets the property StoppingCondition.

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

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5