AWS SDK for PHP 3.x

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.
GetDimensionKeyDetails ( array $params = [] )
Get the attributes of the specified dimension group for a DB instance or data source.
GetResourceMetadata ( array $params = [] )
Retrieve the metadata for different features.
GetResourceMetrics ( array $params = [] )
Retrieve Performance Insights metrics for a set of data sources over a time period.
ListAvailableResourceDimensions ( array $params = [] )
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
ListAvailableResourceMetrics ( array $params = [] )
Retrieve metrics of the specified types that can be queried for a specified DB instance.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeDimensionKeys
GetResourceMetrics
ListAvailableResourceDimensions
ListAvailableResourceMetrics

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([
    'AdditionalMetrics' => ['<string>', ...],
    '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|DOCDB', // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

AdditionalMetrics

Type: Array of strings

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

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 for StartTime.

Filter

Type: Associative array of custom strings keys (RequestString) 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 or Partition 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, Amazon Web Services 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, specify db-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 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.

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 Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

RDS
DOCDB

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 than StartTime are returned.

The value for StartTime must be earlier than the value for EndTime.

Result Syntax

[
    'AlignedEndTime' => <DateTime>,
    'AlignedStartTime' => <DateTime>,
    'Keys' => [
        [
            'AdditionalMetrics' => [<float>, ...],
            '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-specified Endtime.

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-specified StartTime.

Keys

Type: Array of DimensionKeyDescription structures

The dimension keys that were requested.

NextToken

Type: 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.

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

InvalidArgumentException:
One of the arguments provided is invalid for this request.
InternalServiceError:
The request failed due to an unknown error.
NotAuthorizedException:
The user is not authorized to perform this request.

GetDimensionKeyDetails

$result = $client->getDimensionKeyDetails([/* ... */]);
$promise = $client->getDimensionKeyDetailsAsync([/* ... */]);

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

Parameter Syntax

$result = $client->getDimensionKeyDetails([
    'Group' => '<string>', // REQUIRED
    'GroupIdentifier' => '<string>', // REQUIRED
    'Identifier' => '<string>', // REQUIRED
    'RequestedDimensions' => ['<string>', ...],
    'ServiceType' => 'RDS|DOCDB', // REQUIRED
]);

Parameter Details

Members

Group

Required: Yes
Type: string

The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

db.query (Amazon DocumentDB only)
db.sql (Amazon RDS and Aurora only)

GroupIdentifier

Required: Yes
Type: string

The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

db.sql.id for dimension group db.sql (Aurora and RDS only)
db.query.id for dimension group db.query (DocumentDB only)

Identifier

Required: Yes
Type: string

The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

RequestedDimensions

Type: Array of strings

A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).
db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

ServiceType

Required: Yes
Type: string

The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

Result Syntax

[
    'Dimensions' => [
        [
            'Dimension' => '<string>',
            'Status' => 'AVAILABLE|PROCESSING|UNAVAILABLE',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Dimensions

Type: Array of DimensionKeyDetail structures

The details for the requested dimensions.

Errors

InvalidArgumentException:
One of the arguments provided is invalid for this request.
InternalServiceError:
The request failed due to an unknown error.
NotAuthorizedException:
The user is not authorized to perform this request.

GetResourceMetadata

$result = $client->getResourceMetadata([/* ... */]);
$promise = $client->getResourceMetadataAsync([/* ... */]);

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Parameter Syntax

$result = $client->getResourceMetadata([
    'Identifier' => '<string>', // REQUIRED
    'ServiceType' => 'RDS|DOCDB', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

An immutable identifier for a data source that is unique for an Amazon Web Services Region. 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-ABCDEFGHIJKLMNOPQRSTU1VW2X.

ServiceType

Required: Yes
Type: string

The Amazon Web Services service for which Performance Insights returns metrics.

Result Syntax

[
    'Features' => [
        '<String>' => [
            'Status' => 'ENABLED|DISABLED|UNSUPPORTED|ENABLED_PENDING_REBOOT|DISABLED_PENDING_REBOOT|UNKNOWN',
        ],
        // ...
    ],
    'Identifier' => '<string>',
]

Result Details

Members

Features

Type: Associative array of custom strings keys (String) to FeatureMetadata structures

The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Identifier

Type: string

Errors

InvalidArgumentException:
One of the arguments provided is invalid for this request.
InternalServiceError:
The request failed due to an unknown error.
NotAuthorizedException:
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|DOCDB', // 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 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.

Identifier

Required: Yes
Type: string

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.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

MaxResults

Type: int

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 Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

RDS
DOCDB

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

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-specified Endtime.

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-specified StartTime.

Identifier

Type: string

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

InvalidArgumentException:
One of the arguments provided is invalid for this request.
InternalServiceError:
The request failed due to an unknown error.
NotAuthorizedException:
The user is not authorized to perform this request.

ListAvailableResourceDimensions

$result = $client->listAvailableResourceDimensions([/* ... */]);
$promise = $client->listAvailableResourceDimensionsAsync([/* ... */]);

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

Parameter Syntax

$result = $client->listAvailableResourceDimensions([
    'Identifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'Metrics' => ['<string>', ...], // REQUIRED
    'NextToken' => '<string>',
    'ServiceType' => 'RDS|DOCDB', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

MaxResults

Type: int

Metrics

Required: Yes
Type: Array of strings

The types of metrics for which to retrieve dimensions. Valid values include db.load.

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.

ServiceType

Required: Yes
Type: string

The Amazon Web Services service for which Performance Insights returns metrics.

Result Syntax

[
    'MetricDimensions' => [
        [
            'Groups' => [
                [
                    'Dimensions' => [
                        [
                            'Identifier' => '<string>',
                        ],
                        // ...
                    ],
                    'Group' => '<string>',
                ],
                // ...
            ],
            'Metric' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MetricDimensions

Type: Array of MetricDimensionGroups structures

The dimension information returned for requested metric types.

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

InvalidArgumentException:
One of the arguments provided is invalid for this request.
InternalServiceError:
The request failed due to an unknown error.
NotAuthorizedException:
The user is not authorized to perform this request.

ListAvailableResourceMetrics

$result = $client->listAvailableResourceMetrics([/* ... */]);
$promise = $client->listAvailableResourceMetricsAsync([/* ... */]);

Retrieve metrics of the specified types that can be queried for a specified DB instance.

Parameter Syntax

$result = $client->listAvailableResourceMetrics([
    'Identifier' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MetricTypes' => ['<string>', ...], // REQUIRED
    'NextToken' => '<string>',
    'ServiceType' => 'RDS|DOCDB', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

MaxResults

Type: int

The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

MetricTypes

Required: Yes
Type: Array of strings

The types of metrics to return in the response. Valid values in the array include the following:

os (OS counter metrics) - All engines
db (DB load metrics) - All engines except for Amazon DocumentDB
db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

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.

ServiceType

Required: Yes
Type: string

The Amazon Web Services service for which Performance Insights returns metrics.

Result Syntax

[
    'Metrics' => [
        [
            'Description' => '<string>',
            'Metric' => '<string>',
            'Unit' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Metrics

Type: Array of ResponseResourceMetric structures

An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.

NextToken

Type: string

Errors

InvalidArgumentException:
One of the arguments provided is invalid for this request.
InternalServiceError:
The request failed due to an unknown error.
NotAuthorizedException:
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

Timestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time, in epoch format, associated with a particular Value.

Value

Required: Yes
Type: double

The actual value associated with a particular Timestamp.

DimensionDetail

Description

The information about a dimension.

Members

Identifier

Type: string

The identifier of a dimension.

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 - The hash of a running SQL statement, generated by Performance Insights.
db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.
db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.
db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

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. Valid values are as follows:
- Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Amazon DocumentDB
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. Valid values are as follows:
- Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Aurora MySQL
- Amazon RDS MySQL
- Amazon RDS MariaDB
- Amazon DocumentDB
db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).
db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).
db.query.statement - The text of the query that is being run (only Amazon DocumentDB).
db.query.tokenized_id
db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).
db.session_type.name - The type of the current session (only Amazon DocumentDB).
db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).
db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)
db.sql.tokenized_id
db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.
db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).
db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)
db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).
db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

Group

Required: Yes
Type: string

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).

Limit

Type: int

The maximum number of items to fetch for this dimension group.

DimensionGroupDetail

Description

Information about dimensions within a dimension group.

Members

Dimensions

Type: Array of DimensionDetail structures

The dimensions within a dimension group.

Group

Type: string

The name of the dimension group.

DimensionKeyDescription

Description

An object that includes the requested dimension key values and aggregated metric values within a dimension group.

Members

AdditionalMetrics

Type: Associative array of custom strings keys (RequestString) to doubles

A map that contains the value for each additional metric.

Dimensions

Type: Associative array of custom strings keys (RequestString) 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 dimensions, over the requested time range.

DimensionKeyDetail

Description

An object that describes the details for a specified dimension.

Members

Dimension

Type: string

The full name of the dimension. The full name includes the group name and key name. The following values are valid:

db.query.statement (Amazon DocumentDB)
db.sql.statement (Amazon RDS and Aurora)

Status

Type: string

The status of the dimension detail data. Possible values include the following:

AVAILABLE - The dimension detail data is ready to be retrieved.
PROCESSING - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data has the status PROCESSING, Performance Insights returns the truncated query.
UNAVAILABLE - The dimension detail data could not be collected successfully.

Value

Type: string

The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

db.query.statement (Amazon DocumentDB)
db.sql.statement (Amazon RDS and Aurora)

FeatureMetadata

Description

The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Members

Status

Type: string

The status of the feature on the DB instance. Possible values include the following:

ENABLED - The feature is enabled on the instance.
DISABLED - The feature is disabled on the instance.
UNSUPPORTED - The feature isn't supported on the instance.
ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.
DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.
UNKNOWN - The feature status couldn't be determined.

InternalServiceError

Description

The request failed due to an unknown error.

Members

Message

Type: string

InvalidArgumentException

Description

One of the arguments provided is invalid for this request.

Members

Message

Type: string

MetricDimensionGroups

Description

The available dimension information for a metric type.

Members

Groups

Type: Array of DimensionGroupDetail structures

The available dimension groups for a metric type.

Metric

Type: string

The metric type to which the dimension information belongs.

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 dimensions 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 data points for the specified metric. Optionally, you can 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 (RequestString) 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.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

NotAuthorizedException

Description

The user is not authorized to perform this request.

Members

Message

Type: string

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

Dimensions

Required: Yes
Type: Associative array of custom strings keys (RequestString) to strings

A dimension map that contains the dimensions for this partition.

ResponseResourceMetric

Description

An object that contains the full name, description, and unit of a metric.

Members

Description

Type: string

The description of the metric.

Metric

Type: string

The full name of the metric.

Unit

Type: string

The unit of the metric.

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 (RequestString) 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.
The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Performance Insights 2018-02-27

Operation Summary

Paginators

Operations

DescribeDimensionKeys

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDimensionKeyDetails

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetResourceMetadata

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetResourceMetrics

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListAvailableResourceDimensions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListAvailableResourceMetrics

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Shapes

DataPoint

Description

Members

DimensionDetail

Description

Members

DimensionGroup

Description

Members

DimensionGroupDetail

Description

Members

DimensionKeyDescription

Description

Members

DimensionKeyDetail

Description

Members

FeatureMetadata

Description

Members