The resolved configuration interface of RekognitionClient class. This is resolved and normalized from the constructor configuration interface.

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

Hierarchy (view full)

Properties

Resolved value for input config AwsAuthInputConfig.credentials This provider MAY memoize the loaded credentials for certain period. See MemoizedProvider for more information.

customUserAgent?: UserAgent

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

defaultSigningName: string

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.

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

Custom endpoint provided by the user. This is normalized to a single interface from the various acceptable types. This field will be undefined if a custom endpoint is not provided.

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

Type declaration

extensions: RuntimeExtension[]

Optional extensions

logger: Logger

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

maxAttempts: Provider<number> | number & Provider<number>

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

region: (string | Provider<string>) & Provider<string> & (undefined | string | Provider<string>)

The AWS region to which this client will send requests

requestHandler: RequestHandler<any, any, HttpHandlerOptions> & HttpHandler & RequestHandler<any, any, {}>

The HTTP handler to use. Fetch in browser and Https in Nodejs.

retryMode: string | Provider<string>

Specifies which retry algorithm to use.

Resolved value for input config RetryInputConfig.retryStrategy

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

Resolved value for input config AwsAuthInputConfig.signer

Type declaration

signingEscapePath: boolean

Resolved value for input config AwsAuthInputConfig.signingEscapePath

systemClockOffset: number

Resolved value for input config AwsAuthInputConfig.systemClockOffset

tls: boolean

Whether TLS is enabled for requests.

Deprecated

useDualstackEndpoint: (boolean | Provider<boolean>) & Provider<boolean> & (undefined | boolean | Provider<boolean>)

Enables IPv6/IPv4 dualstack endpoint.

useFipsEndpoint: (boolean | Provider<boolean>) & Provider<boolean> & (undefined | boolean | Provider<boolean>)

Enables FIPS compatible endpoints.