[ aws . braket ]

create-quantum-task

Description

Creates a quantum task.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-quantum-task
--action <value>
[--client-token <value>]
--device-arn <value>
[--device-parameters <value>]
[--job-token <value>]
--output-s3-bucket <value>
--output-s3-key-prefix <value>
--shots <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--action (string)

The action associated with the task.

--client-token (string)

The client token associated with the request.

--device-arn (string)

The ARN of the device to run the task on.

--device-parameters (string)

The parameters for the device to run the task on.

--job-token (string)

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

--output-s3-bucket (string)

The S3 bucket to store task result files in.

--output-s3-key-prefix (string)

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

--shots (long)

The number of shots to use for the task.

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

quantumTaskArn -> (string)

The ARN of the task created by the request.