Client | rbin Client - AWS SDK for JavaScript v3

A general interface for service clients, idempotent to browser or node clients This type corresponds to SmithyClient(https://github.com/aws/aws-sdk-js-v3/blob/main/packages/smithy-client/src/client.ts). It's provided for using without importing the SmithyClient class.

Type parameters

Input: object
Output: MetadataBearer
ResolvedClientConfiguration
HandlerOptions
ClientInput: object
ClientOutput: MetadataBearer
ResolvedClientConfiguration: SmithyResolvedConfiguration<HandlerOptions>

Hierarchy

Client

Implements

Client<ClientInput, ClientOutput, ResolvedClientConfiguration>

Implemented by

Index

Constructors

constructor

Properties

Constructors

constructor

new Client(config: ResolvedClientConfiguration): Client

- Defined in packages/smithy-client/dist-types/client.d.ts:14
Parameters
- config: ResolvedClientConfiguration
Returns Client

Properties

Readonly config

config: ResolvedClientConfiguration

destroy

destroy(): void

- Defined in packages/smithy-client/dist-types/client.d.ts:19
Returns void

middlewareStack

middlewareStack: MiddlewareStack<ClientInput, ClientOutput>

send

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

- Defined in packages/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ClientInput
- OutputType: ClientOutput
Parameters
- command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
- Defined in packages/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ClientInput
- OutputType: ClientOutput
Parameters
- command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
- Defined in packages/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ClientInput
- OutputType: ClientOutput
Parameters
- command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>>
- options: HandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

Type parameters

Input: object

Output: MetadataBearer

ResolvedClientConfiguration

HandlerOptions

ClientInput: object

ClientOutput: MetadataBearer

ResolvedClientConfiguration: SmithyResolvedConfiguration<HandlerOptions>

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Constructors

constructor

Parameters

config: ResolvedClientConfiguration

Returns Client

Properties

Readonly config

destroy

Returns void

middlewareStack

send

Type parameters

InputType: ClientInput

OutputType: ClientOutput

Parameters

command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>>

Optional options: HandlerOptions

Returns Promise<OutputType>

Type parameters

InputType: ClientInput

OutputType: ClientOutput

Parameters

command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>>

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

Parameters

err: any

Optional data: OutputType

Returns void

Returns void

Type parameters

InputType: ClientInput

OutputType: ClientOutput

Parameters

command: Command<ClientInput, InputType, ClientOutput, OutputType, SmithyResolvedConfiguration<HandlerOptions>>

options: HandlerOptions

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

Parameters

err: any

Optional data: OutputType

Returns void

Returns void