Braket / Client / create_quantum_task
create_quantum_task¶
- Braket.Client.create_quantum_task(**kwargs)¶
Creates a quantum task.
See also: AWS API Documentation
Request Syntax
response = client.create_quantum_task( clientToken='string', deviceArn='string', deviceParameters='string', shots=123, outputS3Bucket='string', outputS3KeyPrefix='string', action='string', tags={ 'string': 'string' }, jobToken='string', associations=[ { 'arn': 'string', 'type': 'RESERVATION_TIME_WINDOW_ARN' }, ] )
- Parameters:
clientToken (string) –
[REQUIRED]
The client token associated with the request.
This field is autopopulated if not provided.
deviceArn (string) –
[REQUIRED]
The ARN of the device to run the quantum task on.
deviceParameters (string) – The parameters for the device to run the quantum task on.
shots (integer) –
[REQUIRED]
The number of shots to use for the quantum task.
outputS3Bucket (string) –
[REQUIRED]
The S3 bucket to store quantum task result files in.
outputS3KeyPrefix (string) –
[REQUIRED]
The key prefix for the location in the S3 bucket to store quantum task results in.
action (string) –
[REQUIRED]
The action associated with the quantum task.
tags (dict) –
Tags to be added to the quantum task you’re creating.
(string) –
(string) –
jobToken (string) – The token for an Amazon Braket hybrid job that associates it with the quantum task.
associations (list) –
The list of Amazon Braket resources associated with the quantum task.
(dict) –
The Amazon Braket resource and the association type.
arn (string) – [REQUIRED]
The Amazon Braket resource arn.
type (string) – [REQUIRED]
The association type for the specified Amazon Braket resource arn.
- Return type:
dict
- Returns:
Response Syntax
{ 'quantumTaskArn': 'string' }
Response Structure
(dict) –
quantumTaskArn (string) –
The ARN of the quantum task created by the request.
Exceptions