BraketClient | Braket Client - AWS SDK for JavaScript v3

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

Amazon Braket Developer Guide

Hierarchy

Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BraketClientResolvedConfig>
Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BraketClientResolvedConfig>
- BraketClient
  - Braket

Implements

Client<ServiceInputTypes, ServiceOutputTypes, BraketClientResolvedConfig>
Client<ServiceInputTypes, ServiceOutputTypes, BraketClientResolvedConfig>

Index

Constructors

constructor

Properties

Methods

destroy
send

Constructors

constructor

new BraketClient(configuration: BraketClientConfig): BraketClient

Overrides Client.constructor
- Defined in clients/client-braket/dist-types/BraketClient.d.ts:157
Parameters
- configuration: BraketClientConfig
Returns BraketClient

Properties

Readonly config

config: BraketClientResolvedConfig

The resolved configuration of BraketClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

destroy

destroy(): void

Overrides Client.destroy
- Defined in clients/client-braket/dist-types/BraketClient.d.ts:164
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options?: HandlerOptions): Promise<OutputType>
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, cb: (err: any, data?: OutputType) => void): void
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options: __HttpHandlerOptions, cb: (err: any, data?: OutputType) => void): void

Inherited from BraketClient.send

Overrides BraketClient.send
- Defined in packages/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
Inherited from BraketClient.send

Overrides BraketClient.send
- Defined in packages/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
Inherited from BraketClient.send

Overrides BraketClient.send
- Defined in packages/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- options: __HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: BraketClientConfig

Returns BraketClient

Properties

Readonly config

middlewareStack

Methods

destroy

Returns void

send

Type parameters

InputType: ServiceInputTypes

OutputType: ServiceOutputTypes

Parameters

command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>

Optional options: HandlerOptions

Returns Promise<OutputType>

Type parameters

InputType: ServiceInputTypes

OutputType: ServiceOutputTypes

Parameters

command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>

cb: (err: any, data?: OutputType) => void

Parameters

err: any

Optional data: OutputType

Returns void

Returns void

Type parameters

InputType: ServiceInputTypes

OutputType: ServiceOutputTypes

Parameters

command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>

options: __HttpHandlerOptions

cb: (err: any, data?: OutputType) => void

Parameters

err: any

Optional data: OutputType

Returns void

Returns void