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(
    action='string',
    associations=[
        {
            'arn': 'string',
            'type': 'RESERVATION_TIME_WINDOW_ARN'
        },
    ],
    clientToken='string',
    deviceArn='string',
    deviceParameters='string',
    jobToken='string',
    outputS3Bucket='string',
    outputS3KeyPrefix='string',
    shots=123,
    tags={
        'string': 'string'
    }
)
Parameters:

  • action (string) –

    [REQUIRED]

    The action associated with the 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.

  • 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 task on.

  • deviceParameters (string) – The parameters for the device to run the task on.

  • jobToken (string) – The token for an Amazon Braket job that associates it with the quantum task.

  • outputS3Bucket (string) –

    [REQUIRED]

    The S3 bucket to store task result files in.

  • outputS3KeyPrefix (string) –

    [REQUIRED]

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

  • shots (integer) –

    [REQUIRED]

    The number of shots to use for the task.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'quantumTaskArn': 'string'
}

Response Structure

  • (dict) –

    • quantumTaskArn (string) –

      The ARN of the task created by the request.

Exceptions