usage_plans_list_only

Lists usage_plans in a region or regions, for all properties use usage_plans

Overview

Name	usage_plans_list_only
Type	Resource
Description	The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide*. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
Id	aws.apigateway.usage_plans_list_only

Fields

Name	Datatype	Description
id	string
api_stages	array	The associated API stages of a usage plan.
description	string	The description of a usage plan.
quota	object	The target maximum number of permitted requests per a given unit time interval.
tags	array	The collection of tags. Each tag element is associated with a given resource.
throttle	object	A map containing method level throttling information for API stage in a usage plan.
usage_plan_name	string	The name of a usage plan.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all usage_plans in a region.

SELECT
region,
id
FROM aws.apigateway.usage_plans_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the usage_plans_list_only resource, see usage_plans