Skip to content

DeleteApiKey

Source: src/AWS/ApiGateway/DeleteApiKey.ts

Runtime binding for deleting an API Gateway API key (apigateway:DELETE on /apikeys/{id}). Account-scoped — takes no resource.

Provide ApiGateway.DeleteApiKeyHttp on the Function effect to implement the binding.

// init
const deleteApiKey = yield* ApiGateway.DeleteApiKey();
// runtime
yield* deleteApiKey({ apiKey: keyId }).pipe(
Effect.catchTag("NotFoundException", () => Effect.void),
);