Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface TimestreamQueryClientConfig

The configuration interface of TimestreamQueryClient class constructor that set the region, credentials and other options.



credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>

The credentials used to sign requests.

customUserAgent?: string | UserAgent

The custom user agent header that would be appended to default one

defaultsMode?: 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?: boolean

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

endpointCacheSize?: number

The size of the client cache storing endpoints from endpoint discovery operations. Defaults to 1000.

endpointDiscoveryEnabled?: boolean

Whether to call operations with endpoints given by service dynamically. Setting this config to true will enable endpoint discovery for all applicable operations. Setting it to false will explicitly disable endpoint discovery even though operations that require endpoint discovery will presumably fail. Leaving it to undefined means SDK only do endpoint discovery when it's required. Defaults to undefined.

extensions?: RuntimeExtension[]

Optional extensions

logger?: Logger

Optional logger for logging debug/info/warn/error.

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

signer?: RequestSigner | ((authScheme?: AuthScheme) => Promise<RequestSigner>)

The signer to use when signing requests.

signingEscapePath?: boolean

Whether to escape request path when signing the request.

signingRegion?: string

The region where you want to sign your request against. This can be different to the region in the endpoint.

systemClockOffset?: number

An offset value in milliseconds to apply to all signing times.