@karmaniverous/aws-api-gateway-tools
    Preparing search index...

    Type Alias ApiGatewayPort

    Small, testable port for the API Gateway operations used by this repo.

    Implementations may paginate internally and return full arrays.

    type ApiGatewayPort = {
        flushStageCache(
            opts: { restApiId: string; stageName: string },
        ): Promise<void>;
        listApiKeys(
            opts: { includeValues: boolean; limit?: number; nameQuery: string },
        ): Promise<ApiKeySummary[]>;
        listRestApis(opts?: { limit?: number }): Promise<RestApiSummary[]>;
    }

    Implemented by

    Index
    flushStageCache listApiKeys listRestApis

    • Flush the cache for a specific REST API stage.

      Parameters

      • opts: { restApiId: string; stageName: string }

      Returns Promise<void>

    • List API keys matching a name query, including values. Implementations should return all items (paginate internally).

      Parameters

      • opts: { includeValues: boolean; limit?: number; nameQuery: string }

      Returns Promise<ApiKeySummary[]>

    Settings
    Member Visibility

    On This Page
    Methods