Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pi.Types.DimensionGroup

Description

Synopsis

data DimensionGroup = DimensionGroup' {
- limit :: Maybe Natural
- dimensions :: Maybe (NonEmpty Text)
- group' :: Text
}
newDimensionGroup :: Text -> DimensionGroup
dimensionGroup_limit :: Lens' DimensionGroup (Maybe Natural)
dimensionGroup_dimensions :: Lens' DimensionGroup (Maybe (NonEmpty Text))
dimensionGroup_group :: Lens' DimensionGroup Text

Documentation

data DimensionGroup Source #

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.

See: newDimensionGroup smart constructor.

Constructors

DimensionGroup'

Fields

limit :: Maybe Natural
The maximum number of items to fetch for this dimension group.
dimensions :: Maybe (NonEmpty Text)
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' :: Text
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)

Instances

Instances details

Eq DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Methods (==) :: DimensionGroup -> DimensionGroup -> Bool # (/=) :: DimensionGroup -> DimensionGroup -> Bool #
Read DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Methods readsPrec :: Int -> ReadS DimensionGroup # readList :: ReadS [DimensionGroup] # readPrec :: ReadPrec DimensionGroup # readListPrec :: ReadPrec [DimensionGroup] #
Show DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Methods showsPrec :: Int -> DimensionGroup -> ShowS # show :: DimensionGroup -> String # showList :: [DimensionGroup] -> ShowS #
Generic DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Associated Types type Rep DimensionGroup :: Type -> Type # Methods from :: DimensionGroup -> Rep DimensionGroup x # to :: Rep DimensionGroup x -> DimensionGroup #
NFData DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Methods rnf :: DimensionGroup -> () #
Hashable DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Methods hashWithSalt :: Int -> DimensionGroup -> Int # hash :: DimensionGroup -> Int #
ToJSON DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup Methods toJSON :: DimensionGroup -> Value # toEncoding :: DimensionGroup -> Encoding # toJSONList :: [DimensionGroup] -> Value # toEncodingList :: [DimensionGroup] -> Encoding #
type Rep DimensionGroup Source #
Instance details Defined in Amazonka.Pi.Types.DimensionGroup type Rep DimensionGroup = D1 ('MetaData "DimensionGroup" "Amazonka.Pi.Types.DimensionGroup" "libZSservicesZSamazonka-piZSamazonka-pi" 'False) (C1 ('MetaCons "DimensionGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDimensionGroup Source #

Arguments

:: Text	`$sel:group':DimensionGroup'`
-> DimensionGroup

Create a value of DimensionGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:DimensionGroup', dimensionGroup_limit - The maximum number of items to fetch for this dimension group.

$sel:dimensions:DimensionGroup', dimensionGroup_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)

$sel:group':DimensionGroup', dimensionGroup_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)

dimensionGroup_limit :: Lens' DimensionGroup (Maybe Natural) Source #

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

dimensionGroup_dimensions :: Lens' DimensionGroup (Maybe (NonEmpty Text)) Source #

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)

dimensionGroup_group :: Lens' DimensionGroup Text Source #

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)