Performance Insights Get Resource Metrics
Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
External Documentation
To learn more, visit the AWS documentation.
Basic Parameters
Parameter | Description |
---|---|
AWS Region(s) | Enter the desired AWS Region(s). To execute the action in multiple regions, provide a comma-separated list. For example: us-east-1,eu-west-2 .If you wish to run the action in all available regions, use the asterisk symbol ( * ) instead. |
End Time | The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned. The value for EndTime must be later than the value for StartTime. |
Identifier | An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A . |
Metric Queries | An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria. |
Service Type | The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS . |
Start Time | The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned. The value for StartTime must be earlier than the value for EndTime. |
Advanced Parameters
Parameter | Description |
---|---|
Disable XML To JSON Auto Convert | When checked, XML responses are not automatically converted into JSON format. |
Max Results | The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved. |
Next Token | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords. |
Period In Seconds | The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are: 1 (one second) 60 (one minute) 300 (five minutes) 3600 (one hour) * 86400 (twenty-four hours) If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response. |
Example Output
{
"AlignedEndTime": "date-time",
"AlignedStartTime": "date-time",
"Identifier": ".*\\S.*",
"MetricList": [
{
"DataPoints": [
{
"Timestamp": "date-time",
"Value": 0
}
],
"Key": {
"Dimensions": {},
"Metric": ".*\\S.*"
}
}
],
"NextToken": "[\\s\\S]*"
}
Automation Library Example
Performance Insights Get Resource Metrics with Aws and Send Results Via Email
Preview this Automation on desktop