AWS Performance Insights 2018-02-27
- Client: Aws\PI\PIClient
- Service ID: pi
- Version: 2018-02-27
This page describes the parameters and results for the operations of the AWS Performance Insights (2018-02-27), and shows how to use the Aws\PI\PIClient object to call the described operations. This documentation is specific to the 2018-02-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- DescribeDimensionKeys ( array $params = [] )
For a specific time period, retrieve the top N dimension keys for a metric.
- GetResourceMetrics ( array $params = [] )
Retrieve Performance Insights metrics for a set of data sources, over a time period.
Operations
DescribeDimensionKeys
$result = $client->describeDimensionKeys
([/* ... */]); $promise = $client->describeDimensionKeysAsync
([/* ... */]);
For a specific time period, retrieve the top N
dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Parameter Syntax
$result = $client->describeDimensionKeys([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'Filter' => ['<string>', ...], 'GroupBy' => [ // REQUIRED 'Dimensions' => ['<string>', ...], 'Group' => '<string>', // REQUIRED 'Limit' => <integer>, ], 'Identifier' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'Metric' => '<string>', // REQUIRED 'NextToken' => '<string>', 'PartitionBy' => [ 'Dimensions' => ['<string>', ...], 'Group' => '<string>', // REQUIRED 'Limit' => <integer>, ], 'PeriodInSeconds' => <integer>, 'ServiceType' => 'RDS', // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to)
EndTime
are returned.The value for
EndTime
must be later than the value forStartTime
. - Filter
-
- Type: Associative array of custom strings keys (String) to strings
One or more filters to apply in the request. Restrictions:
-
Any number of filters by the same dimension, as specified in the
GroupBy
orPartition
parameters. -
A single filter for any other dimension in this dimension group.
- GroupBy
-
- Required: Yes
- Type: DimensionGroup structure
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
- Identifier
-
- Required: Yes
- Type: string
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its
DbiResourceId
value. For example, specifydb-FAIHNTYBKTGAUSUZQYPDS2GW4A
- MaxResults
-
- Type: int
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. - Metric
-
- Required: Yes
- Type: string
The name of a Performance Insights metric to be measured.
Valid values for
Metric
are:-
db.load.avg
- a scaled representation of the number of active sessions for the database engine. -
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.load.avg
only. - NextToken
-
- Type: string
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
. - PartitionBy
-
- Type: DimensionGroup structure
For each dimension specified in
GroupBy
, specify a secondary dimension to further subdivide the partition keys in the response. - PeriodInSeconds
-
- Type: int
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 chooses a value for you, with a goal of returning roughly 100-200 data points in the response. - ServiceType
-
- Required: Yes
- Type: string
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is
RDS
. - StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time specifying the beginning of the requested time series data. You must specify a
StartTime
within the past 7 days. The value specified is inclusive, which means that data points equal to or greater thanStartTime
are returned.The value for
StartTime
must be earlier than the value forEndTime
.
Result Syntax
[ 'AlignedEndTime' => <DateTime>, 'AlignedStartTime' => <DateTime>, 'Keys' => [ [ 'Dimensions' => ['<string>', ...], 'Partitions' => [<float>, ...], 'Total' => <float>, ], // ... ], 'NextToken' => '<string>', 'PartitionKeys' => [ [ 'Dimensions' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- AlignedEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time for the returned dimension keys, after alignment to a granular boundary (as specified by
PeriodInSeconds
).AlignedEndTime
will be greater than or equal to the value of the user-specifiedEndtime
. - AlignedStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for the returned dimension keys, after alignment to a granular boundary (as specified by
PeriodInSeconds
).AlignedStartTime
will be less than or equal to the value of the user-specifiedStartTime
. - Keys
-
- Type: Array of DimensionKeyDescription structures
The dimension keys that were requested.
- NextToken
-
- Type: string
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
. - PartitionKeys
-
- Type: Array of ResponsePartitionKey structures
If
PartitionBy
was present in the request,PartitionKeys
contains the breakdown of dimension keys by the specified partitions.
Errors
-
One of the arguments provided is invalid for this request.
-
The request failed due to an unknown error.
-
The user is not authorized to perform this request.
GetResourceMetrics
$result = $client->getResourceMetrics
([/* ... */]); $promise = $client->getResourceMetricsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getResourceMetrics([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'Identifier' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'MetricQueries' => [ // REQUIRED [ 'Filter' => ['<string>', ...], 'GroupBy' => [ 'Dimensions' => ['<string>', ...], 'Group' => '<string>', // REQUIRED 'Limit' => <integer>, ], 'Metric' => '<string>', // REQUIRED ], // ... ], 'NextToken' => '<string>', 'PeriodInSeconds' => <integer>, 'ServiceType' => 'RDS', // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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 forStartTime
. - Identifier
-
- Required: Yes
- Type: string
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, specifydb-FAIHNTYBKTGAUSUZQYPDS2GW4A
. - MaxResults
-
- Type: int
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. - MetricQueries
-
- Required: Yes
- Type: Array of MetricQuery structures
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.
- NextToken
-
- Type: string
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
. - PeriodInSeconds
-
- Type: int
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. - ServiceType
-
- Required: Yes
- Type: string
The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is
RDS
. - StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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 thanStartTime
will be returned.The value for
StartTime
must be earlier than the value forEndTime
.
Result Syntax
[ 'AlignedEndTime' => <DateTime>, 'AlignedStartTime' => <DateTime>, 'Identifier' => '<string>', 'MetricList' => [ [ 'DataPoints' => [ [ 'Timestamp' => <DateTime>, 'Value' => <float>, ], // ... ], 'Key' => [ 'Dimensions' => ['<string>', ...], 'Metric' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AlignedEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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-specifiedEndtime
. - AlignedStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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-specifiedStartTime
. - Identifier
-
- Type: string
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, you specify its
DbiResourceId
value - for example:db-FAIHNTYBKTGAUSUZQYPDS2GW4A
- MetricList
-
- Type: Array of MetricKeyDataPoints structures
An array of metric results,, where each array element contains all of the data points for a particular dimension.
- NextToken
-
- Type: string
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
.
Errors
-
One of the arguments provided is invalid for this request.
-
The request failed due to an unknown error.
-
The user is not authorized to perform this request.
Shapes
DataPoint
Description
A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
Members
DimensionGroup
Description
A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql
dimension group consists of the following dimensions: db.sql.id
, db.sql.db_id
, db.sql.statement
, and db.sql.tokenized_id
.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Members
- Dimensions
-
- Type: Array of strings
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
Valid values for elements in the
Dimensions
array are:-
db.application.name
- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) -
db.host.id
- The host ID of the connected client (all engines) -
db.host.name
- The host name of the connected client (all engines) -
db.name
- The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB) -
db.session_type.name
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) -
db.sql.id
- The SQL ID generated by Performance Insights (all engines) -
db.sql.db_id
- The SQL ID generated by the database (all engines) -
db.sql.statement
- The SQL text that is being executed (all engines) -
db.sql.tokenized_id
-
db.sql_tokenized.id
- The SQL digest ID generated by Performance Insights (all engines) -
db.sql_tokenized.db_id
- SQL digest ID generated by the database (all engines) -
db.sql_tokenized.statement
- The SQL digest text (all engines) -
db.user.id
- The ID of the user logged in to the database (all engines) -
db.user.name
- The name of the user logged in to the database (all engines) -
db.wait_event.name
- The event for which the backend is waiting (all engines) -
db.wait_event.type
- The type of event for which the backend is waiting (all engines) -
db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines)
- Group
-
- Required: Yes
- Type: string
The name of the dimension group. Valid values are:
-
db
- The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB) -
db.application
- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) -
db.host
- The host name of the connected client (all engines) -
db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) -
db.sql
- The SQL that is currently executing (all engines) -
db.sql_tokenized
- The SQL digest (all engines) -
db.wait_event
- The event for which the database backend is waiting (all engines) -
db.wait_event_type
- The type of event for which the database backend is waiting (all engines) -
db.user
- The user logged in to the database (all engines)
- Limit
-
- Type: int
The maximum number of items to fetch for this dimension group.
DimensionKeyDescription
Description
An array of descriptions and aggregated values for each dimension within a dimension group.
Members
- Dimensions
-
- Type: Associative array of custom strings keys (String) to strings
A map of name-value pairs for the dimensions in the group.
- Partitions
-
- Type: Array of doubles
If
PartitionBy
was specified,PartitionKeys
contains the dimensions that were. - Total
-
- Type: double
The aggregated metric value for the dimension(s), over the requested time range.
InternalServiceError
InvalidArgumentException
MetricKeyDataPoints
Description
A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.
Members
- DataPoints
-
- Type: Array of DataPoint structures
An array of timestamp-value pairs, representing measurements over a period of time.
- Key
-
- Type: ResponseResourceMetricKey structure
The dimension(s) to which the data points apply.
MetricQuery
Description
A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy
), and return only those data points that match your criteria (Filter
).
Members
- Filter
-
- Type: Associative array of custom strings keys (String) to strings
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.
- GroupBy
-
- Type: DimensionGroup structure
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.
- Metric
-
- Required: Yes
- Type: string
The name of a Performance Insights metric to be measured.
Valid values for
Metric
are:-
db.load.avg
- a scaled representation of the number of active sessions for the database engine. -
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.load.avg
only.
NotAuthorizedException
ResponsePartitionKey
Description
If PartitionBy
was specified in a DescribeDimensionKeys
request, the dimensions are returned in an array. Each element in the array specifies one dimension.
Members
ResponseResourceMetricKey
Description
An object describing a Performance Insights metric and one or more dimensions for that metric.
Members
- Dimensions
-
- Type: Associative array of custom strings keys (String) to strings
The valid dimensions for the metric.
- Metric
-
- Required: Yes
- Type: string
The name of a Performance Insights metric to be measured.
Valid values for
Metric
are:-
db.load.avg
- a scaled representation of the number of active sessions for the database engine. -
db.sampledload.avg
- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.load.avg
only.