Skip to content

GetApiKey

Source: src/AWS/ApiGateway/GetApiKey.ts

Runtime binding for reading a single API Gateway API key (apigateway:GET on /apikeys/{id}). Account-scoped — takes no resource.

With includeValue: true the response’s value is Redacted<string>. Provide ApiGateway.GetApiKeyHttp on the Function effect to implement the binding.

// init
const getApiKey = yield* ApiGateway.GetApiKey();
// runtime
const key = yield* getApiKey({ apiKey: keyId });