- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
BraketClient
The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
Additional Resources:
Installation
npm install @aws-sdk/client-braket
yarn add @aws-sdk/client-braket
pnpm add @aws-sdk/client-braket
BraketClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CancelJobCommand | Cancels an Amazon Braket job. |
CancelQuantumTaskCommand | Cancels the specified task. |
CreateJobCommand | Creates an Amazon Braket job. |
CreateQuantumTaskCommand | Creates a quantum task. |
GetDeviceCommand | 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. |
GetJobCommand | Retrieves the specified Amazon Braket job. |
GetQuantumTaskCommand | Retrieves the specified quantum task. |
ListTagsForResourceCommand | Shows the tags associated with this resource. |
SearchDevicesCommand | Searches for devices using the specified filters. |
SearchJobsCommand | Searches for Amazon Braket jobs that match the specified filter values. |
SearchQuantumTasksCommand | Searches for tasks that match the specified filter values. |
TagResourceCommand | Add a tag to the specified resource. |
UntagResourceCommand | Remove tags from a resource. |
BraketClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: BraketClientConfig