Serialized Form (AWS Java SDK for AWS Performance Insights 1.11.987 API)

Package com.amazonaws.services.pi.model
- Class com.amazonaws.services.pi.model.AWSPIException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.pi.model.DataPoint extends Object implements Serializable
  - Serialized Fields
    - timestamp
```
Date timestamp
```
      The time, in epoch format, associated with a particular Value.
    - value
```
Double value
```
      The actual value associated with a particular Timestamp.
- Class com.amazonaws.services.pi.model.DescribeDimensionKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceType
```
String serviceType
```
      The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.
    - identifier
```
String identifier
```
      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, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
    - startTime
```
Date startTime
```
      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.
    - endTime
```
Date endTime
```
      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.
    - metric
```
String metric
```
      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.
    - periodInSeconds
```
Integer periodInSeconds
```
      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.
    - groupBy
```
DimensionGroup groupBy
```
      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.
    - partitionBy
```
DimensionGroup partitionBy
```
      For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.
    - filter
```
Map<K,V> filter
```
      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.
    - maxResults
```
Integer maxResults
```
      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.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.pi.model.DescribeDimensionKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - alignedStartTime
```
Date alignedStartTime
```
      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.
    - alignedEndTime
```
Date alignedEndTime
```
      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.
    - partitionKeys
```
List<E> partitionKeys
```
      If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
    - keys
```
List<E> keys
```
      The dimension keys that were requested.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.pi.model.DimensionGroup extends Object implements Serializable
  - Serialized Fields
    - group
```
String group
```
      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)
    - dimensions
```
List<E> dimensions
```
      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)
    - limit
```
Integer limit
```
      The maximum number of items to fetch for this dimension group.
- Class com.amazonaws.services.pi.model.DimensionKeyDescription extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
Map<K,V> dimensions
```
      A map of name-value pairs for the dimensions in the group.
    - total
```
Double total
```
      The aggregated metric value for the dimension(s), over the requested time range.
    - partitions
```
List<E> partitions
```
      If PartitionBy was specified, PartitionKeys contains the dimensions that were.
- Class com.amazonaws.services.pi.model.GetResourceMetricsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceType
```
String serviceType
```
      The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS.
    - identifier
```
String 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.
    - metricQueries
```
List<E> metricQueries
```
      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.
    - startTime
```
Date startTime
```
      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.
    - endTime
```
Date endTime
```
      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.
    - periodInSeconds
```
Integer periodInSeconds
```
      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.
    - maxResults
```
Integer maxResults
```
      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.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.pi.model.GetResourceMetricsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - alignedStartTime
```
Date alignedStartTime
```
      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.
    - alignedEndTime
```
Date alignedEndTime
```
      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.
    - identifier
```
String 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, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A
    - metricList
```
List<E> metricList
```
      An array of metric results,, where each array element contains all of the data points for a particular dimension.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.pi.model.InternalServiceErrorException extends AWSPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.pi.model.InvalidArgumentException extends AWSPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.pi.model.MetricKeyDataPoints extends Object implements Serializable
  - Serialized Fields
    - key
```
ResponseResourceMetricKey key
```
      The dimension(s) to which the data points apply.
    - dataPoints
```
List<E> dataPoints
```
      An array of timestamp-value pairs, representing measurements over a period of time.
- Class com.amazonaws.services.pi.model.MetricQuery extends Object implements Serializable
  - Serialized Fields
    - metric
```
String metric
```
      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.
    - groupBy
```
DimensionGroup groupBy
```
      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.
    - filter
```
Map<K,V> 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.
- Class com.amazonaws.services.pi.model.NotAuthorizedException extends AWSPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.pi.model.ResponsePartitionKey extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
Map<K,V> dimensions
```
      A dimension map that contains the dimension(s) for this partition.
- Class com.amazonaws.services.pi.model.ResponseResourceMetricKey extends Object implements Serializable
  - Serialized Fields
    - metric
```
String metric
```
      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.
    - dimensions
```
Map<K,V> dimensions
```
      The valid dimensions for the metric.

Serialized Form

Package com.amazonaws.services.pi.model

Class com.amazonaws.services.pi.model.AWSPIException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.pi.model.DataPoint extends Object implements Serializable

Serialized Fields

timestamp

value

Class com.amazonaws.services.pi.model.DescribeDimensionKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceType

identifier

startTime

endTime

metric

periodInSeconds

groupBy

partitionBy

filter

maxResults

nextToken

Class com.amazonaws.services.pi.model.DescribeDimensionKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

alignedStartTime

alignedEndTime

partitionKeys

keys

nextToken

Class com.amazonaws.services.pi.model.DimensionGroup extends Object implements Serializable

Serialized Fields

group

dimensions

limit

Class com.amazonaws.services.pi.model.DimensionKeyDescription extends Object implements Serializable

Serialized Fields

dimensions

total

partitions

Class com.amazonaws.services.pi.model.GetResourceMetricsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceType

identifier

metricQueries

startTime

endTime

periodInSeconds

maxResults

nextToken

Class com.amazonaws.services.pi.model.GetResourceMetricsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

alignedStartTime

alignedEndTime

identifier

metricList

nextToken

Class com.amazonaws.services.pi.model.InternalServiceErrorException extends AWSPIException implements Serializable

Class com.amazonaws.services.pi.model.InvalidArgumentException extends AWSPIException implements Serializable

Class com.amazonaws.services.pi.model.MetricKeyDataPoints extends Object implements Serializable

Serialized Fields

key

dataPoints

Class com.amazonaws.services.pi.model.MetricQuery extends Object implements Serializable

Serialized Fields

metric

groupBy

filter

Class com.amazonaws.services.pi.model.NotAuthorizedException extends AWSPIException implements Serializable

Class com.amazonaws.services.pi.model.ResponsePartitionKey extends Object implements Serializable

Serialized Fields

dimensions

Class com.amazonaws.services.pi.model.ResponseResourceMetricKey extends Object implements Serializable

Serialized Fields

metric

dimensions