{ "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": { "CancelJob": { "name": "CancelJob", "http": { "method": "PUT", "requestUri": "/job/{jobArn}/cancel", "responseCode": 200 }, "input": { "shape": "CancelJobRequest" }, "output": { "shape": "CancelJobResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ConflictException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceException" }, { "shape": "ValidationException" } ], "documentation": "
Cancels an Amazon Braket job.
", "idempotent": true }, "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 }, "CreateJob": { "name": "CreateJob", "http": { "method": "POST", "requestUri": "/job", "responseCode": 201 }, "input": { "shape": "CreateJobRequest" }, "output": { "shape": "CreateJobResponse" }, "errors": [ { "shape": "ConflictException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "DeviceOfflineException" }, { "shape": "DeviceRetiredException" }, { "shape": "InternalServiceException" }, { "shape": "ServiceQuotaExceededException" }, { "shape": "ValidationException" } ], "documentation": "Creates an Amazon Braket job.
" }, "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": "DeviceRetiredException" }, { "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": "InternalServiceException" }, { "shape": "ValidationException" } ], "documentation": "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.
Retrieves the specified Amazon Braket job.
" }, "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.
" }, "SearchJobs": { "name": "SearchJobs", "http": { "method": "POST", "requestUri": "/jobs", "responseCode": 200 }, "input": { "shape": "SearchJobsRequest" }, "output": { "shape": "SearchJobsResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceException" }, { "shape": "ValidationException" } ], "documentation": "Searches for Amazon Braket jobs that match the specified filter values.
" }, "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": { "AlgorithmSpecification": { "type": "structure", "members": { "containerImage": { "shape": "ContainerImage", "documentation": "The container image used to create an Amazon Braket job.
" }, "scriptModeConfig": { "shape": "ScriptModeConfig", "documentation": "Configures the paths to the Python scripts used for entry and training.
" } }, "documentation": "Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.
" }, "Association": { "type": "structure", "required": [ "arn", "type" ], "members": { "arn": { "shape": "BraketResourceArn", "documentation": "The Amazon Braket resource arn.
" }, "type": { "shape": "AssociationType", "documentation": "The association type for the specified Amazon Braket resource arn.
" } }, "documentation": "The Amazon Braket resource and the association type.
" }, "AssociationType": { "type": "string", "enum": [ "RESERVATION_TIME_WINDOW_ARN" ] }, "Associations": { "type": "list", "member": { "shape": "Association" } }, "BraketResourceArn": { "type": "string", "pattern": "^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]*:[0-9]{12}:.*$" }, "CancelJobRequest": { "type": "structure", "required": [ "jobArn" ], "members": { "jobArn": { "shape": "JobArn", "documentation": "The ARN of the Amazon Braket job to cancel.
", "location": "uri", "locationName": "jobArn" } } }, "CancelJobResponse": { "type": "structure", "required": [ "cancellationStatus", "jobArn" ], "members": { "cancellationStatus": { "shape": "CancellationStatus", "documentation": "The status of the job cancellation request.
" }, "jobArn": { "shape": "JobArn", "documentation": "The ARN of the Amazon Braket job.
" } } }, "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" ] }, "CompressionType": { "type": "string", "enum": [ "NONE", "GZIP" ] }, "ContainerImage": { "type": "structure", "required": [ "uri" ], "members": { "uri": { "shape": "Uri", "documentation": "The URI locating the container image.
" } }, "documentation": "The container image used to create an Amazon Braket job.
" }, "CreateJobRequest": { "type": "structure", "required": [ "algorithmSpecification", "clientToken", "deviceConfig", "instanceConfig", "jobName", "outputDataConfig", "roleArn" ], "members": { "algorithmSpecification": { "shape": "AlgorithmSpecification", "documentation": "Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.
" }, "associations": { "shape": "CreateJobRequestAssociationsList", "documentation": "The list of Amazon Braket resources associated with the hybrid job.
" }, "checkpointConfig": { "shape": "JobCheckpointConfig", "documentation": "Information about the output locations for job checkpoint data.
" }, "clientToken": { "shape": "String64", "documentation": "A unique token that guarantees that the call to this API is idempotent.
", "idempotencyToken": true }, "deviceConfig": { "shape": "DeviceConfig", "documentation": "The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
" }, "hyperParameters": { "shape": "HyperParameters", "documentation": "Algorithm-specific parameters used by an Amazon Braket job that influence 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.
" }, "inputDataConfig": { "shape": "CreateJobRequestInputDataConfigList", "documentation": "A list of parameters that specify the name and type of input data and where it is located.
" }, "instanceConfig": { "shape": "InstanceConfig", "documentation": "Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
" }, "jobName": { "shape": "CreateJobRequestJobNameString", "documentation": "The name of the Amazon Braket job.
" }, "outputDataConfig": { "shape": "JobOutputDataConfig", "documentation": "The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
" }, "roleArn": { "shape": "RoleArn", "documentation": "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.
" }, "stoppingCondition": { "shape": "JobStoppingCondition", "documentation": "The user-defined criteria that specifies when a job stops running.
" }, "tags": { "shape": "TagsMap", "documentation": "A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
" } } }, "CreateJobRequestAssociationsList": { "type": "list", "member": { "shape": "Association" }, "max": 1, "min": 0 }, "CreateJobRequestInputDataConfigList": { "type": "list", "member": { "shape": "InputFileConfig" }, "max": 20, "min": 0 }, "CreateJobRequestJobNameString": { "type": "string", "max": 50, "min": 1, "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$" }, "CreateJobResponse": { "type": "structure", "required": [ "jobArn" ], "members": { "jobArn": { "shape": "JobArn", "documentation": "The ARN of the Amazon Braket job created.
" } } }, "CreateQuantumTaskRequest": { "type": "structure", "required": [ "action", "clientToken", "deviceArn", "outputS3Bucket", "outputS3KeyPrefix", "shots" ], "members": { "action": { "shape": "JsonValue", "documentation": "The action associated with the task.
", "jsonvalue": true }, "associations": { "shape": "CreateQuantumTaskRequestAssociationsList", "documentation": "The list of Amazon Braket resources associated with the quantum task.
" }, "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 }, "jobToken": { "shape": "JobToken", "documentation": "The token for an Amazon Braket job that associates it with the quantum task.
" }, "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.
" } } }, "CreateQuantumTaskRequestAssociationsList": { "type": "list", "member": { "shape": "Association" }, "max": 1, "min": 0 }, "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.
" } } }, "DataSource": { "type": "structure", "required": [ "s3DataSource" ], "members": { "s3DataSource": { "shape": "S3DataSource", "documentation": "Information about the data stored in Amazon S3 used by the Amazon Braket job.
" } }, "documentation": "Information about the source of the data used by the Amazon Braket job.
" }, "DeviceArn": { "type": "string", "max": 256, "min": 1 }, "DeviceConfig": { "type": "structure", "required": [ "device" ], "members": { "device": { "shape": "String256", "documentation": "The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
" } }, "documentation": "Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.
" }, "DeviceQueueInfo": { "type": "structure", "required": [ "queue", "queueSize" ], "members": { "queue": { "shape": "QueueName", "documentation": "The name of the queue.
" }, "queuePriority": { "shape": "QueuePriority", "documentation": "Optional. Specifies the priority of the queue. Tasks in a priority queue are processed before the tasks in a normal queue.
" }, "queueSize": { "shape": "String", "documentation": "The number of jobs or tasks in the queue for a given device.
" } }, "documentation": "Information about tasks and jobs queued on a device.
" }, "DeviceQueueInfoList": { "type": "list", "member": { "shape": "DeviceQueueInfo" } }, "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.
" }, "deviceQueueInfo": { "shape": "DeviceQueueInfoList", "documentation": "List of information about tasks and jobs queued on a 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.
" } } }, "GetJobRequest": { "type": "structure", "required": [ "jobArn" ], "members": { "additionalAttributeNames": { "shape": "HybridJobAdditionalAttributeNamesList", "documentation": "A list of attributes to return information for.
", "location": "querystring", "locationName": "additionalAttributeNames" }, "jobArn": { "shape": "JobArn", "documentation": "The ARN of the job to retrieve.
", "location": "uri", "locationName": "jobArn" } } }, "GetJobResponse": { "type": "structure", "required": [ "algorithmSpecification", "createdAt", "instanceConfig", "jobArn", "jobName", "outputDataConfig", "roleArn", "status" ], "members": { "algorithmSpecification": { "shape": "AlgorithmSpecification", "documentation": "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.
" }, "associations": { "shape": "Associations", "documentation": "The list of Amazon Braket resources associated with the hybrid job.
" }, "billableDuration": { "shape": "Integer", "documentation": "The billable time the Amazon Braket job used to complete.
" }, "checkpointConfig": { "shape": "JobCheckpointConfig", "documentation": "Information about the output locations for job checkpoint data.
" }, "createdAt": { "shape": "SyntheticTimestamp_date_time", "documentation": "The date and time that the Amazon Braket job was created.
" }, "deviceConfig": { "shape": "DeviceConfig", "documentation": "The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
" }, "endedAt": { "shape": "SyntheticTimestamp_date_time", "documentation": "The date and time that the Amazon Braket job ended.
" }, "events": { "shape": "JobEvents", "documentation": "Details about the type and time events occurred related to the Amazon Braket job.
" }, "failureReason": { "shape": "String1024", "documentation": "A description of the reason why an Amazon Braket job failed, if it failed.
" }, "hyperParameters": { "shape": "HyperParameters", "documentation": "Algorithm-specific parameters used by an Amazon Braket job that influence 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.
" }, "inputDataConfig": { "shape": "InputConfigList", "documentation": "A list of parameters that specify the name and type of input data and where it is located.
" }, "instanceConfig": { "shape": "InstanceConfig", "documentation": "The resource instances to use while running the hybrid job on Amazon Braket.
" }, "jobArn": { "shape": "JobArn", "documentation": "The ARN of the Amazon Braket job.
" }, "jobName": { "shape": "GetJobResponseJobNameString", "documentation": "The name of the Amazon Braket job.
" }, "outputDataConfig": { "shape": "JobOutputDataConfig", "documentation": "The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
" }, "queueInfo": { "shape": "HybridJobQueueInfo", "documentation": "Queue information for the requested job. Only returned if QueueInfo
is specified in the additionalAttributeNames\"
field in the GetJob
API request.
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.
" }, "startedAt": { "shape": "SyntheticTimestamp_date_time", "documentation": "The date and time that the Amazon Braket job was started.
" }, "status": { "shape": "JobPrimaryStatus", "documentation": "The status of the Amazon Braket job.
" }, "stoppingCondition": { "shape": "JobStoppingCondition", "documentation": "The user-defined criteria that specifies when to stop a job running.
" }, "tags": { "shape": "TagsMap", "documentation": "A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
" } } }, "GetJobResponseJobNameString": { "type": "string", "max": 50, "min": 1, "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}$" }, "GetQuantumTaskRequest": { "type": "structure", "required": [ "quantumTaskArn" ], "members": { "additionalAttributeNames": { "shape": "QuantumTaskAdditionalAttributeNamesList", "documentation": "A list of attributes to return information for.
", "location": "querystring", "locationName": "additionalAttributeNames" }, "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": { "associations": { "shape": "Associations", "documentation": "The list of Amazon Braket resources associated with the quantum task.
" }, "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.
" }, "jobArn": { "shape": "JobArn", "documentation": "The ARN of the Amazon Braket job associated with the quantum task.
" }, "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.
" }, "queueInfo": { "shape": "QuantumTaskQueueInfo", "documentation": "Queue information for the requested quantum task. Only returned if QueueInfo
is specified in the additionalAttributeNames\"
field in the GetQuantumTask
API request.
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.
" } } }, "HybridJobAdditionalAttributeName": { "type": "string", "enum": [ "QueueInfo" ] }, "HybridJobAdditionalAttributeNamesList": { "type": "list", "member": { "shape": "HybridJobAdditionalAttributeName" } }, "HybridJobQueueInfo": { "type": "structure", "required": [ "position", "queue" ], "members": { "message": { "shape": "String", "documentation": "Optional. Provides more information about the queue position. For example, if the job is complete and no longer in the queue, the message field contains that information.
" }, "position": { "shape": "String", "documentation": "Current position of the job in the jobs queue.
" }, "queue": { "shape": "QueueName", "documentation": "The name of the queue.
" } }, "documentation": "Information about the queue for a specified job.
" }, "HyperParameters": { "type": "map", "key": { "shape": "String256" }, "value": { "shape": "HyperParametersValueString" }, "max": 100, "min": 0 }, "HyperParametersValueString": { "type": "string", "max": 2500, "min": 1, "pattern": "^.*$" }, "InputConfigList": { "type": "list", "member": { "shape": "InputFileConfig" } }, "InputFileConfig": { "type": "structure", "required": [ "channelName", "dataSource" ], "members": { "channelName": { "shape": "InputFileConfigChannelNameString", "documentation": "A named input source that an Amazon Braket job can consume.
" }, "contentType": { "shape": "String256", "documentation": "The MIME type of the data.
" }, "dataSource": { "shape": "DataSource", "documentation": "The location of the channel data.
" } }, "documentation": "A list of parameters that specify the input channels, type of input data, and where it is located.
" }, "InputFileConfigChannelNameString": { "type": "string", "max": 64, "min": 1, "pattern": "^[A-Za-z0-9\\.\\-_]+$" }, "InstanceConfig": { "type": "structure", "required": [ "instanceType", "volumeSizeInGb" ], "members": { "instanceCount": { "shape": "InstanceConfigInstanceCountInteger", "documentation": "Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.
" }, "instanceType": { "shape": "InstanceType", "documentation": "Configures the type resource instances to use while running an Amazon Braket hybrid job.
" }, "volumeSizeInGb": { "shape": "InstanceConfigVolumeSizeInGbInteger", "documentation": "The size of the storage volume, in GB, that user wants to provision.
" } }, "documentation": "Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.
" }, "InstanceConfigInstanceCountInteger": { "type": "integer", "box": true, "min": 1 }, "InstanceConfigVolumeSizeInGbInteger": { "type": "integer", "box": true, "min": 1 }, "InstanceType": { "type": "string", "enum": [ "ml.m4.xlarge", "ml.m4.2xlarge", "ml.m4.4xlarge", "ml.m4.10xlarge", "ml.m4.16xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.12xlarge", "ml.m5.24xlarge", "ml.c4.xlarge", "ml.c4.2xlarge", "ml.c4.4xlarge", "ml.c4.8xlarge", "ml.p2.xlarge", "ml.p2.8xlarge", "ml.p2.16xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.p4d.24xlarge", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.18xlarge", "ml.c5n.xlarge", "ml.c5n.2xlarge", "ml.c5n.4xlarge", "ml.c5n.9xlarge", "ml.c5n.18xlarge" ] }, "Integer": { "type": "integer", "box": true }, "JobArn": { "type": "string", "pattern": "^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]+:[0-9]{12}:job/.*$" }, "JobCheckpointConfig": { "type": "structure", "required": [ "s3Uri" ], "members": { "localPath": { "shape": "String4096", "documentation": "(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/
.
Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix
.
Contains information about the output locations for job checkpoint data.
" }, "JobEventDetails": { "type": "structure", "members": { "eventType": { "shape": "JobEventType", "documentation": "The type of event that occurred related to the Amazon Braket job.
" }, "message": { "shape": "JobEventDetailsMessageString", "documentation": "A message describing the event that occurred related to the Amazon Braket job.
" }, "timeOfEvent": { "shape": "SyntheticTimestamp_date_time", "documentation": "The type of event that occurred related to the Amazon Braket job.
" } }, "documentation": "Details about the type and time events occurred related to the Amazon Braket job.
" }, "JobEventDetailsMessageString": { "type": "string", "max": 2500, "min": 0 }, "JobEventType": { "type": "string", "enum": [ "WAITING_FOR_PRIORITY", "QUEUED_FOR_EXECUTION", "STARTING_INSTANCE", "DOWNLOADING_DATA", "RUNNING", "DEPRIORITIZED_DUE_TO_INACTIVITY", "UPLOADING_RESULTS", "COMPLETED", "FAILED", "MAX_RUNTIME_EXCEEDED", "CANCELLED" ] }, "JobEvents": { "type": "list", "member": { "shape": "JobEventDetails" }, "max": 20, "min": 0 }, "JobOutputDataConfig": { "type": "structure", "required": [ "s3Path" ], "members": { "kmsKeyId": { "shape": "String2048", "documentation": "The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.
" }, "s3Path": { "shape": "S3Path", "documentation": "Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix
.
Specifies the path to the S3 location where you want to store job artifacts and the encryption key used to store them.
" }, "JobPrimaryStatus": { "type": "string", "enum": [ "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED" ] }, "JobStoppingCondition": { "type": "structure", "members": { "maxRuntimeInSeconds": { "shape": "JobStoppingConditionMaxRuntimeInSecondsInteger", "documentation": "The maximum length of time, in seconds, that an Amazon Braket job can run.
" } }, "documentation": "Specifies limits for how long an Amazon Braket job can run.
" }, "JobStoppingConditionMaxRuntimeInSecondsInteger": { "type": "integer", "box": true, "max": 432000, "min": 1 }, "JobSummary": { "type": "structure", "required": [ "createdAt", "device", "jobArn", "jobName", "status" ], "members": { "createdAt": { "shape": "SyntheticTimestamp_date_time", "documentation": "The date and time that the Amazon Braket job was created.
" }, "device": { "shape": "String256", "documentation": "Provides summary information about the primary device used by an Amazon Braket job.
" }, "endedAt": { "shape": "SyntheticTimestamp_date_time", "documentation": "The date and time that the Amazon Braket job ended.
" }, "jobArn": { "shape": "JobArn", "documentation": "The ARN of the Amazon Braket job.
" }, "jobName": { "shape": "String", "documentation": "The name of the Amazon Braket job.
" }, "startedAt": { "shape": "SyntheticTimestamp_date_time", "documentation": "The date and time that the Amazon Braket job was started.
" }, "status": { "shape": "JobPrimaryStatus", "documentation": "The status of the Amazon Braket job.
" }, "tags": { "shape": "TagsMap", "documentation": "A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
" } }, "documentation": "Provides summary information about an Amazon Braket job.
" }, "JobSummaryList": { "type": "list", "member": { "shape": "JobSummary" } }, "JobToken": { "type": "string", "max": 128, "min": 1 }, "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 }, "QuantumTaskAdditionalAttributeName": { "type": "string", "enum": [ "QueueInfo" ] }, "QuantumTaskAdditionalAttributeNamesList": { "type": "list", "member": { "shape": "QuantumTaskAdditionalAttributeName" } }, "QuantumTaskArn": { "type": "string", "max": 256, "min": 0 }, "QuantumTaskQueueInfo": { "type": "structure", "required": [ "position", "queue" ], "members": { "message": { "shape": "String", "documentation": "Optional. Provides more information about the queue position. For example, if the task is complete and no longer in the queue, the message field contains that information.
" }, "position": { "shape": "String", "documentation": "Current position of the task in the quantum tasks queue.
" }, "queue": { "shape": "QueueName", "documentation": "The name of the queue.
" }, "queuePriority": { "shape": "QueuePriority", "documentation": "Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the tasks in a normal queue.
" } }, "documentation": "Information about the queue for the specified quantum task.
" }, "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" } }, "QueueName": { "type": "string", "enum": [ "QUANTUM_TASKS_QUEUE", "JOBS_QUEUE" ] }, "QueuePriority": { "type": "string", "enum": [ "Normal", "Priority" ] }, "RoleArn": { "type": "string", "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "S3DataSource": { "type": "structure", "required": [ "s3Uri" ], "members": { "s3Uri": { "shape": "S3Path", "documentation": "Depending on the value specified for the S3DataType
, identifies either a key name prefix or a manifest that locates the S3 data source.
Information about the data stored in Amazon S3 used by the Amazon Braket job.
" }, "S3Path": { "type": "string", "max": 1024, "min": 0, "pattern": "^(https|s3)://([^/]+)/?(.*)$" }, "ScriptModeConfig": { "type": "structure", "required": [ "entryPoint", "s3Uri" ], "members": { "compressionType": { "shape": "CompressionType", "documentation": "The type of compression used by the Python scripts for an Amazon Braket job.
" }, "entryPoint": { "shape": "String", "documentation": "The path to the Python script that serves as the entry point for an Amazon Braket job.
" }, "s3Uri": { "shape": "S3Path", "documentation": "The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.
" } }, "documentation": "Contains information about the Python scripts used for entry and by an Amazon Braket job.
" }, "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.
" } } }, "SearchJobsFilter": { "type": "structure", "required": [ "name", "operator", "values" ], "members": { "name": { "shape": "String64", "documentation": "The name to use for the jobs filter.
" }, "operator": { "shape": "SearchJobsFilterOperator", "documentation": "An operator to use for the jobs filter.
" }, "values": { "shape": "SearchJobsFilterValuesList", "documentation": "The values to use for the jobs filter.
" } }, "documentation": "A filter used to search for Amazon Braket jobs.
" }, "SearchJobsFilterOperator": { "type": "string", "enum": [ "LT", "LTE", "EQUAL", "GT", "GTE", "BETWEEN", "CONTAINS" ] }, "SearchJobsFilterValuesList": { "type": "list", "member": { "shape": "String256" }, "max": 10, "min": 1 }, "SearchJobsRequest": { "type": "structure", "required": [ "filters" ], "members": { "filters": { "shape": "SearchJobsRequestFiltersList", "documentation": "The filter values to use when searching for a job.
" }, "maxResults": { "shape": "SearchJobsRequestMaxResultsInteger", "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 to continue results where the previous request ended.
" } } }, "SearchJobsRequestFiltersList": { "type": "list", "member": { "shape": "SearchJobsFilter" }, "max": 10, "min": 0 }, "SearchJobsRequestMaxResultsInteger": { "type": "integer", "box": true, "max": 100, "min": 1 }, "SearchJobsResponse": { "type": "structure", "required": [ "jobs" ], "members": { "jobs": { "shape": "JobSummaryList", "documentation": "An array of JobSummary
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.
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.
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" } }, "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": {} }, "Uri": { "type": "string", "max": 255, "min": 1, "pattern": "\\d{10,14}\\.dkr\\.ecr.[a-z0-9-]+\\.amazonaws\\.com\\/.+(@sha256)?:.+" } }, "documentation": "The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
Additional Resources:
" }