Class AwsApiGatewayTools

constructor

• new AwsApiGatewayTools(
      __namedParameters?: AwsApiGatewayToolsOptions,
  ): AwsApiGatewayTools

  Construct an AwsApiGatewayTools instance.

  Parameters

  • __namedParameters: AwsApiGatewayToolsOptions = {}

  Returns AwsApiGatewayTools

  Throws

  If clientConfig.logger is provided but does not implement debug, info, warn, and error.

  Throws

  If X-Ray capture is enabled (via xray: 'on' or xray: 'auto' with AWS_XRAY_DAEMON_ADDRESS set) but aws-xray-sdk is not installed.

  Throws

  If X-Ray capture is requested but AWS_XRAY_DAEMON_ADDRESS is not set.

Readonlyclient

ReadonlyclientConfig

Readonlylogger

Readonlyxray

flushStageCache

• flushStageCache(opts: { restApiId: string; stageName: string }): Promise<void>

  Flush stage cache for a known REST API id.

  Parameters

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

  Returns Promise<void>

flushStageCacheByName

• flushStageCacheByName(
      opts: { apiName: string; stageName: string },
  ): Promise<FlushStageCacheByNameResult>

  Convenience: resolve REST API id by name and flush stage cache.

  Parameters

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

  Returns Promise<FlushStageCacheByNameResult>

  The resolved REST API id.

getApiKeyValuesByNames

• getApiKeyValuesByNames(opts: { keyNames: string[] }): Promise<string[]>

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

  Parameters

  • opts: { keyNames: string[] }

  Returns Promise<string[]>

listApiKeys

• listApiKeys(
      opts: { includeValues: boolean; limit?: number; nameQuery: string },
  ): Promise<ApiKeySummary[]>

  List API keys (paginated).

  Parameters

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

    Query options (nameQuery + includeValues).

  Returns Promise<ApiKeySummary[]>

listRestApis

• listRestApis(opts?: { limit?: number }): Promise<RestApiSummary[]>

  List REST APIs (paginated).

  Parameters

  • Optionalopts: { limit?: number }

  Returns Promise<RestApiSummary[]>