Braket / Client / get_quantum_task

get_quantum_task#

Braket.Client.get_quantum_task(**kwargs)#

Retrieves the specified quantum task.

Request Syntax

response = client.get_quantum_task(
    quantumTaskArn='string'
)

Parameters:

quantumTaskArn (string) –

[REQUIRED]

the ARN of the task to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'deviceArn': 'string',
    'deviceParameters': 'string',
    'endedAt': datetime(2015, 1, 1),
    'failureReason': 'string',
    'jobArn': 'string',
    'outputS3Bucket': 'string',
    'outputS3Directory': 'string',
    'quantumTaskArn': 'string',
    'shots': 123,
    'status': 'CREATED'|'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- createdAt (datetime) –
  
  The time at which the task was created.
- deviceArn (string) –
  
  The ARN of the device the task was run on.
- deviceParameters (string) –
  
  The parameters for the device on which the task ran.
- endedAt (datetime) –
  
  The time at which the task ended.
- failureReason (string) –
  
  The reason that a task failed.
- jobArn (string) –
  
  The ARN of the Amazon Braket job associated with the quantum task.
- outputS3Bucket (string) –
  
  The S3 bucket where task results are stored.
- outputS3Directory (string) –
  
  The folder in the S3 bucket where task results are stored.
- quantumTaskArn (string) –
  
  The ARN of the task.
- shots (integer) –
  
  The number of shots used in the task.
- status (string) –
  
  The status of the task.
- tags (dict) –
  
  The tags that belong to this task.
  - (string) –
    - (string) –

Exceptions

Braket.Client.exceptions.ResourceNotFoundException
Braket.Client.exceptions.AccessDeniedException
Braket.Client.exceptions.ThrottlingException
Braket.Client.exceptions.InternalServiceException
Braket.Client.exceptions.ValidationException