ts-lambda-api - v2.5.2
    Preparing search index...

    Interface ClientDefaults

    interface ClientDefaults {
        apiVersion?: string;
        base64Decoder?: Decoder;
        base64Encoder?: Encoder;
        bodyLengthChecker?: BodyLengthCalculator;
        cacheMiddleware?: boolean;
        credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
        defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
        defaultUserAgentProvider?: Provider<UserAgent>;
        disableHostPrefix?: boolean;
        eventStreamSerdeProvider?: EventStreamSerdeProvider;
        extensions?: RuntimeExtension[];
        getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
        logger?: Logger;
        maxAttempts?: number | Provider<number>;
        md5?: HashConstructor | ChecksumConstructor;
        profile?: string;
        region?: string | Provider<string>;
        requestHandler?: HttpHandlerUserInput;
        retryMode?: string | Provider<string>;
        runtime?: string;
        sdkStreamMixin?: SdkStreamMixinInjector;
        serviceId?: string;
        sha1?: HashConstructor | ChecksumConstructor;
        sha256?: HashConstructor | ChecksumConstructor;
        signingEscapePath?: boolean;
        streamCollector?: StreamCollector;
        streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
        urlParser?: UrlParser;
        useArnRegion?: boolean | Provider<boolean>;
        useDualstackEndpoint?: boolean | Provider<boolean>;
        useFipsEndpoint?: boolean | Provider<boolean>;
        utf8Decoder?: Decoder;
        utf8Encoder?: Encoder;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiVersion? base64Decoder? base64Encoder? bodyLengthChecker? cacheMiddleware? credentialDefaultProvider? defaultsMode? defaultUserAgentProvider? disableHostPrefix? eventStreamSerdeProvider? extensions? getAwsChunkedEncodingStream? logger? maxAttempts? md5? profile? region? requestHandler? retryMode? runtime? sdkStreamMixin? serviceId? sha1? sha256? signingEscapePath? streamCollector? streamHasher? urlParser? useArnRegion? useDualstackEndpoint? useFipsEndpoint? utf8Decoder? utf8Encoder?

    Properties

    apiVersion?: string

    The API version set internally by the SDK, and is not planned to be used by customer code.

    base64Decoder?: Decoder

    The function that will be used to convert a base64-encoded string to a byte array.

    base64Encoder?: Encoder

    The function that will be used to convert binary data to a base64-encoded string.

    bodyLengthChecker?: BodyLengthCalculator

    A function that can calculate the length of a request body.

    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.

    credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider

    Default credentials provider; Not available in browser runtime.

    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.

    defaultUserAgentProvider?: Provider<UserAgent>

    The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

    disableHostPrefix?: boolean

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

    eventStreamSerdeProvider?: EventStreamSerdeProvider

    The function that provides necessary utilities for generating and parsing event stream

    extensions?: RuntimeExtension[]

    Optional extensions

    getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream

    A function that returns Readable Stream which follows aws-chunked encoding stream.

    logger?: Logger

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

    maxAttempts?: number | Provider<number>

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

    md5?: HashConstructor | ChecksumConstructor

    A constructor for a class implementing the __Checksum interface that computes MD5 hashes.

    profile?: string

    Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

    When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.

    For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

    region?: string | Provider<string>

    The AWS region to which this client will send requests

    requestHandler?: HttpHandlerUserInput

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

    retryMode?: string | Provider<string>

    Specifies which retry algorithm to use.

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

    runtime?: string

    The runtime environment.

    sdkStreamMixin?: SdkStreamMixinInjector

    The internal function that inject utilities to runtime-specific stream to help users consume the data

    serviceId?: string

    Unique service identifier.

    sha1?: HashConstructor | ChecksumConstructor

    A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.

    sha256?: HashConstructor | ChecksumConstructor

    A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

    signingEscapePath?: boolean

    Whether to escape request path when signing the request.

    streamCollector?: StreamCollector

    A function that converts a stream into an array of bytes.

    streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>

    A function that, given a hash constructor and a stream, calculates the hash of the streamed value.

    urlParser?: UrlParser

    The function that will be used to convert strings into HTTP endpoints.

    useArnRegion?: boolean | Provider<boolean>

    Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

    useDualstackEndpoint?: boolean | Provider<boolean>

    Enables IPv6/IPv4 dualstack endpoint.

    useFipsEndpoint?: boolean | Provider<boolean>

    Enables FIPS compatible endpoints.

    utf8Decoder?: Decoder

    The function that will be used to convert a UTF8-encoded string to a byte array.

    utf8Encoder?: Encoder

    The function that will be used to convert binary data to a UTF-8 encoded string.

    Settings

    Member Visibility

    On This Page

    Properties