api_keys_list_only

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

Overview

Name	`api_keys_list_only`
Type	Resource
Description	The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.
Id	`aws.apigateway.api_keys_list_only`

Name	Datatype	Description
`api_key_id`	`string`
`customer_id`	`string`	An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
`description`	`string`	The description of the ApiKey.
`enabled`	`boolean`	Specifies whether the ApiKey can be used by callers.
`generate_distinct_id`	`boolean`	Specifies whether (`true`) or not (`false`) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
`name`	`string`	A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
`stage_keys`	`array`	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
`tags`	`array`	The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.
`value`	`string`	Specifies a value of the API key.
`region`	`string`	AWS region.

Name	Accessible by	Required Params
`list_resources`	`SELECT`	`region`

Lists all api_keys in a region.

SELECT
region,
api_key_id
FROM aws.apigateway.api_keys_list_only
WHERE region = 'us-east-1';

For permissions required to operate on the api_keys_list_only resource, see api_keys