Class: Aws::Braket::Types::CreateJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::Braket::Types::CreateJobRequest

Defined in:

gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #algorithm_specification ⇒ Types::AlgorithmSpecification

  Definition of the Amazon Braket job to be created.

• #associations ⇒ Array<Types::Association>

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

• #checkpoint_config ⇒ Types::JobCheckpointConfig

  Information about the output locations for hybrid job checkpoint data.

• #client_token ⇒ String

  The client token associated with this request that guarantees that the request is idempotent.

• #device_config ⇒ Types::DeviceConfig

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

• #hyper_parameters ⇒ Hash<String,String>

  Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job.

• #input_data_config ⇒ Array<Types::InputFileConfig>

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

• #instance_config ⇒ Types::InstanceConfig

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

• #job_name ⇒ String

  The name of the Amazon Braket hybrid job.

• #output_data_config ⇒ Types::JobOutputDataConfig

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

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.

• #stopping_condition ⇒ Types::JobStoppingCondition

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

• #tags ⇒ Hash<String,String>

  Tags to be added to the hybrid job you're creating.

Instance Attribute Details

#algorithm_specification ⇒ Types::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.

Returns:

• (Types::AlgorithmSpecification)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#associations ⇒ Array<Types::Association>

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

Returns:

• (Array<Types::Association>)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#checkpoint_config ⇒ Types::JobCheckpointConfig

Information about the output locations for hybrid job checkpoint data.

Returns:

• (Types::JobCheckpointConfig)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

The client token associated with this request that guarantees that the request is idempotent.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#device_config ⇒ Types::DeviceConfig

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

Returns:

• (Types::DeviceConfig)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameters ⇒ Hash<String,String>

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Array<Types::InputFileConfig>

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

Returns:

• (Array<Types::InputFileConfig>)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#instance_config ⇒ Types::InstanceConfig

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

Returns:

• (Types::InstanceConfig)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the Amazon Braket hybrid job.

Returns:

• (String)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::JobOutputDataConfig

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

Returns:

• (Types::JobOutputDataConfig)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ 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 results and hybrid job details to the users' s3 buckets.

Returns:

• (String)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_condition ⇒ Types::JobStoppingCondition

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

Returns:

• (Types::JobStoppingCondition)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags to be added to the hybrid job you're creating.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 266

class CreateJobRequest < Struct.new(
  :client_token,
  :algorithm_specification,
  :input_data_config,
  :output_data_config,
  :checkpoint_config,
  :job_name,
  :role_arn,
  :stopping_condition,
  :instance_config,
  :hyper_parameters,
  :device_config,
  :tags,
  :associations)
  SENSITIVE = []
  include Aws::Structure
end