Class: Aws::Braket::Types::CreateQuantumTaskRequest

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

Overview

Note:

When making an API call, you may pass CreateQuantumTaskRequest data as a hash:

{
  action: "JsonValue", # required
  client_token: "String64", # required
  device_arn: "DeviceArn", # required
  device_parameters: "CreateQuantumTaskRequestDeviceParametersString",
  job_token: "JobToken",
  output_s3_bucket: "CreateQuantumTaskRequestOutputS3BucketString", # required
  output_s3_key_prefix: "CreateQuantumTaskRequestOutputS3KeyPrefixString", # required
  shots: 1, # required
  tags: {
    "String" => "String",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action associated with the task.

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

The client token associated with the request.

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

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#device_arnString

The ARN of the device to run the task on.

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#device_parametersString

The parameters for the device to run the task on.

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_tokenString

The token for an Amazon Braket job that associates it with the quantum task.

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_bucketString

The S3 bucket to store task result files in.

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_key_prefixString

The key prefix for the location in the S3 bucket to store task results in.

Returns:

  • (String)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#shotsInteger

The number of shots to use for the task.

Returns:

  • (Integer)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Tags to be added to the quantum task you're creating.

Returns:

  • (Hash<String,String>)


387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'gems/aws-sdk-braket/lib/aws-sdk-braket/types.rb', line 387

class CreateQuantumTaskRequest < Struct.new(
  :action,
  :client_token,
  :device_arn,
  :device_parameters,
  :job_token,
  :output_s3_bucket,
  :output_s3_key_prefix,
  :shots,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end