Interface Apiv2ClientConfig

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

interface Apiv2ClientConfig {
    apiVersion?: string;
    authSchemePreference?: string[] | Provider<string[]>;
    base64Decoder?: Decoder;
    base64Encoder?: Encoder;
    bodyLengthChecker?: BodyLengthCalculator;
    cacheMiddleware?: boolean;
    customUserAgent?: string | UserAgent;
    defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
    defaultUserAgentProvider?: Provider<UserAgent>;
    disableHostPrefix?: boolean;
    endpoint?: string | Endpoint | Provider<Endpoint>;
    extensions?: RuntimeExtension[];
    httpAuthSchemeProvider?: Apiv2HttpAuthSchemeProvider;
    httpAuthSchemes?: HttpAuthScheme[];
    logger?: Logger;
    maxAttempts?: number | Provider<number>;
    profile?: string;
    region?: string | Provider<string>;
    regionInfoProvider?: RegionInfoProvider;
    requestHandler?: (RequestHandler<any, any, HttpHandlerOptions> | NodeHttpHandlerOptions | FetchHttpHandlerOptions | Record<...>) & HttpHandlerUserInput;
    retryMode?: string | Provider<string>;
    retryStrategy?: RetryStrategy | RetryStrategyV2;
    runtime?: string;
    serviceId?: string;
    sha256?: ChecksumConstructor | HashConstructor;
    streamCollector?: StreamCollector;
    tls?: boolean;
    token?: TokenIdentity | TokenIdentityProvider;
    urlParser?: UrlParser;
    useDualstackEndpoint?: boolean | Provider<boolean>;
    useFipsEndpoint?: boolean | Provider<boolean>;
    userAgentAppId?: string | Provider<undefined | string>;
    utf8Decoder?: Decoder;
    utf8Encoder?: Encoder;
}

Hierarchy (View Summary)

Properties

apiVersion? authSchemePreference? base64Decoder? base64Encoder? bodyLengthChecker? cacheMiddleware? customUserAgent? defaultsMode? defaultUserAgentProvider? disableHostPrefix? endpoint? extensions? httpAuthSchemeProvider? httpAuthSchemes? logger? maxAttempts? profile? region? regionInfoProvider? requestHandler? retryMode? retryStrategy? runtime? serviceId? sha256? streamCollector? tls? token? urlParser? useDualstackEndpoint? useFipsEndpoint? userAgentAppId? utf8Decoder? utf8Encoder?

Properties

Optional Readonly InternalapiVersion

apiVersion?: string

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

OptionalauthSchemePreference

authSchemePreference?: string[] | Provider<string[]>

A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

Optional Internalbase64Decoder

base64Decoder?: Decoder

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

Optional Internalbase64Encoder

base64Encoder?: Encoder

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

Optional InternalbodyLengthChecker

bodyLengthChecker?: BodyLengthCalculator

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

OptionalcacheMiddleware

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.

OptionalcustomUserAgent

customUserAgent?: string | UserAgent

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

OptionaldefaultsMode

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 InternaldefaultUserAgentProvider

defaultUserAgentProvider?: Provider<UserAgent>

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

OptionaldisableHostPrefix

disableHostPrefix?: boolean

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

Optionalendpoint

endpoint?: string | Endpoint | Provider<Endpoint>

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

Optionalextensions

extensions?: RuntimeExtension[]

Optional extensions

Optional InternalhttpAuthSchemeProvider

httpAuthSchemeProvider?: Apiv2HttpAuthSchemeProvider

Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

Optional InternalhttpAuthSchemes

httpAuthSchemes?: HttpAuthScheme[]

Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

Optionallogger

logger?: Logger

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

OptionalmaxAttempts

maxAttempts?: number | Provider<number>

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

Optionalprofile

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.

Optionalregion

region?: string | Provider<string>

The AWS region to which this client will send requests

Optional InternalregionInfoProvider

regionInfoProvider?: RegionInfoProvider

Fetch related hostname, signing name or signing region with given region.

OptionalrequestHandler

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

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

OptionalretryMode

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/

OptionalretryStrategy

retryStrategy?: RetryStrategy | RetryStrategyV2

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

Optional Internalruntime

runtime?: string

The runtime environment.

Optional InternalserviceId

serviceId?: string

Unique service identifier.

Optional Internalsha256

sha256?: ChecksumConstructor | HashConstructor

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.

Optional InternalstreamCollector

streamCollector?: StreamCollector

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

Optionaltls

tls?: boolean

Whether TLS is enabled for requests.

Optionaltoken

token?: TokenIdentity | TokenIdentityProvider

The token used to authenticate requests.

Optional InternalurlParser

urlParser?: UrlParser

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

OptionaluseDualstackEndpoint

useDualstackEndpoint?: boolean | Provider<boolean>

Enables IPv6/IPv4 dualstack endpoint.

OptionaluseFipsEndpoint

useFipsEndpoint?: boolean | Provider<boolean>

Enables FIPS compatible endpoints.

OptionaluserAgentAppId

userAgentAppId?: string | Provider<undefined | string>

The application ID used to identify the application.

Optional Internalutf8Decoder

utf8Decoder?: Decoder

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

Optional Internalutf8Encoder

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