Amazon Braket

(1)

Amazon Braket

API Reference

API Version 2019-09-01

(2)

Amazon Braket: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

• Amazon Braket Developer Guide

This document was last published on March 7, 2022.

(7)

Actions

The following actions are supported:

• CancelJob (p. 3)

• CancelQuantumTask (p. 5)

• CreateJob (p. 8)

• CreateQuantumTask (p. 13)

• GetDevice (p. 17)

• GetJob (p. 21)

• GetQuantumTask (p. 26)

• ListTagsForResource (p. 29)

• SearchDevices (p. 31)

• SearchJobs (p. 34)

• SearchQuantumTasks (p. 37)

• TagResource (p. 40)

• UntagResource (p. 42)

(8)

CancelJob

Cancels an Amazon Braket job.

Request Syntax

PUT /job/jobArn/cancel HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobArn (p. 3)

The ARN of the Amazon Braket job to cancel.

Pattern: ^arn:aws[a-z\-]*:braket:[a-z0-9\-]*:[0-9]{12}:job/.*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"cancellationStatus": "string", "jobArn": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

cancellationStatus (p. 3)

The status of the job cancellation request.

Type: String

Valid Values: CANCELLING | CANCELLED jobArn (p. 3)

The ARN of the Amazon Braket job.

Type: String

(9)

Errors

For information about the errors that are common to all actions, see Common Errors (p. 68).

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 403 ConﬂictException

An error occurred due to a conﬂict.

HTTP Status Code: 409 InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling rate limit is met.

HTTP Status Code: 429 ValidationException

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

CancelQuantumTask

Cancels the speciﬁed task.

Request Syntax

PUT /quantum-task/quantumTaskArn/cancel HTTP/1.1 Content-type: application/json

{

"clientToken": "string"

}

URI Request Parameters

quantumTaskArn (p. 5)

The ARN of the task to cancel.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken (p. 5)

The client token associated with the request.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

"cancellationStatus": "string", "quantumTaskArn": "string"

}

Response Elements

(11)

Errors

cancellationStatus (p. 5)

The status of the cancellation request.

Type: String

Valid Values: CANCELLING | CANCELLED quantumTaskArn (p. 5)

The ARN of the task.

Type: String

Errors

CreateJob

Creates an Amazon Braket job.

Request Syntax

POST /job HTTP/1.1

"algorithmSpecification": { "containerImage": { "uri": "string"

},

"scriptModeConfig": {

"compressionType": "string", "entryPoint": "string", "s3Uri": "string"

} },

"checkpointConfig": { "localPath": "string", "s3Uri": "string"

},

"clientToken": "string", "deviceConfig": { "device": "string"

},

"hyperParameters": { "string" : "string"

},

"inputDataConfig": [ {

"channelName": "string", "contentType": "string", "dataSource": {

"s3DataSource": { "s3Uri": "string"

} } } ],

"instanceConfig": {

"instanceType": "string", "volumeSizeInGb": number },

"jobName": "string", "outputDataConfig": { "kmsKeyId": "string", "s3Path": "string"

},

"roleArn": "string", "stoppingCondition": {

"maxRuntimeInSeconds": number },

"tags": {

"string" : "string"

}}

(14)

URI Request Parameters

The request does not use any URI parameters.

Request Body

algorithmSpeciﬁcation (p. 8)

Deﬁnition of the Amazon Braket job to be created. Speciﬁes the container image the job uses and information about the Python scripts used for entry and training.

Type: AlgorithmSpeciﬁcation (p. 45) object Required: Yes

checkpointConﬁg (p. 8)

Information about the output locations for job checkpoint data.

Type: JobCheckpointConﬁg (p. 53) object Required: No

clientToken (p. 8)

A unique token that guarantees that the call to this API is idempotent.

Type: String

Required: Yes deviceConﬁg (p. 8)

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Type: DeviceConﬁg (p. 48) object Required: Yes

hyperParameters (p. 8)

Algorithm-speciﬁc parameters used by an Amazon Braket job that inﬂuence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Value Length Constraints: Minimum length of 1. Maximum length of 2500.

Required: No inputDataConﬁg (p. 8)

A list of parameters that specify the name and type of input data and where it is located.

Type: Array of InputFileConﬁg (p. 51) objects

(15)

Response Syntax

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No instanceConﬁg (p. 8)

Conﬁguration of the resource instances to use while running the hybrid job on Amazon Braket.

Type: InstanceConﬁg (p. 52) object Required: Yes

jobName (p. 8)

The name of the Amazon Braket job.

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$

Required: Yes outputDataConﬁg (p. 8)

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

Type: JobOutputDataConﬁg (p. 55) object Required: Yes

roleArn (p. 8)

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes stoppingCondition (p. 8)

The user-deﬁned criteria that speciﬁes when a job stops running.

Type: JobStoppingCondition (p. 56) object Required: No

tags (p. 8)

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

Type: String to string map Required: No

Response Syntax

HTTP/1.1 201

(16)

Response Elements

Content-type: application/json { "jobArn": "string"

}

Response Elements

jobArn (p. 10)

The ARN of the Amazon Braket job created.

Type: String

Errors

HTTP Status Code: 409 DeviceRetiredException

The speciﬁed device has been retired.

HTTP Status Code: 500 ServiceQuotaExceededException

The request failed because a service quota is exceeded.

(17)

See Also

CreateQuantumTask

Creates a quantum task.

Request Syntax

POST /quantum-task HTTP/1.1 Content-type: application/json { "action": "string",

"clientToken": "string", "deviceArn": "string",

"deviceParameters": "string", "jobToken": "string",

"outputS3Bucket": "string", "outputS3KeyPrefix": "string", "shots": number,

"tags": {

"string" : "string"

}}

URI Request Parameters

Request Body

action (p. 13)

The action associated with the task.

Type: String Required: Yes clientToken (p. 13)

The client token associated with the request.

Type: String

Required: Yes deviceArn (p. 13)

The ARN of the device to run the task on.

Type: String

Required: Yes

(19)

Response Syntax

deviceParameters (p. 13)

The parameters for the device to run the task on.

Type: String

Required: No jobToken (p. 13)

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

Type: String

Required: No outputS3Bucket (p. 13)

The S3 bucket to store task result ﬁles in.

Type: String

Required: Yes

outputS3KeyPreﬁx (p. 13)

The key preﬁx for the location in the S3 bucket to store task results in.

Type: String

Required: Yes shots (p. 13)

The number of shots to use for the task.

Type: Long

Valid Range: Minimum value of 0.

Required: Yes tags (p. 13)

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

Response Syntax

HTTP/1.1 201

Content-type: application/json

(20)

Response Elements

{

"quantumTaskArn": "string"

}

Response Elements

The ARN of the task created by the request.

Type: String

Errors

HTTP Status Code: 403 DeviceOﬄineException

The speciﬁed device is currently oﬄine.

HTTP Status Code: 424 DeviceRetiredException

The speciﬁed device has been retired.

HTTP Status Code: 500 ServiceQuotaExceededException

The request failed because a service quota is exceeded.

(21)

See Also

GetDevice

Retrieves the devices available in Amazon Braket.

Note

For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent.

See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

Request Syntax

GET /device/deviceArn HTTP/1.1

URI Request Parameters

deviceArn (p. 17)

The ARN of the device to retrieve.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "deviceArn": "string",

"deviceCapabilities": "string", "deviceName": "string",

"deviceStatus": "string", "deviceType": "string", "providerName": "string"

}

Response Elements

(23)

Errors

deviceArn (p. 17)

The ARN of the device.

Type: String

deviceCapabilities (p. 17)

Details about the capabilities of the device.

Type: String deviceName (p. 17)

The name of the device.

Type: String deviceStatus (p. 17)

The status of the device.

Type: String

Valid Values: ONLINE | OFFLINE | RETIRED deviceType (p. 17)

The type of the device.

Type: String

Valid Values: QPU | SIMULATOR providerName (p. 17)

The name of the partner company for the device.

Type: String

Errors

(24)

Examples

Example

To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the AWS CLI SDK:

% export AWS_EXECUTION_ENV="aws-cli BraketSchemas/1.8.0"

# Or for single execution

% AWS_EXECUTION_ENV="aws-cli BraketSchemas/1.8.0" aws braket <cmd> [options]

Example

To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Boto3:

import boto3 import botocore

client = boto3.client("braket",

config=botocore.client.Config(user_agent_extra="BraketSchemas/1.8.0"))

Example

To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the JavaScript/

TypeScript (SDK v2):

import Braket from 'aws-sdk/clients/braket';

const client = new Braket({ region: 'us-west-2', credentials: AWS_CREDENTIALS, customUserAgent: 'BraketSchemas/1.8.0' });

Example

To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the JavaScript/

TypeScript (SDK v3):

import { Braket } from '@aws-sdk/client-braket';

const client = new Braket({ region: 'us-west-2', credentials: AWS_CREDENTIALS, customUserAgent: 'BraketSchemas/1.8.0' });

Example

To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Go SDK:

os.Setenv("AWS_EXECUTION_ENV", "BraketGo BraketSchemas/1.8.0") mySession := session.Must(session.NewSession())

(25)

See Also

svc := braket.New(mySession)

Example

To set AWS_EXECUTION_ENV environment variable to conﬁgure user-agent when using the Java SDK:

ClientConfiguration config = new ClientConfiguration();

config.setUserAgentSuffix("BraketSchemas/1.8.0");

BraketClient braketClient =

BraketClientBuilder.standard().withClientConfiguration(config).build();

GetJob

Retrieves the speciﬁed Amazon Braket job.

Request Syntax

GET /job/jobArn HTTP/1.1

URI Request Parameters

jobArn (p. 21)

The ARN of the job to retrieve.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"algorithmSpecification": { "containerImage": { "uri": "string"

},

"scriptModeConfig": {

"compressionType": "string", "entryPoint": "string", "s3Uri": "string"

} },

"billableDuration": number, "checkpointConfig": { "localPath": "string", "s3Uri": "string"

},

"createdAt": number, "deviceConfig": { "device": "string"

},

"endedAt": number, "events": [ {

"eventType": "string", "message": "string", "timeOfEvent": number }

],

(27)

Response Elements

"failureReason": "string", "hyperParameters": { "string" : "string"

},

"inputDataConfig": [ {

"channelName": "string", "contentType": "string", "dataSource": {

"s3DataSource": { "s3Uri": "string"

} } } ],

"instanceConfig": {

"instanceType": "string", "volumeSizeInGb": number },

"jobArn": "string", "jobName": "string", "outputDataConfig": { "kmsKeyId": "string", "s3Path": "string"

},

"roleArn": "string", "startedAt": number, "status": "string", "stoppingCondition": {

"maxRuntimeInSeconds": number },

"tags": {

"string" : "string"

} }

Response Elements

algorithmSpeciﬁcation (p. 21)

Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to

evaluation the job.

Type: AlgorithmSpeciﬁcation (p. 45) object billableDuration (p. 21)

The billable time the Amazon Braket job used to complete.

Type: Integer

checkpointConﬁg (p. 21)

Information about the output locations for job checkpoint data.

Type: JobCheckpointConﬁg (p. 53) object createdAt (p. 21)

The date and time that the Amazon Braket job was created.

(28)

Response Elements

Type: Timestamp deviceConﬁg (p. 21)

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

Type: DeviceConﬁg (p. 48) object endedAt (p. 21)

The date and time that the Amazon Braket job ended.

Type: Timestamp events (p. 21)

Details about the type and time events occurred related to the Amazon Braket job.

Type: Array of JobEventDetails (p. 54) objects

failureReason (p. 21)

A description of the reason why an Amazon Braket job failed, if it failed.

Type: String

hyperParameters (p. 21)

Algorithm-speciﬁc parameters used by an Amazon Braket job that inﬂuence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

Map Entries: Minimum number of 0 items. Maximum number of 100 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Value Length Constraints: Minimum length of 1. Maximum length of 2500.

inputDataConﬁg (p. 21)

A list of parameters that specify the name and type of input data and where it is located.

Type: Array of InputFileConﬁg (p. 51) objects instanceConﬁg (p. 21)

The resource instances to use while running the hybrid job on Amazon Braket.

Type: InstanceConﬁg (p. 52) object jobArn (p. 21)

Type: String

jobName (p. 21)

(29)

Errors

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$

outputDataConﬁg (p. 21)

The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

Type: JobOutputDataConﬁg (p. 55) object roleArn (p. 21)

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

startedAt (p. 21)

The date and time that the Amazon Braket job was started.

Type: Timestamp status (p. 21)

The status of the Amazon Braket job.

Type: String

The user-deﬁned criteria that speciﬁes when to stop a job running.

Type: JobStoppingCondition (p. 56) object tags (p. 21)

Errors

(30)

See Also

ResourceNotFoundException

GetQuantumTask

Retrieves the speciﬁed quantum task.

Request Syntax

GET /quantum-task/quantumTaskArn HTTP/1.1

URI Request Parameters

the ARN of the task to retrieve.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"createdAt": number, "deviceArn": "string",

"deviceParameters": "string", "endedAt": number,

"failureReason": "string", "jobArn": "string",

"outputS3Bucket": "string", "outputS3Directory": "string", "quantumTaskArn": "string", "shots": number,

"status": "string", "tags": {

}}

Response Elements

createdAt (p. 26)

The time at which the task was created.

(32)

Response Elements

Type: Timestamp deviceArn (p. 26)

The ARN of the device the task was run on.

Type: String

deviceParameters (p. 26)

The parameters for the device on which the task ran.

Type: String endedAt (p. 26)

The time at which the task ended.

Type: Timestamp failureReason (p. 26)

The reason that a task failed.

Type: String jobArn (p. 26)

The ARN of the Amazon Braket job associated with the quantum task.

Type: String

outputS3Bucket (p. 26)

The S3 bucket where task results are stored.

Type: String

outputS3Directory (p. 26)

The folder in the S3 bucket where task results are stored.

Type: String

quantumTaskArn (p. 26) The ARN of the task.

Type: String

shots (p. 26)

The number of shots used in the task.

Type: Long status (p. 26)

The status of the task.

Type: String

(33)

Errors

tags (p. 26)

The tags that belong to this task.

Errors

ListTagsForResource

Shows the tags associated with this resource.

Request Syntax

GET /tags/resourceArn HTTP/1.1

URI Request Parameters

resourceArn (p. 29)

Specify the resourceArn for the resource whose tags to display.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "tags": {

}}

Response Elements

tags (p. 29)

Displays the key, value pairs of tags associated with this resource.

Errors

InternalServiceException

(35)

See Also

SearchDevices

Searches for devices using the speciﬁed ﬁlters.

Request Syntax

POST /devices HTTP/1.1

Content-type: application/json { "filters": [

{

"name": "string", "values": [ "string" ] }

],

"maxResults": number, "nextToken": "string"

}

URI Request Parameters

Request Body

ﬁlters (p. 31)

The ﬁlter values to use to search for a device.

Type: Array of SearchDevicesFilter (p. 63) objects

Required: Yes maxResults (p. 31)

The maximum number of results to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No nextToken (p. 31)

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

Type: String Required: No

(37)

Response Syntax

HTTP/1.1 200

"devices": [ {

"deviceArn": "string", "deviceName": "string", "deviceStatus": "string", "deviceType": "string", "providerName": "string"

} ],

"nextToken": "string"

}

Response Elements

devices (p. 32)

An array of DeviceSummary objects for devices that match the speciﬁed ﬁlter values.

Type: Array of DeviceSummary (p. 49) objects nextToken (p. 32)

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

Type: String

Errors

(38)

See Also

SearchJobs

Searches for Amazon Braket jobs that match the speciﬁed ﬁlter values.

Request Syntax

POST /jobs HTTP/1.1

"filters": [ {

"name": "string", "operator": "string", "values": [ "string" ] }

],

}

URI Request Parameters

Request Body

ﬁlters (p. 34)

The ﬁlter values to use when searching for a job.

Type: Array of SearchJobsFilter (p. 64) objects

The maximum number of results to return in the response.

Type: Integer

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

(40)

Response Syntax

HTTP/1.1 200

Content-type: application/json { "jobs": [

{

"createdAt": number, "device": "string", "endedAt": number, "jobArn": "string", "jobName": "string", "startedAt": number, "status": "string", "tags": {

} } ],

"nextToken": "string"

}

Response Elements

jobs (p. 35)

An array of JobSummary objects for devices that match the speciﬁed ﬁlter values.

Type: Array of JobSummary (p. 57) objects nextToken (p. 35)

Type: String

Errors

(41)

See Also

SearchQuantumTasks

Searches for tasks that match the speciﬁed ﬁlter values.

Request Syntax

POST /quantum-tasks HTTP/1.1 Content-type: application/json {

"filters": [ {

"name": "string", "operator": "string", "values": [ "string" ] }

],

}

URI Request Parameters

Request Body

ﬁlters (p. 37)

Array of SearchQuantumTasksFilter objects.

Type: Array of SearchQuantumTasksFilter (p. 65) objects

Maximum number of results to return in the response.

Type: Integer

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

(43)

Response Syntax

HTTP/1.1 200

Content-type: application/json { "nextToken": "string", "quantumTasks": [ {

"createdAt": number, "deviceArn": "string", "endedAt": number,

"outputS3Bucket": "string", "outputS3Directory": "string", "quantumTaskArn": "string", "shots": number,

"status": "string", "tags": {

} } ] }

Response Elements

nextToken (p. 38)

Type: String quantumTasks (p. 38)

An array of QuantumTaskSummary objects for tasks that match the speciﬁed ﬁlters.

Type: Array of QuantumTaskSummary (p. 59) objects

Errors

(44)

See Also

ThrottlingException

TagResource

Add a tag to the speciﬁed resource.

Request Syntax

POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": {

"string" : "string"

}}

URI Request Parameters

Specify the resourceArn of the resource to which a tag will be added.

Required: Yes

Request Body

tags (p. 40)

Specify the tags to add to the resource.

Type: String to string map Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

(46)

See Also

UntagResource

Remove tags from a resource.

Request Syntax

DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1

URI Request Parameters

Specify the resourceArn for the resource from which to remove the tags.

Required: Yes tagKeys (p. 42)

Specify the keys for the tags to remove from the resource.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

(48)

See Also

Data Types

The Braket API contains several data types that various actions use. This section describes each data type in detail.

Note

The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:

• AlgorithmSpeciﬁcation (p. 45)

• ContainerImage (p. 46)

• DataSource (p. 47)

• DeviceConﬁg (p. 48)

• DeviceSummary (p. 49)

• InputFileConﬁg (p. 51)

• InstanceConﬁg (p. 52)

• JobCheckpointConﬁg (p. 53)

• JobEventDetails (p. 54)

• JobOutputDataConﬁg (p. 55)

• JobStoppingCondition (p. 56)

• JobSummary (p. 57)

• QuantumTaskSummary (p. 59)

• S3DataSource (p. 61)

• ScriptModeConﬁg (p. 62)

• SearchDevicesFilter (p. 63)

• SearchJobsFilter (p. 64)

• SearchQuantumTasksFilter (p. 65)

(50)

AlgorithmSpeciﬁcation

Deﬁnes the Amazon Braket job to be created. Speciﬁes the container image the job uses and the paths to the Python scripts used for entry and training.

ContainerImage

The container image used to create an Amazon Braket job.

DataSource

Information about the source of the data used by the Amazon Braket job.

DeviceConﬁg

Conﬁgures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.

DeviceSummary

Includes information about the device.

InputFileConﬁg

A list of parameters that specify the input channels, type of input data, and where it is located.

InstanceConﬁg

Conﬁgures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.

JobCheckpointConﬁg

Contains information about the output locations for job checkpoint data.

JobEventDetails

Details about the type and time events occurred related to the Amazon Braket job.

JobOutputDataConﬁg

Speciﬁes the path to the S3 location where you want to store job artifacts and the encryption key used to store them.

JobStoppingCondition

Speciﬁes limits for how long an Amazon Braket job can run.

JobSummary

Provides summary information about an Amazon Braket job.

QuantumTaskSummary

Includes information about a quantum task.

S3DataSource

Information about the data stored in Amazon S3 used by the Amazon Braket job.

Amazon Braket

Amazon Braket

API Reference

API Version 2019-09-01

Amazon Braket: API Reference

Table of Contents

Welcome

Actions

CancelJob

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CancelQuantumTask

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateJob

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateQuantumTask

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

GetDevice

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

Example

Example

Example

Example

Example

See Also

GetJob

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

GetQuantumTask

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

ListTagsForResource

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

SearchDevices