Struct aws_sdk_braket::input::CreateJobInput

#[non_exhaustive]
pub struct CreateJobInput {
    pub client_token: Option<String>,
    pub algorithm_specification: Option<AlgorithmSpecification>,
    pub input_data_config: Option<Vec<InputFileConfig>>,
    pub output_data_config: Option<JobOutputDataConfig>,
    pub checkpoint_config: Option<JobCheckpointConfig>,
    pub job_name: Option<String>,
    pub role_arn: Option<String>,
    pub stopping_condition: Option<JobStoppingCondition>,
    pub instance_config: Option<InstanceConfig>,
    pub hyper_parameters: Option<HashMap<String, String>>,
    pub device_config: Option<DeviceConfig>,
    pub tags: Option<HashMap<String, String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_token: Option<String>

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

algorithm_specification: Option<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.

input_data_config: Option<Vec<InputFileConfig>>

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

output_data_config: Option<JobOutputDataConfig>

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

checkpoint_config: Option<JobCheckpointConfig>

Information about the output locations for job checkpoint data.

job_name: Option<String>

The name of the Amazon Braket job.

role_arn: Option<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.

stopping_condition: Option<JobStoppingCondition>

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

instance_config: Option<InstanceConfig>

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

hyper_parameters: Option<HashMap<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.

device_config: Option<DeviceConfig>

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

tags: Option<HashMap<String, String>>

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

Implementations

impl CreateJobInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<CreateJob, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateJobInput

impl CreateJobInput

pub fn client_token(&self) -> Option<&str>

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

pub fn algorithm_specification(&self) -> Option<&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.

pub fn input_data_config(&self) -> Option<&[InputFileConfig]>

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

pub fn output_data_config(&self) -> Option<&JobOutputDataConfig>

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

pub fn checkpoint_config(&self) -> Option<&JobCheckpointConfig>

Information about the output locations for job checkpoint data.

pub fn job_name(&self) -> Option<&str>

The name of the Amazon Braket job.

pub fn role_arn(&self) -> Option<&str>

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.

pub fn stopping_condition(&self) -> Option<&JobStoppingCondition>

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

pub fn instance_config(&self) -> Option<&InstanceConfig>

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

pub fn hyper_parameters(&self) -> Option<&HashMap<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.

pub fn device_config(&self) -> Option<&DeviceConfig>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

Trait Implementations

impl Clone for CreateJobInput

fn clone(&self) -> CreateJobInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateJobInput> for CreateJobInput

fn eq(&self, other: &CreateJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateJobInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateJobInput