The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.
To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.
In this guide:
Available languages for AWS SDK:
Code examples from the Amazon Braket Tutorials GitHub repository:
", "operations": { "CancelJob": "Cancels an Amazon Braket hybrid job.
", "CancelQuantumTask": "Cancels the specified task.
", "CreateJob": "Creates an Amazon Braket hybrid job.
", "CreateQuantumTask": "Creates a quantum task.
", "GetDevice": "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 hybrid job.
", "GetQuantumTask": "Retrieves the specified quantum task.
", "ListTagsForResource": "Shows the tags associated with this resource.
", "SearchDevices": "Searches for devices using the specified filters.
", "SearchJobs": "Searches for Amazon Braket hybrid jobs that match the specified filter values.
", "SearchQuantumTasks": "Searches for tasks that match the specified filter values.
", "TagResource": "Add a tag to the specified resource.
", "UntagResource": "Remove tags from a resource.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient permissions to perform this action.
", "refs": {} }, "ActionMetadata": { "base": "Contains metadata about the quantum task action, including the action type and program statistics.
", "refs": { "GetQuantumTaskResponse$actionMetadata": "Metadata about the action performed by the quantum task, including information about the type of action and program counts.
" } }, "AlgorithmSpecification": { "base": "Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.
", "refs": { "CreateJobRequest$algorithmSpecification": "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.
", "GetJobResponse$algorithmSpecification": "Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.
" } }, "Association": { "base": "The Amazon Braket resource and the association type.
", "refs": { "Associations$member": null, "CreateJobRequestAssociationsList$member": null, "CreateQuantumTaskRequestAssociationsList$member": null } }, "AssociationType": { "base": null, "refs": { "Association$type": "The association type for the specified Amazon Braket resource arn.
" } }, "Associations": { "base": null, "refs": { "GetJobResponse$associations": "The list of Amazon Braket resources associated with the hybrid job.
", "GetQuantumTaskResponse$associations": "The list of Amazon Braket resources associated with the quantum task.
" } }, "BraketResourceArn": { "base": null, "refs": { "Association$arn": "The Amazon Braket resource arn.
" } }, "CancelJobRequest": { "base": null, "refs": {} }, "CancelJobResponse": { "base": null, "refs": {} }, "CancelQuantumTaskRequest": { "base": null, "refs": {} }, "CancelQuantumTaskResponse": { "base": null, "refs": {} }, "CancellationStatus": { "base": null, "refs": { "CancelJobResponse$cancellationStatus": "The status of the hybrid job.
", "CancelQuantumTaskResponse$cancellationStatus": "The status of the quantum task.
" } }, "CompressionType": { "base": null, "refs": { "ScriptModeConfig$compressionType": "The type of compression used to store the algorithm scripts in Amazon S3 storage.
" } }, "ConflictException": { "base": "An error occurred due to a conflict.
", "refs": {} }, "ContainerImage": { "base": "The container image used to create an Amazon Braket hybrid job.
", "refs": { "AlgorithmSpecification$containerImage": "The container image used to create an Amazon Braket hybrid job.
" } }, "CreateJobRequest": { "base": null, "refs": {} }, "CreateJobRequestAssociationsList": { "base": null, "refs": { "CreateJobRequest$associations": "The list of Amazon Braket resources associated with the hybrid job.
" } }, "CreateJobRequestInputDataConfigList": { "base": null, "refs": { "CreateJobRequest$inputDataConfig": "A list of parameters that specify the name and type of input data and where it is located.
" } }, "CreateJobRequestJobNameString": { "base": null, "refs": { "CreateJobRequest$jobName": "The name of the Amazon Braket hybrid job.
" } }, "CreateJobResponse": { "base": null, "refs": {} }, "CreateQuantumTaskRequest": { "base": null, "refs": {} }, "CreateQuantumTaskRequestAssociationsList": { "base": null, "refs": { "CreateQuantumTaskRequest$associations": "The list of Amazon Braket resources associated with the quantum task.
" } }, "CreateQuantumTaskRequestDeviceParametersString": { "base": null, "refs": { "CreateQuantumTaskRequest$deviceParameters": "The parameters for the device to run the quantum task on.
" } }, "CreateQuantumTaskRequestOutputS3BucketString": { "base": null, "refs": { "CreateQuantumTaskRequest$outputS3Bucket": "The S3 bucket to store quantum task result files in.
" } }, "CreateQuantumTaskRequestOutputS3KeyPrefixString": { "base": null, "refs": { "CreateQuantumTaskRequest$outputS3KeyPrefix": "The key prefix for the location in the S3 bucket to store quantum task results in.
" } }, "CreateQuantumTaskRequestShotsLong": { "base": null, "refs": { "CreateQuantumTaskRequest$shots": "The number of shots to use for the quantum task.
" } }, "CreateQuantumTaskResponse": { "base": null, "refs": {} }, "DataSource": { "base": "Information about the source of the input data used by the Amazon Braket hybrid job.
", "refs": { "InputFileConfig$dataSource": "The location of the input data.
" } }, "DeviceArn": { "base": null, "refs": { "CreateQuantumTaskRequest$deviceArn": "The ARN of the device to run the quantum task on.
", "DeviceSummary$deviceArn": "The ARN of the device.
", "GetDeviceRequest$deviceArn": "The ARN of the device to retrieve.
", "GetDeviceResponse$deviceArn": "The ARN of the device.
", "GetQuantumTaskResponse$deviceArn": "The ARN of the device the quantum task was run on.
", "QuantumTaskSummary$deviceArn": "The ARN of the device the quantum task ran on.
" } }, "DeviceConfig": { "base": "Configures the primary device used to create and run an Amazon Braket hybrid job.
", "refs": { "CreateJobRequest$deviceConfig": "The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.
", "GetJobResponse$deviceConfig": "The primary device used by the Amazon Braket hybrid job.
" } }, "DeviceOfflineException": { "base": "The specified device is currently offline.
", "refs": {} }, "DeviceQueueInfo": { "base": "Information about quantum tasks and hybrid jobs queued on a device.
", "refs": { "DeviceQueueInfoList$member": null } }, "DeviceQueueInfoList": { "base": null, "refs": { "GetDeviceResponse$deviceQueueInfo": "The number of quantum tasks and hybrid jobs currently queued on the device.
" } }, "DeviceRetiredException": { "base": "The specified device has been retired.
", "refs": {} }, "DeviceStatus": { "base": null, "refs": { "DeviceSummary$deviceStatus": "The status of the device.
", "GetDeviceResponse$deviceStatus": "The status of the device.
" } }, "DeviceSummary": { "base": "Includes information about the device.
", "refs": { "DeviceSummaryList$member": null } }, "DeviceSummaryList": { "base": null, "refs": { "SearchDevicesResponse$devices": "An array of DeviceSummary objects for devices that match the specified filter values.
The type of the device.
", "GetDeviceResponse$deviceType": "The type of the device.
" } }, "GetDeviceRequest": { "base": null, "refs": {} }, "GetDeviceResponse": { "base": null, "refs": {} }, "GetJobRequest": { "base": null, "refs": {} }, "GetJobResponse": { "base": null, "refs": {} }, "GetJobResponseJobNameString": { "base": null, "refs": { "GetJobResponse$jobName": "The name of the Amazon Braket hybrid job.
" } }, "GetQuantumTaskRequest": { "base": null, "refs": {} }, "GetQuantumTaskResponse": { "base": null, "refs": {} }, "HybridJobAdditionalAttributeName": { "base": null, "refs": { "HybridJobAdditionalAttributeNamesList$member": null } }, "HybridJobAdditionalAttributeNamesList": { "base": null, "refs": { "GetJobRequest$additionalAttributeNames": "A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.
" } }, "HybridJobQueueInfo": { "base": "Information about the queue for a specified hybrid job.
", "refs": { "GetJobResponse$queueInfo": "Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames\" field in the GetJob API request.
Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
" } }, "HyperParametersValueString": { "base": null, "refs": { "HyperParameters$value": null } }, "InputConfigList": { "base": null, "refs": { "GetJobResponse$inputDataConfig": "A list of parameters that specify the name and type of input data and where it is located.
" } }, "InputFileConfig": { "base": "A list of parameters that specify the input channels, type of input data, and where it is located.
", "refs": { "CreateJobRequestInputDataConfigList$member": null, "InputConfigList$member": null } }, "InputFileConfigChannelNameString": { "base": null, "refs": { "InputFileConfig$channelName": "A named input source that an Amazon Braket hybrid job can consume.
" } }, "InstanceConfig": { "base": "Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.
", "refs": { "CreateJobRequest$instanceConfig": "Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
", "GetJobResponse$instanceConfig": "The resource instances to use while running the hybrid job on Amazon Braket.
" } }, "InstanceConfigInstanceCountInteger": { "base": null, "refs": { "InstanceConfig$instanceCount": "Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.
" } }, "InstanceConfigVolumeSizeInGbInteger": { "base": null, "refs": { "InstanceConfig$volumeSizeInGb": "The size of the storage volume, in GB, to provision.
" } }, "InstanceType": { "base": null, "refs": { "InstanceConfig$instanceType": "Configures the type of resource instances to use while running an Amazon Braket hybrid job.
" } }, "Integer": { "base": null, "refs": { "GetJobResponse$billableDuration": "The billable time for which the Amazon Braket hybrid job used to complete.
" } }, "InternalServiceException": { "base": "The request failed because of an unknown error.
", "refs": {} }, "JobArn": { "base": null, "refs": { "CancelJobRequest$jobArn": "The ARN of the Amazon Braket hybrid job to cancel.
", "CancelJobResponse$jobArn": "The ARN of the Amazon Braket job.
", "CreateJobResponse$jobArn": "The ARN of the Amazon Braket hybrid job created.
", "GetJobRequest$jobArn": "The ARN of the hybrid job to retrieve.
", "GetJobResponse$jobArn": "The ARN of the Amazon Braket hybrid job.
", "GetQuantumTaskResponse$jobArn": "The ARN of the Amazon Braket job associated with the quantum task.
", "JobSummary$jobArn": "The ARN of the Amazon Braket hybrid job.
" } }, "JobCheckpointConfig": { "base": "Contains information about the output locations for hybrid job checkpoint data.
", "refs": { "CreateJobRequest$checkpointConfig": "Information about the output locations for hybrid job checkpoint data.
", "GetJobResponse$checkpointConfig": "Information about the output locations for hybrid job checkpoint data.
" } }, "JobEventDetails": { "base": "Details about the type and time events that occurred related to the Amazon Braket hybrid job.
", "refs": { "JobEvents$member": null } }, "JobEventDetailsMessageString": { "base": null, "refs": { "JobEventDetails$message": "A message describing the event that occurred related to the Amazon Braket hybrid job.
" } }, "JobEventType": { "base": null, "refs": { "JobEventDetails$eventType": "The type of event that occurred related to the Amazon Braket hybrid job.
" } }, "JobEvents": { "base": null, "refs": { "GetJobResponse$events": "Details about the time and type of events occurred related to the Amazon Braket hybrid job.
" } }, "JobOutputDataConfig": { "base": "Specifies the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
", "refs": { "CreateJobRequest$outputDataConfig": "The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
", "GetJobResponse$outputDataConfig": "The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.
" } }, "JobPrimaryStatus": { "base": null, "refs": { "GetJobResponse$status": "The status of the Amazon Braket hybrid job.
", "JobSummary$status": "The status of the Amazon Braket hybrid job.
" } }, "JobStoppingCondition": { "base": "Specifies limits for how long an Amazon Braket hybrid job can run.
", "refs": { "CreateJobRequest$stoppingCondition": "The user-defined criteria that specifies when a hybrid job stops running.
", "GetJobResponse$stoppingCondition": "The user-defined criteria that specifies when to stop a running hybrid job.
" } }, "JobStoppingConditionMaxRuntimeInSecondsInteger": { "base": null, "refs": { "JobStoppingCondition$maxRuntimeInSeconds": "The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.
" } }, "JobSummary": { "base": "Provides summary information about an Amazon Braket hybrid job.
", "refs": { "JobSummaryList$member": null } }, "JobSummaryList": { "base": null, "refs": { "SearchJobsResponse$jobs": "An array of JobSummary objects for devices that match the specified filter values.
The token for an Amazon Braket hybrid job that associates it with the quantum task.
" } }, "JsonValue": { "base": null, "refs": { "CreateQuantumTaskRequest$action": "The action associated with the quantum task.
", "GetDeviceResponse$deviceCapabilities": "Details about the capabilities of the device.
", "GetQuantumTaskResponse$deviceParameters": "The parameters for the device on which the quantum task ran.
" } }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "Long": { "base": null, "refs": { "ActionMetadata$programCount": "The number of programs in a program set. This is only available for a Program Set.
", "ActionMetadata$executableCount": "The number of executables in a program set. This is only available for a Program Set.
", "GetQuantumTaskResponse$shots": "The number of shots used in the quantum task.
", "GetQuantumTaskResponse$numSuccessfulShots": "The number of successful shots for the quantum task. This is available after a successfully completed quantum task.
", "ProgramSetValidationFailure$programIndex": "The index of the program within the program set that failed validation.
", "ProgramSetValidationFailure$inputsIndex": "The index of the input within the program set that failed validation.
", "QuantumTaskSummary$shots": "The shots used for the quantum task.
" } }, "ProgramSetValidationFailure": { "base": "Contains information about validation failures that occurred during the processing of a program set in a quantum task.
", "refs": { "ProgramSetValidationFailuresList$member": null } }, "ProgramSetValidationFailuresList": { "base": null, "refs": { "ValidationException$programSetValidationFailures": "The validation failures in the program set submitted in the request.
" } }, "ProgramValidationFailuresList": { "base": null, "refs": { "ProgramSetValidationFailure$errors": "A list of error messages describing the validation failures that occurred.
" } }, "QuantumTaskAdditionalAttributeName": { "base": null, "refs": { "QuantumTaskAdditionalAttributeNamesList$member": null } }, "QuantumTaskAdditionalAttributeNamesList": { "base": null, "refs": { "GetQuantumTaskRequest$additionalAttributeNames": "A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.
" } }, "QuantumTaskArn": { "base": null, "refs": { "CancelQuantumTaskRequest$quantumTaskArn": "The ARN of the quantum task to cancel.
", "CancelQuantumTaskResponse$quantumTaskArn": "The ARN of the quantum task.
", "CreateQuantumTaskResponse$quantumTaskArn": "The ARN of the quantum task created by the request.
", "GetQuantumTaskRequest$quantumTaskArn": "The ARN of the quantum task to retrieve.
", "GetQuantumTaskResponse$quantumTaskArn": "The ARN of the quantum task.
", "QuantumTaskSummary$quantumTaskArn": "The ARN of the quantum task.
" } }, "QuantumTaskQueueInfo": { "base": "The queue information for the specified quantum task.
", "refs": { "GetQuantumTaskResponse$queueInfo": "Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames\" field in the GetQuantumTask API request.
The status of the quantum task.
", "QuantumTaskSummary$status": "The status of the quantum task.
" } }, "QuantumTaskSummary": { "base": "Includes information about a quantum task.
", "refs": { "QuantumTaskSummaryList$member": null } }, "QuantumTaskSummaryList": { "base": null, "refs": { "SearchQuantumTasksResponse$quantumTasks": "An array of QuantumTaskSummary objects for quantum tasks that match the specified filters.
The name of the queue.
", "HybridJobQueueInfo$queue": "The name of the queue.
", "QuantumTaskQueueInfo$queue": "The name of the queue.
" } }, "QueuePriority": { "base": null, "refs": { "DeviceQueueInfo$queuePriority": "Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.
", "QuantumTaskQueueInfo$queuePriority": "Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.
" } }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", "refs": {} }, "RoleArn": { "base": null, "refs": { "CreateJobRequest$roleArn": "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 results and hybrid job details to the users' s3 buckets.
", "GetJobResponse$roleArn": "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 results and other hybrid job details to the s3 buckets of a user.
" } }, "S3DataSource": { "base": "Information about the Amazon S3 storage used by the Amazon Braket hybrid job.
", "refs": { "DataSource$s3DataSource": "Amazon S3 path of the input data used by the hybrid job.
" } }, "S3Path": { "base": null, "refs": { "JobCheckpointConfig$s3Uri": "Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, s3://bucket-name/key-name-prefix.
Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, s3://bucket-name/key-name-prefix.
Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.
The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.
" } }, "ScriptModeConfig": { "base": "Contains information about algorithm scripts used for the Amazon Braket hybrid job.
", "refs": { "AlgorithmSpecification$scriptModeConfig": "Configures the paths to the Python scripts used for entry and training.
" } }, "SearchDevicesFilter": { "base": "The filter used to search for devices.
", "refs": { "SearchDevicesRequestFiltersList$member": null } }, "SearchDevicesFilterNameString": { "base": null, "refs": { "SearchDevicesFilter$name": "The name of the device parameter to filter based on. Only deviceArn filter name is currently supported.
The values used to filter devices based on the filter name.
" } }, "SearchDevicesRequest": { "base": null, "refs": {} }, "SearchDevicesRequestFiltersList": { "base": null, "refs": { "SearchDevicesRequest$filters": "Array of SearchDevicesFilter objects to use when searching for devices.
" } }, "SearchDevicesRequestMaxResultsInteger": { "base": null, "refs": { "SearchDevicesRequest$maxResults": "The maximum number of results to return in the response.
" } }, "SearchDevicesResponse": { "base": null, "refs": {} }, "SearchJobsFilter": { "base": "A filter used to search for Amazon Braket hybrid jobs.
", "refs": { "SearchJobsRequestFiltersList$member": null } }, "SearchJobsFilterOperator": { "base": null, "refs": { "SearchJobsFilter$operator": "An operator to use for the filter.
" } }, "SearchJobsFilterValuesList": { "base": null, "refs": { "SearchJobsFilter$values": "The values used to filter hybrid jobs based on the filter name and operator.
" } }, "SearchJobsRequest": { "base": null, "refs": {} }, "SearchJobsRequestFiltersList": { "base": null, "refs": { "SearchJobsRequest$filters": "Array of SearchJobsFilter objects to use when searching for hybrid jobs.
" } }, "SearchJobsRequestMaxResultsInteger": { "base": null, "refs": { "SearchJobsRequest$maxResults": "The maximum number of results to return in the response.
" } }, "SearchJobsResponse": { "base": null, "refs": {} }, "SearchQuantumTasksFilter": { "base": "A filter used to search for quantum tasks.
", "refs": { "SearchQuantumTasksRequestFiltersList$member": null } }, "SearchQuantumTasksFilterOperator": { "base": null, "refs": { "SearchQuantumTasksFilter$operator": "An operator to use for the filter.
" } }, "SearchQuantumTasksFilterValuesList": { "base": null, "refs": { "SearchQuantumTasksFilter$values": "The values used to filter quantum tasks based on the filter name and operator.
" } }, "SearchQuantumTasksRequest": { "base": null, "refs": {} }, "SearchQuantumTasksRequestFiltersList": { "base": null, "refs": { "SearchQuantumTasksRequest$filters": "Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.
Maximum number of results to return in the response.
" } }, "SearchQuantumTasksResponse": { "base": null, "refs": {} }, "ServiceQuotaExceededException": { "base": "The request failed because a service quota is exceeded.
", "refs": {} }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ActionMetadata$actionType": "The type of action associated with the quantum task.
", "ConflictException$message": null, "DeviceOfflineException$message": null, "DeviceQueueInfo$queueSize": "The number of hybrid jobs or quantum tasks in the queue for a given device.
", "DeviceRetiredException$message": null, "DeviceSummary$deviceName": "The name of the device.
", "DeviceSummary$providerName": "The provider of the device.
", "GetDeviceResponse$deviceName": "The name of the device.
", "GetDeviceResponse$providerName": "The name of the partner company for the device.
", "GetQuantumTaskResponse$failureReason": "The reason that a quantum task failed.
", "GetQuantumTaskResponse$outputS3Bucket": "The S3 bucket where quantum task results are stored.
", "GetQuantumTaskResponse$outputS3Directory": "The folder in the S3 bucket where quantum task results are stored.
", "HybridJobQueueInfo$position": "Current position of the hybrid job in the jobs queue.
", "HybridJobQueueInfo$message": "Optional. Provides more information about the queue position. For example, if the hybrid job is complete and no longer in the queue, the message field contains that information.
", "InternalServiceException$message": null, "JobSummary$jobName": "The name of the Amazon Braket hybrid job.
", "ListTagsForResourceRequest$resourceArn": "Specify the resourceArn for the resource whose tags to display.
Current position of the quantum task in the quantum tasks queue.
", "QuantumTaskQueueInfo$message": "Optional. Provides more information about the queue position. For example, if the quantum task is complete and no longer in the queue, the message field contains that information.
", "QuantumTaskSummary$outputS3Bucket": "The S3 bucket where the quantum task result file is stored.
", "QuantumTaskSummary$outputS3Directory": "The folder in the S3 bucket where the quantum task result file is stored.
", "ResourceNotFoundException$message": null, "ScriptModeConfig$entryPoint": "The entry point in the algorithm scripts from where the execution begins in the hybrid job.
", "SearchDevicesRequest$nextToken": "A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.
", "SearchDevicesResponse$nextToken": "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 search where the previous request ended.
", "SearchJobsRequest$nextToken": "A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.
", "SearchJobsResponse$nextToken": "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 search where the previous request ended.
A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.
", "SearchQuantumTasksResponse$nextToken": "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 search where the previous request ended.
", "ServiceQuotaExceededException$message": null, "TagKeys$member": null, "TagResourceRequest$resourceArn": "Specify the resourceArn of the resource to which a tag will be added.
Specify the resourceArn for the resource from which to remove the tags.
A description of the reason why an Amazon Braket hybrid job failed, if it failed.
" } }, "String2048": { "base": null, "refs": { "JobOutputDataConfig$kmsKeyId": "The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption.
" } }, "String256": { "base": null, "refs": { "DeviceConfig$device": "The primary device ARN used to create and run an Amazon Braket hybrid job.
", "HyperParameters$key": null, "InputFileConfig$contentType": "The MIME type of the data.
", "JobSummary$device": "The primary device used by an Amazon Braket hybrid job.
", "SearchDevicesFilterValuesList$member": null, "SearchJobsFilterValuesList$member": null, "SearchQuantumTasksFilterValuesList$member": null } }, "String4096": { "base": null, "refs": { "JobCheckpointConfig$localPath": "(Optional) The local directory where checkpoint data is stored. The default directory is /opt/braket/checkpoints/.
The client token associated with the cancellation request.
", "CreateJobRequest$clientToken": "The client token associated with this request that guarantees that the request is idempotent.
", "CreateQuantumTaskRequest$clientToken": "The client token associated with the request.
", "SearchJobsFilter$name": "The name of the hybrid job parameter to filter based on. Filter name can be either jobArn or createdAt.
The name of the quantum task parameter to filter based on. Filter name can be either quantumTaskArn, deviceArn, jobArn, status or createdAt.
The time at which the Amazon Braket hybrid job was created.
", "GetJobResponse$startedAt": "The time at which the Amazon Braket hybrid job was started.
", "GetJobResponse$endedAt": "The time at which the Amazon Braket hybrid job ended.
", "GetQuantumTaskResponse$createdAt": "The time at which the quantum task was created.
", "GetQuantumTaskResponse$endedAt": "The time at which the quantum task ended.
", "JobEventDetails$timeOfEvent": "The time of the event that occurred related to the Amazon Braket hybrid job.
", "JobSummary$createdAt": "The time at which the Amazon Braket hybrid job was created.
", "JobSummary$startedAt": "The time at which the Amazon Braket hybrid job was started.
", "JobSummary$endedAt": "The time at which the Amazon Braket hybrid job ended.
", "QuantumTaskSummary$createdAt": "The time at which the quantum task was created.
", "QuantumTaskSummary$endedAt": "The time at which the quantum task finished.
" } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "Specify the keys for the tags to remove from the resource.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagsMap": { "base": null, "refs": { "CreateJobRequest$tags": "Tags to be added to the hybrid job you're creating.
", "CreateQuantumTaskRequest$tags": "Tags to be added to the quantum task you're creating.
", "GetJobResponse$tags": "The tags associated with this hybrid job.
", "GetQuantumTaskResponse$tags": "The tags that belong to this quantum task.
", "JobSummary$tags": "Displays the key, value pairs of tags associated with this hybrid job.
", "ListTagsForResourceResponse$tags": "Displays the key, value pairs of tags associated with this resource.
", "QuantumTaskSummary$tags": "Displays the key, value pairs of tags associated with this quantum task.
", "TagResourceRequest$tags": "Specify the tags to add to the resource. Tags can be specified as a key-value map.
" } }, "ThrottlingException": { "base": "The API throttling rate limit is exceeded.
", "refs": {} }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "Uri": { "base": null, "refs": { "ContainerImage$uri": "The URI locating the container image.
" } }, "ValidationException": { "base": "The input request failed to satisfy constraints expected by Amazon Braket.
", "refs": {} }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The reason for validation failure.
" } } } }