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

    Class AwsApiGatewayTools

    Tools-style AWS API Gateway wrapper (REST APIs).

    Consumers should typically use the convenience methods on this class, and use AwsApiGatewayTools.client as an escape hatch when they need AWS SDK operations not wrapped here.

    Implements

    Index
    constructor
    client clientConfig logger xray
    flushStageCache flushStageCacheByName getApiKeyValuesByNames listApiKeys listRestApis
    client: APIGatewayClient

    The effective SDK client (captured when X-Ray is enabled).

    Import AWS SDK *Command classes as needed and call tools.client.send(...).

    clientConfig: APIGatewayClientConfig

    The effective client config used to construct the base client.

    Note: this may contain functions/providers (e.g., credential providers).

    logger: Logger

    The logger used by this wrapper and (when applicable) by the AWS client.

    xray: XrayState

    Materialized X-Ray state (mode + enabled + daemonAddress when relevant).

    • Flush stage cache for a known REST API id.

      Parameters

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

      Returns Promise<void>

    • Convenience: retrieve API key values by names (strict missing/ambiguous errors).

      Parameters

      • opts: { keyNames: string[] }

      Returns Promise<string[]>

    • List API keys (paginated).

      Parameters

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

        Query options (nameQuery + includeValues).

      Returns Promise<ApiKeySummary[]>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods