amazonka-pi-2.0: Amazon Performance Insights SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pi.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2018-02-27 of the Amazon Performance Insights SDK configuration.

Errors

_InternalServiceError :: AsError a => Fold a ServiceError Source #

The request failed due to an unknown error.

_InvalidArgumentException :: AsError a => Fold a ServiceError Source #

One of the arguments provided is invalid for this request.

_NotAuthorizedException :: AsError a => Fold a ServiceError Source #

The user is not authorized to perform this request.

DetailStatus

newtype DetailStatus Source #

Constructors

DetailStatus' 

Instances

Instances details
FromJSON DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

FromJSONKey DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToJSON DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToJSONKey DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToByteString DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToHeader DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToLog DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToQuery DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

FromText DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToText DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Methods

toText :: DetailStatus -> Text #

FromXML DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

ToXML DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Methods

toXML :: DetailStatus -> XML #

Generic DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Associated Types

type Rep DetailStatus :: Type -> Type #

Read DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Show DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

NFData DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Methods

rnf :: DetailStatus -> () #

Eq DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Ord DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

Hashable DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

type Rep DetailStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.DetailStatus

type Rep DetailStatus = D1 ('MetaData "DetailStatus" "Amazonka.Pi.Types.DetailStatus" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'True) (C1 ('MetaCons "DetailStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDetailStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FeatureStatus

newtype FeatureStatus Source #

Constructors

FeatureStatus' 

Instances

Instances details
FromJSON FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

FromJSONKey FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToJSON FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToJSONKey FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToByteString FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToHeader FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToLog FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToQuery FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

FromText FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToText FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Methods

toText :: FeatureStatus -> Text #

FromXML FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

ToXML FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Methods

toXML :: FeatureStatus -> XML #

Generic FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Associated Types

type Rep FeatureStatus :: Type -> Type #

Read FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Show FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

NFData FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Methods

rnf :: FeatureStatus -> () #

Eq FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Ord FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

Hashable FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

type Rep FeatureStatus Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureStatus

type Rep FeatureStatus = D1 ('MetaData "FeatureStatus" "Amazonka.Pi.Types.FeatureStatus" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'True) (C1 ('MetaCons "FeatureStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFeatureStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceType

newtype ServiceType Source #

Constructors

ServiceType' 

Bundled Patterns

pattern ServiceType_DOCDB :: ServiceType 
pattern ServiceType_RDS :: ServiceType 

Instances

Instances details
FromJSON ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

FromJSONKey ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToJSON ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToJSONKey ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToByteString ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToHeader ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToLog ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToQuery ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

FromText ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToText ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Methods

toText :: ServiceType -> Text #

FromXML ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

ToXML ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Methods

toXML :: ServiceType -> XML #

Generic ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Associated Types

type Rep ServiceType :: Type -> Type #

Read ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Show ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

NFData ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Methods

rnf :: ServiceType -> () #

Eq ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Ord ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

Hashable ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

type Rep ServiceType Source # 
Instance details

Defined in Amazonka.Pi.Types.ServiceType

type Rep ServiceType = D1 ('MetaData "ServiceType" "Amazonka.Pi.Types.ServiceType" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'True) (C1 ('MetaCons "ServiceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServiceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataPoint

data DataPoint Source #

A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

See: newDataPoint smart constructor.

Constructors

DataPoint' 

Fields

  • timestamp :: POSIX

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

  • value :: Double

    The actual value associated with a particular Timestamp.

Instances

Instances details
FromJSON DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

Generic DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

Associated Types

type Rep DataPoint :: Type -> Type #

Read DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

Show DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

NFData DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

Methods

rnf :: DataPoint -> () #

Eq DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

Hashable DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

type Rep DataPoint Source # 
Instance details

Defined in Amazonka.Pi.Types.DataPoint

type Rep DataPoint = D1 ('MetaData "DataPoint" "Amazonka.Pi.Types.DataPoint" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DataPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))

newDataPoint Source #

Create a value of DataPoint 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:timestamp:DataPoint', dataPoint_timestamp - The time, in epoch format, associated with a particular Value.

$sel:value:DataPoint', dataPoint_value - The actual value associated with a particular Timestamp.

dataPoint_timestamp :: Lens' DataPoint UTCTime Source #

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

dataPoint_value :: Lens' DataPoint Double Source #

The actual value associated with a particular Timestamp.

DimensionDetail

data DimensionDetail Source #

The information about a dimension.

See: newDimensionDetail smart constructor.

Constructors

DimensionDetail' 

Fields

Instances

Instances details
FromJSON DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

Generic DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

Associated Types

type Rep DimensionDetail :: Type -> Type #

Read DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

Show DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

NFData DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

Methods

rnf :: DimensionDetail -> () #

Eq DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

Hashable DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

type Rep DimensionDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionDetail

type Rep DimensionDetail = D1 ('MetaData "DimensionDetail" "Amazonka.Pi.Types.DimensionDetail" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DimensionDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDimensionDetail :: DimensionDetail Source #

Create a value of DimensionDetail 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:identifier:DimensionDetail', dimensionDetail_identifier - The identifier of a dimension.

DimensionGroup

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

See: newDimensionGroup smart constructor.

Constructors

DimensionGroup' 

Fields

  • 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. 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).
  • limit :: Maybe Natural

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

  • group' :: Text

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

Instances

Instances details
ToJSON DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

Generic DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

Associated Types

type Rep DimensionGroup :: Type -> Type #

Read DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

Show DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

NFData DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

Methods

rnf :: DimensionGroup -> () #

Eq DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

Hashable DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

type Rep DimensionGroup Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroup

type Rep DimensionGroup = D1 ('MetaData "DimensionGroup" "Amazonka.Pi.Types.DimensionGroup" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DimensionGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDimensionGroup Source #

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

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

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

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

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

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

dimensionGroup_group :: Lens' DimensionGroup Text Source #

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

DimensionGroupDetail

data DimensionGroupDetail Source #

Information about dimensions within a dimension group.

See: newDimensionGroupDetail smart constructor.

Constructors

DimensionGroupDetail' 

Fields

Instances

Instances details
FromJSON DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

Generic DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

Associated Types

type Rep DimensionGroupDetail :: Type -> Type #

Read DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

Show DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

NFData DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

Methods

rnf :: DimensionGroupDetail -> () #

Eq DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

Hashable DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

type Rep DimensionGroupDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionGroupDetail

type Rep DimensionGroupDetail = D1 ('MetaData "DimensionGroupDetail" "Amazonka.Pi.Types.DimensionGroupDetail" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DimensionGroupDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DimensionDetail])) :*: S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDimensionGroupDetail :: DimensionGroupDetail Source #

Create a value of DimensionGroupDetail 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:dimensions:DimensionGroupDetail', dimensionGroupDetail_dimensions - The dimensions within a dimension group.

$sel:group':DimensionGroupDetail', dimensionGroupDetail_group - The name of the dimension group.

DimensionKeyDescription

data DimensionKeyDescription Source #

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

See: newDimensionKeyDescription smart constructor.

Constructors

DimensionKeyDescription' 

Fields

Instances

Instances details
FromJSON DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Generic DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Associated Types

type Rep DimensionKeyDescription :: Type -> Type #

Read DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Show DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

NFData DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

rnf :: DimensionKeyDescription -> () #

Eq DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Hashable DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

type Rep DimensionKeyDescription Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDescription

type Rep DimensionKeyDescription = D1 ('MetaData "DimensionKeyDescription" "Amazonka.Pi.Types.DimensionKeyDescription" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DimensionKeyDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double))) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "partitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :*: S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newDimensionKeyDescription :: DimensionKeyDescription Source #

Create a value of DimensionKeyDescription 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:additionalMetrics:DimensionKeyDescription', dimensionKeyDescription_additionalMetrics - A map that contains the value for each additional metric.

$sel:dimensions:DimensionKeyDescription', dimensionKeyDescription_dimensions - A map of name-value pairs for the dimensions in the group.

$sel:partitions:DimensionKeyDescription', dimensionKeyDescription_partitions - If PartitionBy was specified, PartitionKeys contains the dimensions that were.

$sel:total:DimensionKeyDescription', dimensionKeyDescription_total - The aggregated metric value for the dimensions, over the requested time range.

dimensionKeyDescription_additionalMetrics :: Lens' DimensionKeyDescription (Maybe (HashMap Text Double)) Source #

A map that contains the value for each additional metric.

dimensionKeyDescription_dimensions :: Lens' DimensionKeyDescription (Maybe (HashMap Text Text)) Source #

A map of name-value pairs for the dimensions in the group.

dimensionKeyDescription_partitions :: Lens' DimensionKeyDescription (Maybe [Double]) Source #

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

dimensionKeyDescription_total :: Lens' DimensionKeyDescription (Maybe Double) Source #

The aggregated metric value for the dimensions, over the requested time range.

DimensionKeyDetail

data DimensionKeyDetail Source #

An object that describes the details for a specified dimension.

See: newDimensionKeyDetail smart constructor.

Constructors

DimensionKeyDetail' 

Fields

  • dimension :: Maybe Text

    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 :: Maybe DetailStatus

    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 :: Maybe Text

    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)

Instances

Instances details
FromJSON DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Generic DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Associated Types

type Rep DimensionKeyDetail :: Type -> Type #

Read DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Show DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

NFData DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

rnf :: DimensionKeyDetail -> () #

Eq DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Hashable DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

type Rep DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

type Rep DimensionKeyDetail = D1 ('MetaData "DimensionKeyDetail" "Amazonka.Pi.Types.DimensionKeyDetail" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DimensionKeyDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetailStatus)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDimensionKeyDetail :: DimensionKeyDetail Source #

Create a value of DimensionKeyDetail 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:dimension:DimensionKeyDetail', dimensionKeyDetail_dimension - 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)

$sel:status:DimensionKeyDetail', dimensionKeyDetail_status - 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.

$sel:value:DimensionKeyDetail', dimensionKeyDetail_value - 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)

dimensionKeyDetail_dimension :: Lens' DimensionKeyDetail (Maybe Text) Source #

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)

dimensionKeyDetail_status :: Lens' DimensionKeyDetail (Maybe DetailStatus) Source #

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.

dimensionKeyDetail_value :: Lens' DimensionKeyDetail (Maybe Text) Source #

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

data FeatureMetadata Source #

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

See: newFeatureMetadata smart constructor.

Constructors

FeatureMetadata' 

Fields

  • status :: Maybe FeatureStatus

    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.

Instances

Instances details
FromJSON FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

Generic FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

Associated Types

type Rep FeatureMetadata :: Type -> Type #

Read FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

Show FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

NFData FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

Methods

rnf :: FeatureMetadata -> () #

Eq FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

Hashable FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

type Rep FeatureMetadata Source # 
Instance details

Defined in Amazonka.Pi.Types.FeatureMetadata

type Rep FeatureMetadata = D1 ('MetaData "FeatureMetadata" "Amazonka.Pi.Types.FeatureMetadata" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "FeatureMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FeatureStatus))))

newFeatureMetadata :: FeatureMetadata Source #

Create a value of FeatureMetadata 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:status:FeatureMetadata', featureMetadata_status - 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.

featureMetadata_status :: Lens' FeatureMetadata (Maybe FeatureStatus) Source #

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.

MetricDimensionGroups

data MetricDimensionGroups Source #

The available dimension information for a metric type.

See: newMetricDimensionGroups smart constructor.

Constructors

MetricDimensionGroups' 

Fields

Instances

Instances details
FromJSON MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

Generic MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

Associated Types

type Rep MetricDimensionGroups :: Type -> Type #

Read MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

Show MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

NFData MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

Methods

rnf :: MetricDimensionGroups -> () #

Eq MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

Hashable MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

type Rep MetricDimensionGroups Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricDimensionGroups

type Rep MetricDimensionGroups = D1 ('MetaData "MetricDimensionGroups" "Amazonka.Pi.Types.MetricDimensionGroups" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "MetricDimensionGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DimensionGroupDetail])) :*: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMetricDimensionGroups :: MetricDimensionGroups Source #

Create a value of MetricDimensionGroups 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:groups:MetricDimensionGroups', metricDimensionGroups_groups - The available dimension groups for a metric type.

$sel:metric:MetricDimensionGroups', metricDimensionGroups_metric - The metric type to which the dimension information belongs.

metricDimensionGroups_groups :: Lens' MetricDimensionGroups (Maybe [DimensionGroupDetail]) Source #

The available dimension groups for a metric type.

metricDimensionGroups_metric :: Lens' MetricDimensionGroups (Maybe Text) Source #

The metric type to which the dimension information belongs.

MetricKeyDataPoints

data MetricKeyDataPoints Source #

A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

See: newMetricKeyDataPoints smart constructor.

Constructors

MetricKeyDataPoints' 

Fields

Instances

Instances details
FromJSON MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

Generic MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

Associated Types

type Rep MetricKeyDataPoints :: Type -> Type #

Read MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

Show MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

NFData MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

Methods

rnf :: MetricKeyDataPoints -> () #

Eq MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

Hashable MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

type Rep MetricKeyDataPoints Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricKeyDataPoints

type Rep MetricKeyDataPoints = D1 ('MetaData "MetricKeyDataPoints" "Amazonka.Pi.Types.MetricKeyDataPoints" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "MetricKeyDataPoints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataPoint])) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResponseResourceMetricKey))))

newMetricKeyDataPoints :: MetricKeyDataPoints Source #

Create a value of MetricKeyDataPoints 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:dataPoints:MetricKeyDataPoints', metricKeyDataPoints_dataPoints - An array of timestamp-value pairs, representing measurements over a period of time.

$sel:key:MetricKeyDataPoints', metricKeyDataPoints_key - The dimensions to which the data points apply.

metricKeyDataPoints_dataPoints :: Lens' MetricKeyDataPoints (Maybe [DataPoint]) Source #

An array of timestamp-value pairs, representing measurements over a period of time.

metricKeyDataPoints_key :: Lens' MetricKeyDataPoints (Maybe ResponseResourceMetricKey) Source #

The dimensions to which the data points apply.

MetricQuery

data MetricQuery Source #

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

See: newMetricQuery smart constructor.

Constructors

MetricQuery' 

Fields

  • filter' :: Maybe (HashMap Text Text)

    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 :: Maybe DimensionGroup

    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 :: Text

    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.

    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.

Instances

Instances details
ToJSON MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

Generic MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

Associated Types

type Rep MetricQuery :: Type -> Type #

Read MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

Show MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

NFData MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

Methods

rnf :: MetricQuery -> () #

Eq MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

Hashable MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

type Rep MetricQuery Source # 
Instance details

Defined in Amazonka.Pi.Types.MetricQuery

type Rep MetricQuery = D1 ('MetaData "MetricQuery" "Amazonka.Pi.Types.MetricQuery" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "MetricQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionGroup)) :*: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMetricQuery Source #

Create a value of MetricQuery 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:filter':MetricQuery', metricQuery_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.

$sel:groupBy:MetricQuery', metricQuery_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.

$sel:metric:MetricQuery', metricQuery_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.
  • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

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.

metricQuery_filter :: Lens' MetricQuery (Maybe (HashMap Text Text)) Source #

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.

metricQuery_groupBy :: Lens' MetricQuery (Maybe DimensionGroup) Source #

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.

metricQuery_metric :: Lens' MetricQuery Text Source #

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.

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.

ResponsePartitionKey

data ResponsePartitionKey Source #

If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

See: newResponsePartitionKey smart constructor.

Constructors

ResponsePartitionKey' 

Fields

Instances

Instances details
FromJSON ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

Generic ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

Associated Types

type Rep ResponsePartitionKey :: Type -> Type #

Read ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

Show ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

NFData ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

Methods

rnf :: ResponsePartitionKey -> () #

Eq ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

Hashable ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

type Rep ResponsePartitionKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponsePartitionKey

type Rep ResponsePartitionKey = D1 ('MetaData "ResponsePartitionKey" "Amazonka.Pi.Types.ResponsePartitionKey" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ResponsePartitionKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newResponsePartitionKey :: ResponsePartitionKey Source #

Create a value of ResponsePartitionKey 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:dimensions:ResponsePartitionKey', responsePartitionKey_dimensions - A dimension map that contains the dimensions for this partition.

responsePartitionKey_dimensions :: Lens' ResponsePartitionKey (HashMap Text Text) Source #

A dimension map that contains the dimensions for this partition.

ResponseResourceMetric

data ResponseResourceMetric Source #

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

See: newResponseResourceMetric smart constructor.

Constructors

ResponseResourceMetric' 

Fields

Instances

Instances details
FromJSON ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

Generic ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

Associated Types

type Rep ResponseResourceMetric :: Type -> Type #

Read ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

Show ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

NFData ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

Methods

rnf :: ResponseResourceMetric -> () #

Eq ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

Hashable ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

type Rep ResponseResourceMetric Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetric

type Rep ResponseResourceMetric = D1 ('MetaData "ResponseResourceMetric" "Amazonka.Pi.Types.ResponseResourceMetric" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ResponseResourceMetric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newResponseResourceMetric :: ResponseResourceMetric Source #

Create a value of ResponseResourceMetric 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:description:ResponseResourceMetric', responseResourceMetric_description - The description of the metric.

$sel:metric:ResponseResourceMetric', responseResourceMetric_metric - The full name of the metric.

$sel:unit:ResponseResourceMetric', responseResourceMetric_unit - The unit of the metric.

ResponseResourceMetricKey

data ResponseResourceMetricKey Source #

An object describing a Performance Insights metric and one or more dimensions for that metric.

See: newResponseResourceMetricKey smart constructor.

Constructors

ResponseResourceMetricKey' 

Fields

  • dimensions :: Maybe (HashMap Text Text)

    The valid dimensions for the metric.

  • metric :: Text

    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.

    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.

Instances

Instances details
FromJSON ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Generic ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Associated Types

type Rep ResponseResourceMetricKey :: Type -> Type #

Read ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Show ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

NFData ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Eq ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Hashable ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

type Rep ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

type Rep ResponseResourceMetricKey = D1 ('MetaData "ResponseResourceMetricKey" "Amazonka.Pi.Types.ResponseResourceMetricKey" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ResponseResourceMetricKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newResponseResourceMetricKey Source #

Create a value of ResponseResourceMetricKey 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:dimensions:ResponseResourceMetricKey', responseResourceMetricKey_dimensions - The valid dimensions for the metric.

$sel:metric:ResponseResourceMetricKey', responseResourceMetricKey_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.
  • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

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.

responseResourceMetricKey_metric :: Lens' ResponseResourceMetricKey Text Source #

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.

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.