Interface HandlerExecutionContext

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

Deprecated

Do not assign arbitrary members to the context, since they can interfere with existing functionality.

Additional members should instead be declared on the SMITHY_CONTEXT_KEY or other reserved keys.

Properties

authSchemes? clientName? commandName? currentAuthConfig? dynamoDbDocumentClientOptions? endpointV2? logger? userAgent?

Properties

Optional authSchemes

authSchemes?: AuthScheme[]

Set at the same time as endpointV2.

Optional clientName

clientName?: string

Name of the service the operation is being sent to.

Optional commandName

commandName?: string

Name of the operation being executed.

Optional currentAuthConfig

currentAuthConfig?: HttpAuthDefinition

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

Optional dynamoDbDocumentClientOptions

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

Type declaration

  • overrideInputFilterSensitiveLog:function
    • overrideInputFilterSensitiveLog(...args): string | void

    • Parameters

      • Rest ...args: any[]

      Returns string | void

  • overrideOutputFilterSensitiveLog:function
    • overrideOutputFilterSensitiveLog(...args): string | void

    • Parameters

      • Rest ...args: any[]

      Returns string | void

Deprecated

do not extend this field, it is a carryover from AWS SDKs. Used by DynamoDbDocumentClient.

Optional endpointV2

endpointV2?: EndpointV2

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

Optional logger

logger?: Logger

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

Optional userAgent

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.

Settings

Member Visibility

Theme

On This Page