Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class BraketClient

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

Additional Resources:

Hierarchy

Constructors

constructor

Properties

config middlewareStack

Methods

destroy send

Constructors

constructor

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 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

  • Type Parameters

    Parameters

    Returns Promise<OutputType>

  • Type Parameters

    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

  • Type Parameters

    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

Settings

Member Visibility

Theme