metrics
Creates, updates, deletes, gets or lists a metrics resource.
Overview
| Name | metrics |
| Type | Resource |
| Id | aws.resiliencehub.metrics |
Fields
The following fields are returned by SELECT queries:
- list_metrics
| Name | Datatype | Description |
|---|---|---|
row | array | Specifies all the list of metric values for each row of metrics. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_metrics | select | region | Lists the metrics that can be exported. | |
start_metrics_export | exec | region | Initiates the export task of metrics. |
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_metrics
Lists the metrics that can be exported.
SELECT
row
FROM aws.resiliencehub.metrics
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- start_metrics_export
Initiates the export task of metrics.
EXEC aws.resiliencehub.metrics.start_metrics_export
@region='{{ region }}' --required
@@json=
'{
"bucketName": "{{ bucketName }}",
"clientToken": "{{ clientToken }}"
}'
;