| Column Name | Column Data Type |
|---|
end_time Required Input Column
The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime. The value for EndTime must be later than the value for StartTime. | TIMESTAMP_S |
identifier Required Input Column
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId. | VARCHAR |
metric_queries Required Input Column
An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum. | STRUCT(
"metric" VARCHAR,
"group_by" STRUCT(
"group" VARCHAR,
"dimensions" VARCHAR[],
"limit" BIGINT
),
"filter" MAP(VARCHAR, VARCHAR)
)[] |
Show child fields- metric_queries[]
Show child fields- metric_queries[].filter
One or more filters to apply in the request. Restrictions: -
Any number of filters by the same dimension, as specified in the GroupBy parameter. -
A single filter for any other dimension in this dimension group. The db.sql.db_id filter isn't available for RDS for SQL Server DB instances. - metric_queries[].group_by
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension. Show child fields- metric_queries[].group_by.dimensions[]
- metric_queries[].group_by.group
The name of the dimension group. Valid values are as follows: -
db - The name of the database to which the client is connected. The following values are permitted: -
Aurora PostgreSQL -
Amazon RDS PostgreSQL -
Aurora MySQL -
Amazon RDS MySQL -
Amazon RDS MariaDB -
Amazon DocumentDB -
db.application - The name of the application that is connected to the database. The following values are permitted: -
Aurora PostgreSQL -
Amazon RDS PostgreSQL -
Amazon DocumentDB -
db.host - The host name of the connected client (all engines). -
db.query - The query that is currently running (only Amazon DocumentDB). -
db.query_tokenized - The digest query (only Amazon DocumentDB). -
db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL). -
db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB). -
db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB). -
db.user - The user logged in to the database (all engines except Amazon DocumentDB). -
db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB). -
db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB). -
db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB). - metric_queries[].group_by.limit
The maximum number of items to fetch for this dimension group.
- metric_queries[].metric
The name of a Performance Insights metric to be measured. Valid values for Metric are: If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
|
service_type Required Input Column
The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows: | VARCHAR |
start_time Required Input Column
The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime. The value for StartTime must be earlier than the value for EndTime. | TIMESTAMP_S |
max_results Input Column
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. | BIGINT |
next_token Input Column
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. | VARCHAR |
period_alignment Input Column
The returned timestamp which is the start or end time of the time periods. The default value is END_TIME. | VARCHAR |
period_in_seconds Input Column
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: 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. | BIGINT |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
aligned_end_time
The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime. | TIMESTAMP_S |
aligned_start_time
The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime. | TIMESTAMP_S |
metric_list
An array of metric results, where each array element contains all of the data points for a particular dimension. | STRUCT(
"key" STRUCT(
"metric" VARCHAR,
"dimensions" MAP(VARCHAR, VARCHAR)
),
"data_points" STRUCT(
"timestamp" TIMESTAMP_S,
"value" DOUBLE
)[]
)[] |
Show child fields- metric_list[]
Show child fields- metric_list[].data_points[]
Show child fields- metric_list[].data_points[].timestamp
The time, in epoch format, associated with a particular Value. - metric_list[].data_points[].value
The actual value associated with a particular Timestamp.
- metric_list[].key
The dimensions to which the data points apply. Show child fields- metric_list[].key.dimensions
The valid dimensions for the metric. - metric_list[].key.metric
The name of a Performance Insights metric to be measured. Valid values for Metric are: If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
|