API Reference
    Preparing search index...

    Type Alias IdempotencyConfigOptions

    Idempotency configuration options

    type IdempotencyConfigOptions = {
        eventKeyJmesPath?: string;
        expiresAfterSeconds?: number;
        hashFunction?: string;
        jmesPathOptions?: Functions;
        lambdaContext?: Context;
        maxLocalCacheSize?: number;
        payloadValidationJmesPath?: string;
        responseHook?: ResponseHook;
        throwOnNoIdempotencyKey?: boolean;
        useLocalCache?: boolean;
    }
    Index

    Properties

    eventKeyJmesPath? expiresAfterSeconds? hashFunction? jmesPathOptions? lambdaContext? maxLocalCacheSize? payloadValidationJmesPath? responseHook? throwOnNoIdempotencyKey? useLocalCache?

    Properties

    eventKeyJmesPath?: string

    An optional JMESPath expression to extract the idempotency key from the event record

    expiresAfterSeconds?: number

    The number of seconds to wait before a record is expired, defaults to 3600 (1 hour)

    hashFunction?: string

    Function to use for calculating hashes, defaults to md5

    jmesPathOptions?: Functions

    Custom JMESPath functions to use when parsing the JMESPath expressions

    lambdaContext?: Context

    AWS Lambda Context object containing information about the current invocation, function, and execution environment

    maxLocalCacheSize?: number

    Number of records to keep in the local cache, defaults to 256

    payloadValidationJmesPath?: string

    An optional JMESPath expression to extract the payload to be validated from the event record

    responseHook?: ResponseHook

    A hook that runs when an idempotent request is made

    throwOnNoIdempotencyKey?: boolean

    Throw an error if no idempotency key was found in the request, defaults to false

    useLocalCache?: boolean

    Wheter to locally cache idempotency results, defaults to false

    Settings

    Member Visibility

    On This Page

    Properties