{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-braket","description":"Braket","version":"2019-09-01","base_url":"","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Braket\n@version 2019-09-01\n@auth AWS SigV4\n@endpoints 13\n@toc job(3), quantum-task(3), device(1), tags(3), devices(1), jobs(1), quantum-tasks(1)\n\n@group job\n@endpoint PUT /job/{jobArn}/cancel\n@desc Cancels an Amazon Braket job.\n@required {jobArn: str}\n@returns(200) {cancellationStatus: str, jobArn: str}\n\n@endgroup\n\n@group quantum-task\n@endpoint PUT /quantum-task/{quantumTaskArn}/cancel\n@desc Cancels the specified task.\n@required {quantumTaskArn: str, clientToken: str}\n@returns(200) {cancellationStatus: str, quantumTaskArn: str}\n\n@endgroup\n\n@group job\n@endpoint POST /job\n@desc Creates an Amazon Braket job.\n@required {algorithmSpecification: AlgorithmSpecification, clientToken: str, deviceConfig: DeviceConfig, instanceConfig: InstanceConfig, jobName: str, outputDataConfig: JobOutputDataConfig, roleArn: str}\n@optional {associations: [Association], checkpointConfig: JobCheckpointConfig, hyperParameters: map<str,str>, inputDataConfig: [InputFileConfig], stoppingCondition: JobStoppingCondition, tags: map<str,str>}\n@returns(200) {jobArn: str}\n\n@endgroup\n\n@group quantum-task\n@endpoint POST /quantum-task\n@desc Creates a quantum task.\n@required {action: str, clientToken: str, deviceArn: str, outputS3Bucket: str, outputS3KeyPrefix: str, shots: int(i64)}\n@optional {associations: [Association], deviceParameters: str, jobToken: str, tags: map<str,str>}\n@returns(200) {quantumTaskArn: str}\n\n@endgroup\n\n@group device\n@endpoint GET /device/{deviceArn}\n@desc Retrieves the devices available in Amazon Braket.  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 configure 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.\n@required {deviceArn: str}\n@returns(200) {deviceArn: str, deviceCapabilities: str, deviceName: str, deviceQueueInfo: [DeviceQueueInfo]?, deviceStatus: str, deviceType: str, providerName: str}\n\n@endgroup\n\n@group job\n@endpoint GET /job/{jobArn}\n@desc Retrieves the specified Amazon Braket job.\n@required {jobArn: str}\n@optional {additionalAttributeNames: [str]}\n@returns(200) {algorithmSpecification: AlgorithmSpecification{containerImage: ContainerImage?{uri: str}, scriptModeConfig: ScriptModeConfig?{compressionType: str?, entryPoint: str, s3Uri: str}}, associations: [Association]?, billableDuration: int?, checkpointConfig: JobCheckpointConfig?{localPath: str?, s3Uri: str}, createdAt: str(timestamp), deviceConfig: DeviceConfig?{device: str}, endedAt: str(timestamp)?, events: [JobEventDetails]?, failureReason: str?, hyperParameters: map<str,str>?, inputDataConfig: [InputFileConfig]?, instanceConfig: InstanceConfig{instanceCount: int?, instanceType: str, volumeSizeInGb: int}, jobArn: str, jobName: str, outputDataConfig: JobOutputDataConfig{kmsKeyId: str?, s3Path: str}, queueInfo: HybridJobQueueInfo?{message: str?, position: str, queue: str}, roleArn: str, startedAt: str(timestamp)?, status: str, stoppingCondition: JobStoppingCondition?{maxRuntimeInSeconds: int?}, tags: map<str,str>?}\n\n@endgroup\n\n@group quantum-task\n@endpoint GET /quantum-task/{quantumTaskArn}\n@desc Retrieves the specified quantum task.\n@required {quantumTaskArn: str}\n@optional {additionalAttributeNames: [str]}\n@returns(200) {associations: [Association]?, createdAt: str(timestamp), deviceArn: str, deviceParameters: str, endedAt: str(timestamp)?, failureReason: str?, jobArn: str?, outputS3Bucket: str, outputS3Directory: str, quantumTaskArn: str, queueInfo: QuantumTaskQueueInfo?{message: str?, position: str, queue: str, queuePriority: str?}, shots: int(i64), status: str, tags: map<str,str>?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resourceArn}\n@desc Shows the tags associated with this resource.\n@required {resourceArn: str}\n@returns(200) {tags: map<str,str>?}\n\n@endgroup\n\n@group devices\n@endpoint POST /devices\n@desc Searches for devices using the specified filters.\n@required {filters: [SearchDevicesFilter]}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {devices: [DeviceSummary], nextToken: str?}\n\n@endgroup\n\n@group jobs\n@endpoint POST /jobs\n@desc Searches for Amazon Braket jobs that match the specified filter values.\n@required {filters: [SearchJobsFilter]}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {jobs: [JobSummary], nextToken: str?}\n\n@endgroup\n\n@group quantum-tasks\n@endpoint POST /quantum-tasks\n@desc Searches for tasks that match the specified filter values.\n@required {filters: [SearchQuantumTasksFilter]}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {nextToken: str?, quantumTasks: [QuantumTaskSummary]}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{resourceArn}\n@desc Add a tag to the specified resource.\n@required {resourceArn: str, tags: map<str,str>}\n\n@endpoint DELETE /tags/{resourceArn}\n@desc Remove tags from a resource.\n@required {resourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@end\n"}