Interface TextractClientConfig

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

interface TextractClientConfig {
    cacheMiddleware?: boolean;
    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
    customUserAgent?: string | UserAgent;
    defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
    disableHostPrefix?: boolean;
    endpoint?: (string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>) & (string | Provider<string> | Endpoint | Provider<...> | EndpointV2 | Provider<...>);
    endpointProvider?: ((params, context?) => EndpointV2);
    extensions?: RuntimeExtension[];
    logger?: Logger;
    maxAttempts?: number | Provider<number>;
    region?: string | Provider<string>;
    requestHandler?: (NodeHttpHandlerOptions | FetchHttpHandlerOptions | Record<string, unknown> | RequestHandler<any, any, HttpHandlerOptions>) & HttpHandlerUserInput;
    retryMode?: string | Provider<string>;
    retryStrategy?: RetryStrategy | RetryStrategyV2;
    signer?: RequestSigner | ((authScheme?) => Promise<RequestSigner>);
    signingEscapePath?: boolean;
    signingRegion?: string;
    systemClockOffset?: number;
    tls?: boolean;
    useDualstackEndpoint?: boolean | Provider<boolean>;
    useFipsEndpoint?: boolean | Provider<boolean>;
}

Hierarchy (view full)

Properties

cacheMiddleware? credentials? customUserAgent? defaultsMode? disableHostPrefix? endpoint? endpointProvider? extensions? logger? maxAttempts? region? requestHandler? retryMode? retryStrategy? signer? signingEscapePath? signingRegion? systemClockOffset? tls? useDualstackEndpoint? useFipsEndpoint?

Properties

Optional cacheMiddleware

cacheMiddleware?: boolean

Default false.

When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be recognized.

Calling client.destroy() also clears this cache.

Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.

Optional credentials

credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

The credentials used to sign requests.

Optional customUserAgent

customUserAgent?: string | UserAgent

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

Optional defaultsMode

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.

Optional disableHostPrefix

disableHostPrefix?: boolean

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

Optional endpoint

endpoint?: (string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>) & (string | Provider<string> | Endpoint | Provider<...> | EndpointV2 | Provider<...>)

The fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).

Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.

Optional endpointProvider

endpointProvider?: ((params, context?) => EndpointV2)

Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.

Type declaration

    • (params, context?): EndpointV2

    • Providing a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.

      Parameters

      Returns EndpointV2

Optional extensions

extensions?: RuntimeExtension[]

Optional extensions

Optional logger

logger?: Logger

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

Optional maxAttempts

maxAttempts?: number | Provider<number>

Value for how many times a request will be made at most in case of retry.

Optional region

region?: string | Provider<string>

The AWS region to which this client will send requests

Optional requestHandler

requestHandler?: (NodeHttpHandlerOptions | FetchHttpHandlerOptions | Record<string, unknown> | RequestHandler<any, any, HttpHandlerOptions>) & HttpHandlerUserInput

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

Optional retryMode

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/

Optional retryStrategy

retryStrategy?: RetryStrategy | RetryStrategyV2

The strategy to retry the request. Using built-in exponential backoff strategy by default.

Optional signer

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

The signer to use when signing requests.

Type declaration

Optional signingEscapePath

signingEscapePath?: boolean

Whether to escape request path when signing the request.

Optional signingRegion

signingRegion?: string

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

Optional systemClockOffset

systemClockOffset?: number

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

Optional tls

tls?: boolean

Whether TLS is enabled for requests.

Deprecated

Optional useDualstackEndpoint

useDualstackEndpoint?: boolean | Provider<boolean>

Enables IPv6/IPv4 dualstack endpoint.

Optional useFipsEndpoint

useFipsEndpoint?: boolean | Provider<boolean>

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme

On This Page