class Aws::PI::Types::DimensionGroup

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

<note markdown=“1”> Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

</note>

@note When making an API call, you may pass DimensionGroup

data as a hash:

    {
      group: "RequestString", # required
      dimensions: ["RequestString"],
      limit: 1,
    }

@!attribute [rw] 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)
@return [String]

@!attribute [rw] 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)
@return [Array<String>]

@!attribute [rw] limit

The maximum number of items to fetch for this dimension group.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DimensionGroup AWS API Documentation

Constants

SENSITIVE