Data and helper objects that are not expected to change from one execution of a composed handler to another.

interface HandlerExecutionContext {
    authSchemes?: AuthScheme[];
    clientName?: string;
    commandName?: string;
    currentAuthConfig?: HttpAuthDefinition;
    dynamoDbDocumentClientOptions?: Partial<{
        overrideInputFilterSensitiveLog(...args): string | void;
        overrideOutputFilterSensitiveLog(...args): string | void;
    }>;
    endpointV2?: EndpointV2;
    logger?: Logger;
    userAgent?: UserAgent;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

authSchemes?: AuthScheme[]

Set at the same time as endpointV2.

clientName?: string

Name of the service the operation is being sent to.

commandName?: string

Name of the operation being executed.

currentAuthConfig?: HttpAuthDefinition

The current auth configuration that has been set by any auth middleware and that will prevent from being set more than once.

dynamoDbDocumentClientOptions?: Partial<{
    overrideInputFilterSensitiveLog(...args): string | void;
    overrideOutputFilterSensitiveLog(...args): string | void;
}>

Used by DynamoDbDocumentClient.

Type declaration

  • overrideInputFilterSensitiveLog:function
    • Parameters

      • Rest ...args: any[]

      Returns string | void

  • overrideOutputFilterSensitiveLog:function
    • Parameters

      • Rest ...args: any[]

      Returns string | void

endpointV2?: EndpointV2

Resolved by the endpointMiddleware function of @smithy/middleware-endpoint in the serialization stage.

logger?: Logger

A logger that may be invoked by any handler during execution of an operation.

userAgent?: UserAgent

Additional user agent that inferred by middleware. It can be used to save the internal user agent sections without overriding the customUserAgent config in clients.