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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#associations ⇒ Array<Types::Association>

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

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#checkpoint_config ⇒ Types::JobCheckpointConfig

Information about the output locations for job checkpoint data.

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#client_token ⇒ String

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

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

Returns:

  • (String) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#device_config ⇒ Types::DeviceConfig

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

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#hyper_parameters ⇒ Hash<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.

Returns:

  • (Hash<String,String>) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

class CreateJobRequest < Struct.new(
  :algorithm_specification,
  :associations,
  :checkpoint_config,
  :client_token,
  :device_config,
  :hyper_parameters,
  :input_data_config,
  :instance_config,
  :job_name,
  :output_data_config,
  :role_arn,
  :stopping_condition,
  :tags)
  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:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

class CreateJobRequest < Struct.new(
  :algorithm_specification,
  :associations,
  :checkpoint_config,
  :client_token,
  :device_config,
  :hyper_parameters,
  :input_data_config,
  :instance_config,
  :job_name,
  :output_data_config,
  :role_arn,
  :stopping_condition,
  :tags)
  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:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#job_name ⇒ String

The name of the Amazon Braket job.

Returns:

  • (String) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#output_data_config ⇒ Types::JobOutputDataConfig

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

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

class CreateJobRequest < Struct.new(
  :algorithm_specification,
  :associations,
  :checkpoint_config,
  :client_token,
  :device_config,
  :hyper_parameters,
  :input_data_config,
  :instance_config,
  :job_name,
  :output_data_config,
  :role_arn,
  :stopping_condition,
  :tags)
  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 resources to the users' s3 buckets.

Returns:

  • (String) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#stopping_condition ⇒ Types::JobStoppingCondition

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

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 231

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