{ "version":"2.0", "metadata":{ "apiVersion":"2019-09-01", "endpointPrefix":"braket", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"Braket", "serviceId":"Braket", "signatureVersion":"v4", "signingName":"braket", "uid":"braket-2019-09-01" }, "operations":{ "CancelQuantumTask":{ "name":"CancelQuantumTask", "http":{ "method":"PUT", "requestUri":"/quantum-task/{quantumTaskArn}/cancel", "responseCode":200 }, "input":{"shape":"CancelQuantumTaskRequest"}, "output":{"shape":"CancelQuantumTaskResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"
Cancels the specified task.
", "idempotent":true }, "CreateQuantumTask":{ "name":"CreateQuantumTask", "http":{ "method":"POST", "requestUri":"/quantum-task", "responseCode":201 }, "input":{"shape":"CreateQuantumTaskRequest"}, "output":{"shape":"CreateQuantumTaskResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"DeviceOfflineException"}, {"shape":"InternalServiceException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"} ], "documentation":"Creates a quantum task.
" }, "GetDevice":{ "name":"GetDevice", "http":{ "method":"GET", "requestUri":"/device/{deviceArn}", "responseCode":200 }, "input":{"shape":"GetDeviceRequest"}, "output":{"shape":"GetDeviceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"DeviceOfflineException"}, {"shape":"DeviceRetiredException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves the devices available in Amazon Braket.
" }, "GetQuantumTask":{ "name":"GetQuantumTask", "http":{ "method":"GET", "requestUri":"/quantum-task/{quantumTaskArn}", "responseCode":200 }, "input":{"shape":"GetQuantumTaskRequest"}, "output":{"shape":"GetQuantumTaskResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves the specified quantum task.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Shows the tags associated with this resource.
" }, "SearchDevices":{ "name":"SearchDevices", "http":{ "method":"POST", "requestUri":"/devices", "responseCode":200 }, "input":{"shape":"SearchDevicesRequest"}, "output":{"shape":"SearchDevicesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Searches for devices using the specified filters.
" }, "SearchQuantumTasks":{ "name":"SearchQuantumTasks", "http":{ "method":"POST", "requestUri":"/quantum-tasks", "responseCode":200 }, "input":{"shape":"SearchQuantumTasksRequest"}, "output":{"shape":"SearchQuantumTasksResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Searches for tasks that match the specified filter values.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Add a tag to the specified resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"} ], "documentation":"Remove tags from a resource.
", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "CancelQuantumTaskRequest":{ "type":"structure", "required":[ "clientToken", "quantumTaskArn" ], "members":{ "clientToken":{ "shape":"String64", "documentation":"The client token associated with the request.
", "idempotencyToken":true }, "quantumTaskArn":{ "shape":"QuantumTaskArn", "documentation":"The ARN of the task to cancel.
", "location":"uri", "locationName":"quantumTaskArn" } } }, "CancelQuantumTaskResponse":{ "type":"structure", "required":[ "cancellationStatus", "quantumTaskArn" ], "members":{ "cancellationStatus":{ "shape":"CancellationStatus", "documentation":"The status of the cancellation request.
" }, "quantumTaskArn":{ "shape":"QuantumTaskArn", "documentation":"The ARN of the task.
" } } }, "CancellationStatus":{ "type":"string", "enum":[ "CANCELLING", "CANCELLED" ] }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"An error occurred due to a conflict.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateQuantumTaskRequest":{ "type":"structure", "required":[ "action", "clientToken", "deviceArn", "outputS3Bucket", "outputS3KeyPrefix", "shots" ], "members":{ "action":{ "shape":"JsonValue", "documentation":"The action associated with the task.
", "jsonvalue":true }, "clientToken":{ "shape":"String64", "documentation":"The client token associated with the request.
", "idempotencyToken":true }, "deviceArn":{ "shape":"DeviceArn", "documentation":"The ARN of the device to run the task on.
" }, "deviceParameters":{ "shape":"CreateQuantumTaskRequestDeviceParametersString", "documentation":"The parameters for the device to run the task on.
", "jsonvalue":true }, "outputS3Bucket":{ "shape":"CreateQuantumTaskRequestOutputS3BucketString", "documentation":"The S3 bucket to store task result files in.
" }, "outputS3KeyPrefix":{ "shape":"CreateQuantumTaskRequestOutputS3KeyPrefixString", "documentation":"The key prefix for the location in the S3 bucket to store task results in.
" }, "shots":{ "shape":"CreateQuantumTaskRequestShotsLong", "documentation":"The number of shots to use for the task.
" }, "tags":{ "shape":"TagsMap", "documentation":"Tags to be added to the quantum task you're creating.
" } } }, "CreateQuantumTaskRequestDeviceParametersString":{ "type":"string", "max":48000, "min":1 }, "CreateQuantumTaskRequestOutputS3BucketString":{ "type":"string", "max":63, "min":3 }, "CreateQuantumTaskRequestOutputS3KeyPrefixString":{ "type":"string", "max":1024, "min":1 }, "CreateQuantumTaskRequestShotsLong":{ "type":"long", "box":true, "min":0 }, "CreateQuantumTaskResponse":{ "type":"structure", "required":["quantumTaskArn"], "members":{ "quantumTaskArn":{ "shape":"QuantumTaskArn", "documentation":"The ARN of the task created by the request.
" } } }, "DeviceArn":{ "type":"string", "max":256, "min":1 }, "DeviceOfflineException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The specified device is currently offline.
", "error":{ "httpStatusCode":424, "senderFault":true }, "exception":true }, "DeviceRetiredException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The specified device has been retired.
", "error":{ "httpStatusCode":410, "senderFault":true }, "exception":true }, "DeviceStatus":{ "type":"string", "enum":[ "ONLINE", "OFFLINE", "RETIRED" ] }, "DeviceSummary":{ "type":"structure", "required":[ "deviceArn", "deviceName", "deviceStatus", "deviceType", "providerName" ], "members":{ "deviceArn":{ "shape":"DeviceArn", "documentation":"The ARN of the device.
" }, "deviceName":{ "shape":"String", "documentation":"The name of the device.
" }, "deviceStatus":{ "shape":"DeviceStatus", "documentation":"The status of the device.
" }, "deviceType":{ "shape":"DeviceType", "documentation":"The type of the device.
" }, "providerName":{ "shape":"String", "documentation":"The provider of the device.
" } }, "documentation":"Includes information about the device.
" }, "DeviceSummaryList":{ "type":"list", "member":{"shape":"DeviceSummary"} }, "DeviceType":{ "type":"string", "enum":[ "QPU", "SIMULATOR" ] }, "GetDeviceRequest":{ "type":"structure", "required":["deviceArn"], "members":{ "deviceArn":{ "shape":"DeviceArn", "documentation":"The ARN of the device to retrieve.
", "location":"uri", "locationName":"deviceArn" } } }, "GetDeviceResponse":{ "type":"structure", "required":[ "deviceArn", "deviceCapabilities", "deviceName", "deviceStatus", "deviceType", "providerName" ], "members":{ "deviceArn":{ "shape":"DeviceArn", "documentation":"The ARN of the device.
" }, "deviceCapabilities":{ "shape":"JsonValue", "documentation":"Details about the capabilities of the device.
", "jsonvalue":true }, "deviceName":{ "shape":"String", "documentation":"The name of the device.
" }, "deviceStatus":{ "shape":"DeviceStatus", "documentation":"The status of the device.
" }, "deviceType":{ "shape":"DeviceType", "documentation":"The type of the device.
" }, "providerName":{ "shape":"String", "documentation":"The name of the partner company for the device.
" } } }, "GetQuantumTaskRequest":{ "type":"structure", "required":["quantumTaskArn"], "members":{ "quantumTaskArn":{ "shape":"QuantumTaskArn", "documentation":"the ARN of the task to retrieve.
", "location":"uri", "locationName":"quantumTaskArn" } } }, "GetQuantumTaskResponse":{ "type":"structure", "required":[ "createdAt", "deviceArn", "deviceParameters", "outputS3Bucket", "outputS3Directory", "quantumTaskArn", "shots", "status" ], "members":{ "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time at which the task was created.
" }, "deviceArn":{ "shape":"DeviceArn", "documentation":"The ARN of the device the task was run on.
" }, "deviceParameters":{ "shape":"JsonValue", "documentation":"The parameters for the device on which the task ran.
", "jsonvalue":true }, "endedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time at which the task ended.
" }, "failureReason":{ "shape":"String", "documentation":"The reason that a task failed.
" }, "outputS3Bucket":{ "shape":"String", "documentation":"The S3 bucket where task results are stored.
" }, "outputS3Directory":{ "shape":"String", "documentation":"The folder in the S3 bucket where task results are stored.
" }, "quantumTaskArn":{ "shape":"QuantumTaskArn", "documentation":"The ARN of the task.
" }, "shots":{ "shape":"Long", "documentation":"The number of shots used in the task.
" }, "status":{ "shape":"QuantumTaskStatus", "documentation":"The status of the task.
" }, "tags":{ "shape":"TagsMap", "documentation":"The tags that belong to this task.
" } } }, "InternalServiceException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "JsonValue":{"type":"string"}, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"Specify the resourceArn
for the resource whose tags to display.
Displays the key, value pairs of tags associated with this resource.
" } } }, "Long":{ "type":"long", "box":true }, "QuantumTaskArn":{ "type":"string", "max":256, "min":1 }, "QuantumTaskStatus":{ "type":"string", "enum":[ "CREATED", "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED" ] }, "QuantumTaskSummary":{ "type":"structure", "required":[ "createdAt", "deviceArn", "outputS3Bucket", "outputS3Directory", "quantumTaskArn", "shots", "status" ], "members":{ "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time at which the task was created.
" }, "deviceArn":{ "shape":"DeviceArn", "documentation":"The ARN of the device the task ran on.
" }, "endedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The time at which the task finished.
" }, "outputS3Bucket":{ "shape":"String", "documentation":"The S3 bucket where the task result file is stored..
" }, "outputS3Directory":{ "shape":"String", "documentation":"The folder in the S3 bucket where the task result file is stored.
" }, "quantumTaskArn":{ "shape":"QuantumTaskArn", "documentation":"The ARN of the task.
" }, "shots":{ "shape":"Long", "documentation":"The shots used for the task.
" }, "status":{ "shape":"QuantumTaskStatus", "documentation":"The status of the task.
" }, "tags":{ "shape":"TagsMap", "documentation":"Displays the key, value pairs of tags associated with this quantum task.
" } }, "documentation":"Includes information about a quantum task.
" }, "QuantumTaskSummaryList":{ "type":"list", "member":{"shape":"QuantumTaskSummary"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The specified resource was not found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "SearchDevicesFilter":{ "type":"structure", "required":[ "name", "values" ], "members":{ "name":{ "shape":"SearchDevicesFilterNameString", "documentation":"The name to use to filter results.
" }, "values":{ "shape":"SearchDevicesFilterValuesList", "documentation":"The values to use to filter results.
" } }, "documentation":"The filter to use for searching devices.
" }, "SearchDevicesFilterNameString":{ "type":"string", "max":64, "min":1 }, "SearchDevicesFilterValuesList":{ "type":"list", "member":{"shape":"String256"}, "max":10, "min":1 }, "SearchDevicesRequest":{ "type":"structure", "required":["filters"], "members":{ "filters":{ "shape":"SearchDevicesRequestFiltersList", "documentation":"The filter values to use to search for a device.
" }, "maxResults":{ "shape":"SearchDevicesRequestMaxResultsInteger", "documentation":"The maximum number of results to return in the response.
" }, "nextToken":{ "shape":"String", "documentation":"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.
" } } }, "SearchDevicesRequestFiltersList":{ "type":"list", "member":{"shape":"SearchDevicesFilter"}, "max":10, "min":0 }, "SearchDevicesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "SearchDevicesResponse":{ "type":"structure", "required":["devices"], "members":{ "devices":{ "shape":"DeviceSummaryList", "documentation":"An array of DeviceSummary
objects for devices that match the specified filter values.
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.
" } } }, "SearchQuantumTasksFilter":{ "type":"structure", "required":[ "name", "operator", "values" ], "members":{ "name":{ "shape":"String64", "documentation":"The name of the device used for the task.
" }, "operator":{ "shape":"SearchQuantumTasksFilterOperator", "documentation":"An operator to use in the filter.
" }, "values":{ "shape":"SearchQuantumTasksFilterValuesList", "documentation":"The values to use for the filter.
" } }, "documentation":"A filter to use to search for tasks.
" }, "SearchQuantumTasksFilterOperator":{ "type":"string", "enum":[ "LT", "LTE", "EQUAL", "GT", "GTE", "BETWEEN" ] }, "SearchQuantumTasksFilterValuesList":{ "type":"list", "member":{"shape":"String256"}, "max":10, "min":1 }, "SearchQuantumTasksRequest":{ "type":"structure", "required":["filters"], "members":{ "filters":{ "shape":"SearchQuantumTasksRequestFiltersList", "documentation":"Array of SearchQuantumTasksFilter
objects.
Maximum number of results to return in the response.
" }, "nextToken":{ "shape":"String", "documentation":"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.
" } } }, "SearchQuantumTasksRequestFiltersList":{ "type":"list", "member":{"shape":"SearchQuantumTasksFilter"}, "max":10, "min":0 }, "SearchQuantumTasksRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "SearchQuantumTasksResponse":{ "type":"structure", "required":["quantumTasks"], "members":{ "nextToken":{ "shape":"String", "documentation":"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.
" }, "quantumTasks":{ "shape":"QuantumTaskSummaryList", "documentation":"An array of QuantumTaskSummary
objects for tasks that match the specified filters.
The request failed because a service quota is exceeded.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "String":{"type":"string"}, "String256":{ "type":"string", "max":256, "min":1 }, "String64":{ "type":"string", "max":64, "min":1 }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "TagKeys":{ "type":"list", "member":{"shape":"String"} }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"Specify the resourceArn
of the resource to which a tag will be added.
Specify the tags to add to the resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The throttling rate limit is met.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"Specify the resourceArn
for the resource from which to remove the tags.
Specify the keys for the tags to remove from the resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
" }