available_resource_metrics
Creates, updates, deletes, gets or lists an available_resource_metrics resource.
Overview
| Name | available_resource_metrics |
| Type | Resource |
| Id | aws.pi.available_resource_metrics |
Fields
The following fields are returned by SELECT queries:
- list_available_resource_metrics
| Name | Datatype | Description |
|---|---|---|
metrics | array | An array of metrics available to query. Each array element contains the full name, description, and unit of the metric. |
next_token | string | A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the previous request. To get the remaining records, specify NextToken in a separate request with this value. (pattern: <code>^[a-zA-Z0-9_=-]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_available_resource_metrics | select | region | Retrieve metrics of the specified types that can be queried for a specified DB instance. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_available_resource_metrics
Retrieve metrics of the specified types that can be queried for a specified DB instance.
SELECT
metrics,
next_token
FROM aws.pi.available_resource_metrics
WHERE region = '{{ region }}' -- required
;