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

Contents

Service Configuration
Errors
DetailStatus
ServiceType
DataPoint
DimensionGroup
DimensionKeyDescription
DimensionKeyDetail
MetricKeyDataPoints
MetricQuery
ResponsePartitionKey
ResponseResourceMetricKey

Description

Synopsis

defaultService :: Service
_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError
newtype DetailStatus where
- DetailStatus' {
  - fromDetailStatus :: Text
  }
- pattern DetailStatus_AVAILABLE :: DetailStatus
- pattern DetailStatus_PROCESSING :: DetailStatus
- pattern DetailStatus_UNAVAILABLE :: DetailStatus
newtype ServiceType where
- ServiceType' {
  - fromServiceType :: Text
  }
- pattern ServiceType_RDS :: ServiceType
data DataPoint = DataPoint' {
- timestamp :: POSIX
- value :: Double
}
newDataPoint :: UTCTime -> Double -> DataPoint
dataPoint_timestamp :: Lens' DataPoint UTCTime
dataPoint_value :: Lens' DataPoint Double
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
data DimensionKeyDescription = DimensionKeyDescription' {
- partitions :: Maybe [Double]
- total :: Maybe Double
- dimensions :: Maybe (HashMap Text Text)
}
newDimensionKeyDescription :: DimensionKeyDescription
dimensionKeyDescription_partitions :: Lens' DimensionKeyDescription (Maybe [Double])
dimensionKeyDescription_total :: Lens' DimensionKeyDescription (Maybe Double)
dimensionKeyDescription_dimensions :: Lens' DimensionKeyDescription (Maybe (HashMap Text Text))
data DimensionKeyDetail = DimensionKeyDetail' {
- status :: Maybe DetailStatus
- dimension :: Maybe Text
- value :: Maybe Text
}
newDimensionKeyDetail :: DimensionKeyDetail
dimensionKeyDetail_status :: Lens' DimensionKeyDetail (Maybe DetailStatus)
dimensionKeyDetail_dimension :: Lens' DimensionKeyDetail (Maybe Text)
dimensionKeyDetail_value :: Lens' DimensionKeyDetail (Maybe Text)
data MetricKeyDataPoints = MetricKeyDataPoints' {
- dataPoints :: Maybe [DataPoint]
- key :: Maybe ResponseResourceMetricKey
}
newMetricKeyDataPoints :: MetricKeyDataPoints
metricKeyDataPoints_dataPoints :: Lens' MetricKeyDataPoints (Maybe [DataPoint])
metricKeyDataPoints_key :: Lens' MetricKeyDataPoints (Maybe ResponseResourceMetricKey)
data MetricQuery = MetricQuery' {
- groupBy :: Maybe DimensionGroup
- filter' :: Maybe (HashMap Text Text)
- metric :: Text
}
newMetricQuery :: Text -> MetricQuery
metricQuery_groupBy :: Lens' MetricQuery (Maybe DimensionGroup)
metricQuery_filter :: Lens' MetricQuery (Maybe (HashMap Text Text))
metricQuery_metric :: Lens' MetricQuery Text
data ResponsePartitionKey = ResponsePartitionKey' {
- dimensions :: HashMap Text Text
}
newResponsePartitionKey :: ResponsePartitionKey
responsePartitionKey_dimensions :: Lens' ResponsePartitionKey (HashMap Text Text)
data ResponseResourceMetricKey = ResponseResourceMetricKey' {
- dimensions :: Maybe (HashMap Text Text)
- metric :: Text
}
newResponseResourceMetricKey :: Text -> ResponseResourceMetricKey
responseResourceMetricKey_dimensions :: Lens' ResponseResourceMetricKey (Maybe (HashMap Text Text))
responseResourceMetricKey_metric :: Lens' ResponseResourceMetricKey Text

Service Configuration

defaultService :: Service Source #

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

Errors

_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One of the arguments provided is invalid for this request.

_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The user is not authorized to perform this request.

_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request failed due to an unknown error.

DetailStatus

newtype DetailStatus Source #

Constructors

DetailStatus'
Fields fromDetailStatus :: Text

Bundled Patterns

pattern DetailStatus_AVAILABLE :: DetailStatus
pattern DetailStatus_PROCESSING :: DetailStatus
pattern DetailStatus_UNAVAILABLE :: DetailStatus

Instances

Instances details

Eq DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods (==) :: DetailStatus -> DetailStatus -> Bool # (/=) :: DetailStatus -> DetailStatus -> Bool #
Ord DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods compare :: DetailStatus -> DetailStatus -> Ordering # (<) :: DetailStatus -> DetailStatus -> Bool # (<=) :: DetailStatus -> DetailStatus -> Bool # (>) :: DetailStatus -> DetailStatus -> Bool # (>=) :: DetailStatus -> DetailStatus -> Bool # max :: DetailStatus -> DetailStatus -> DetailStatus # min :: DetailStatus -> DetailStatus -> DetailStatus #
Read DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods readsPrec :: Int -> ReadS DetailStatus # readList :: ReadS [DetailStatus] # readPrec :: ReadPrec DetailStatus # readListPrec :: ReadPrec [DetailStatus] #
Show DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods showsPrec :: Int -> DetailStatus -> ShowS # show :: DetailStatus -> String # showList :: [DetailStatus] -> ShowS #
Generic DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Associated Types type Rep DetailStatus :: Type -> Type # Methods from :: DetailStatus -> Rep DetailStatus x # to :: Rep DetailStatus x -> DetailStatus #
NFData DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods rnf :: DetailStatus -> () #
Hashable DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods hashWithSalt :: Int -> DetailStatus -> Int # hash :: DetailStatus -> Int #
ToJSON DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toJSON :: DetailStatus -> Value # toEncoding :: DetailStatus -> Encoding # toJSONList :: [DetailStatus] -> Value # toEncodingList :: [DetailStatus] -> Encoding #
ToJSONKey DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toJSONKey :: ToJSONKeyFunction DetailStatus # toJSONKeyList :: ToJSONKeyFunction [DetailStatus] #
FromJSON DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods parseJSON :: Value -> Parser DetailStatus # parseJSONList :: Value -> Parser [DetailStatus] #
FromJSONKey DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods fromJSONKey :: FromJSONKeyFunction DetailStatus # fromJSONKeyList :: FromJSONKeyFunction [DetailStatus] #
ToLog DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods build :: DetailStatus -> ByteStringBuilder #
ToHeader DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toHeader :: HeaderName -> DetailStatus -> [Header] #
ToQuery DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toQuery :: DetailStatus -> QueryString #
FromXML DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods parseXML :: [Node] -> Either String DetailStatus #
ToXML DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toXML :: DetailStatus -> XML #
ToByteString DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toBS :: DetailStatus -> ByteString #
FromText DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods fromText :: Text -> Either String DetailStatus #
ToText DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus Methods toText :: DetailStatus -> Text #
type Rep DetailStatus Source #
Instance details Defined in Amazonka.Pi.Types.DetailStatus type Rep DetailStatus = D1 ('MetaData "DetailStatus" "Amazonka.Pi.Types.DetailStatus" "libZSservicesZSamazonka-piZSamazonka-pi" 'True) (C1 ('MetaCons "DetailStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDetailStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceType

newtype ServiceType Source #

Constructors

ServiceType'
Fields fromServiceType :: Text

Bundled Patterns

pattern ServiceType_RDS :: ServiceType

Instances

Instances details

Eq ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods (==) :: ServiceType -> ServiceType -> Bool # (/=) :: ServiceType -> ServiceType -> Bool #
Ord ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods compare :: ServiceType -> ServiceType -> Ordering # (<) :: ServiceType -> ServiceType -> Bool # (<=) :: ServiceType -> ServiceType -> Bool # (>) :: ServiceType -> ServiceType -> Bool # (>=) :: ServiceType -> ServiceType -> Bool # max :: ServiceType -> ServiceType -> ServiceType # min :: ServiceType -> ServiceType -> ServiceType #
Read ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods readsPrec :: Int -> ReadS ServiceType # readList :: ReadS [ServiceType] # readPrec :: ReadPrec ServiceType # readListPrec :: ReadPrec [ServiceType] #
Show ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods showsPrec :: Int -> ServiceType -> ShowS # show :: ServiceType -> String # showList :: [ServiceType] -> ShowS #
Generic ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Associated Types type Rep ServiceType :: Type -> Type # Methods from :: ServiceType -> Rep ServiceType x # to :: Rep ServiceType x -> ServiceType #
NFData ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods rnf :: ServiceType -> () #
Hashable ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods hashWithSalt :: Int -> ServiceType -> Int # hash :: ServiceType -> Int #
ToJSON ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toJSON :: ServiceType -> Value # toEncoding :: ServiceType -> Encoding # toJSONList :: [ServiceType] -> Value # toEncodingList :: [ServiceType] -> Encoding #
ToJSONKey ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toJSONKey :: ToJSONKeyFunction ServiceType # toJSONKeyList :: ToJSONKeyFunction [ServiceType] #
FromJSON ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods parseJSON :: Value -> Parser ServiceType # parseJSONList :: Value -> Parser [ServiceType] #
FromJSONKey ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods fromJSONKey :: FromJSONKeyFunction ServiceType # fromJSONKeyList :: FromJSONKeyFunction [ServiceType] #
ToLog ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods build :: ServiceType -> ByteStringBuilder #
ToHeader ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toHeader :: HeaderName -> ServiceType -> [Header] #
ToQuery ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toQuery :: ServiceType -> QueryString #
FromXML ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods parseXML :: [Node] -> Either String ServiceType #
ToXML ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toXML :: ServiceType -> XML #
ToByteString ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toBS :: ServiceType -> ByteString #
FromText ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods fromText :: Text -> Either String ServiceType #
ToText ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType Methods toText :: ServiceType -> Text #
type Rep ServiceType Source #
Instance details Defined in Amazonka.Pi.Types.ServiceType type Rep ServiceType = D1 ('MetaData "ServiceType" "Amazonka.Pi.Types.ServiceType" "libZSservicesZSamazonka-piZSamazonka-pi" '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

Eq DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Methods (==) :: DataPoint -> DataPoint -> Bool # (/=) :: DataPoint -> DataPoint -> Bool #
Read DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Methods readsPrec :: Int -> ReadS DataPoint # readList :: ReadS [DataPoint] # readPrec :: ReadPrec DataPoint # readListPrec :: ReadPrec [DataPoint] #
Show DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Methods showsPrec :: Int -> DataPoint -> ShowS # show :: DataPoint -> String # showList :: [DataPoint] -> ShowS #
Generic DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Associated Types type Rep DataPoint :: Type -> Type # Methods from :: DataPoint -> Rep DataPoint x # to :: Rep DataPoint x -> DataPoint #
NFData DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Methods rnf :: DataPoint -> () #
Hashable DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Methods hashWithSalt :: Int -> DataPoint -> Int # hash :: DataPoint -> Int #
FromJSON DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint Methods parseJSON :: Value -> Parser DataPoint # parseJSONList :: Value -> Parser [DataPoint] #
type Rep DataPoint Source #
Instance details Defined in Amazonka.Pi.Types.DataPoint type Rep DataPoint = D1 ('MetaData "DataPoint" "Amazonka.Pi.Types.DataPoint" "libZSservicesZSamazonka-piZSamazonka-pi" '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 #

Arguments

:: UTCTime	`$sel:timestamp:DataPoint'`
-> Double	`$sel:value:DataPoint'`
-> DataPoint

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.

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

DimensionKeyDescription

data DimensionKeyDescription Source #

An array of descriptions and aggregated values for each dimension within a dimension group.

See: newDimensionKeyDescription smart constructor.

Constructors

DimensionKeyDescription'
Fields partitions :: Maybe [Double] If `PartitionBy` was specified, `PartitionKeys` contains the dimensions that were. total :: Maybe Double The aggregated metric value for the dimension(s), over the requested time range. dimensions :: Maybe (HashMap Text Text) A map of name-value pairs for the dimensions in the group.

Instances

Instances details

Eq DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Methods (==) :: DimensionKeyDescription -> DimensionKeyDescription -> Bool # (/=) :: DimensionKeyDescription -> DimensionKeyDescription -> Bool #
Read DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Methods readsPrec :: Int -> ReadS DimensionKeyDescription # readList :: ReadS [DimensionKeyDescription] # readPrec :: ReadPrec DimensionKeyDescription # readListPrec :: ReadPrec [DimensionKeyDescription] #
Show DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Methods showsPrec :: Int -> DimensionKeyDescription -> ShowS # show :: DimensionKeyDescription -> String # showList :: [DimensionKeyDescription] -> ShowS #
Generic DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Associated Types type Rep DimensionKeyDescription :: Type -> Type # Methods from :: DimensionKeyDescription -> Rep DimensionKeyDescription x # to :: Rep DimensionKeyDescription x -> DimensionKeyDescription #
NFData DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Methods rnf :: DimensionKeyDescription -> () #
Hashable DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Methods hashWithSalt :: Int -> DimensionKeyDescription -> Int # hash :: DimensionKeyDescription -> Int #
FromJSON DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription Methods parseJSON :: Value -> Parser DimensionKeyDescription # parseJSONList :: Value -> Parser [DimensionKeyDescription] #
type Rep DimensionKeyDescription Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDescription type Rep DimensionKeyDescription = D1 ('MetaData "DimensionKeyDescription" "Amazonka.Pi.Types.DimensionKeyDescription" "libZSservicesZSamazonka-piZSamazonka-pi" 'False) (C1 ('MetaCons "DimensionKeyDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "partitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :: (S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

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: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 dimension(s), over the requested time range.

$sel:dimensions:DimensionKeyDescription', dimensionKeyDescription_dimensions - 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 dimension(s), over the requested time range.

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

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

DimensionKeyDetail

data DimensionKeyDetail Source #

An object that describes the details for a specified dimension.

See: newDimensionKeyDetail smart constructor.

Constructors

DimensionKeyDetail'

Fields

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 for db.sql.statement has the status PROCESSING, Performance Insights returns the truncated query.
- UNAVAILABLE - The dimension detail data could not be collected successfully.
dimension :: Maybe Text
The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement.
value :: Maybe Text
The value of the dimension detail data. For the db.sql.statement dimension, this value is either the full or truncated SQL query, depending on the return status.

Instances

Instances details

Eq DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Methods (==) :: DimensionKeyDetail -> DimensionKeyDetail -> Bool # (/=) :: DimensionKeyDetail -> DimensionKeyDetail -> Bool #
Read DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Methods readsPrec :: Int -> ReadS DimensionKeyDetail # readList :: ReadS [DimensionKeyDetail] # readPrec :: ReadPrec DimensionKeyDetail # readListPrec :: ReadPrec [DimensionKeyDetail] #
Show DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Methods showsPrec :: Int -> DimensionKeyDetail -> ShowS # show :: DimensionKeyDetail -> String # showList :: [DimensionKeyDetail] -> ShowS #
Generic DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Associated Types type Rep DimensionKeyDetail :: Type -> Type # Methods from :: DimensionKeyDetail -> Rep DimensionKeyDetail x # to :: Rep DimensionKeyDetail x -> DimensionKeyDetail #
NFData DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Methods rnf :: DimensionKeyDetail -> () #
Hashable DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Methods hashWithSalt :: Int -> DimensionKeyDetail -> Int # hash :: DimensionKeyDetail -> Int #
FromJSON DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail Methods parseJSON :: Value -> Parser DimensionKeyDetail # parseJSONList :: Value -> Parser [DimensionKeyDetail] #
type Rep DimensionKeyDetail Source #
Instance details Defined in Amazonka.Pi.Types.DimensionKeyDetail type Rep DimensionKeyDetail = D1 ('MetaData "DimensionKeyDetail" "Amazonka.Pi.Types.DimensionKeyDetail" "libZSservicesZSamazonka-piZSamazonka-pi" 'False) (C1 ('MetaCons "DimensionKeyDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetailStatus)) :: (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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: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 for db.sql.statement has the status PROCESSING, Performance Insights returns the truncated query.
UNAVAILABLE - The dimension detail data could not be collected successfully.

$sel:dimension:DimensionKeyDetail', dimensionKeyDetail_dimension - The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement.

$sel:value:DimensionKeyDetail', dimensionKeyDetail_value - The value of the dimension detail data. For the db.sql.statement dimension, this value is either the full or truncated SQL query, depending on the return status.

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 for db.sql.statement has the status PROCESSING, Performance Insights returns the truncated query.
UNAVAILABLE - The dimension detail data could not be collected successfully.

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

The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement.

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

The value of the dimension detail data. For the db.sql.statement dimension, this value is either the full or truncated SQL query, depending on the return status.

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 dataPoints :: Maybe [DataPoint] An array of timestamp-value pairs, representing measurements over a period of time. key :: Maybe ResponseResourceMetricKey The dimension(s) to which the data points apply.

Instances

Instances details

Eq MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Methods (==) :: MetricKeyDataPoints -> MetricKeyDataPoints -> Bool # (/=) :: MetricKeyDataPoints -> MetricKeyDataPoints -> Bool #
Read MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Methods readsPrec :: Int -> ReadS MetricKeyDataPoints # readList :: ReadS [MetricKeyDataPoints] # readPrec :: ReadPrec MetricKeyDataPoints # readListPrec :: ReadPrec [MetricKeyDataPoints] #
Show MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Methods showsPrec :: Int -> MetricKeyDataPoints -> ShowS # show :: MetricKeyDataPoints -> String # showList :: [MetricKeyDataPoints] -> ShowS #
Generic MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Associated Types type Rep MetricKeyDataPoints :: Type -> Type # Methods from :: MetricKeyDataPoints -> Rep MetricKeyDataPoints x # to :: Rep MetricKeyDataPoints x -> MetricKeyDataPoints #
NFData MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Methods rnf :: MetricKeyDataPoints -> () #
Hashable MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Methods hashWithSalt :: Int -> MetricKeyDataPoints -> Int # hash :: MetricKeyDataPoints -> Int #
FromJSON MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints Methods parseJSON :: Value -> Parser MetricKeyDataPoints # parseJSONList :: Value -> Parser [MetricKeyDataPoints] #
type Rep MetricKeyDataPoints Source #
Instance details Defined in Amazonka.Pi.Types.MetricKeyDataPoints type Rep MetricKeyDataPoints = D1 ('MetaData "MetricKeyDataPoints" "Amazonka.Pi.Types.MetricKeyDataPoints" "libZSservicesZSamazonka-piZSamazonka-pi" '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 dimension(s) 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 dimension(s) 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 of the data points for that metric. You can optionally 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

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

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

newMetricQuery Source #

Arguments

:: Text	`$sel:metric:MetricQuery'`
-> MetricQuery

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

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

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 dimensions :: HashMap Text Text A dimension map that contains the dimension(s) for this partition.

Instances

Instances details

Eq ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Methods (==) :: ResponsePartitionKey -> ResponsePartitionKey -> Bool # (/=) :: ResponsePartitionKey -> ResponsePartitionKey -> Bool #
Read ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Methods readsPrec :: Int -> ReadS ResponsePartitionKey # readList :: ReadS [ResponsePartitionKey] # readPrec :: ReadPrec ResponsePartitionKey # readListPrec :: ReadPrec [ResponsePartitionKey] #
Show ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Methods showsPrec :: Int -> ResponsePartitionKey -> ShowS # show :: ResponsePartitionKey -> String # showList :: [ResponsePartitionKey] -> ShowS #
Generic ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Associated Types type Rep ResponsePartitionKey :: Type -> Type # Methods from :: ResponsePartitionKey -> Rep ResponsePartitionKey x # to :: Rep ResponsePartitionKey x -> ResponsePartitionKey #
NFData ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Methods rnf :: ResponsePartitionKey -> () #
Hashable ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Methods hashWithSalt :: Int -> ResponsePartitionKey -> Int # hash :: ResponsePartitionKey -> Int #
FromJSON ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey Methods parseJSON :: Value -> Parser ResponsePartitionKey # parseJSONList :: Value -> Parser [ResponsePartitionKey] #
type Rep ResponsePartitionKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponsePartitionKey type Rep ResponsePartitionKey = D1 ('MetaData "ResponsePartitionKey" "Amazonka.Pi.Types.ResponsePartitionKey" "libZSservicesZSamazonka-piZSamazonka-pi" '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 dimension(s) for this partition.

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

A dimension map that contains the dimension(s) for this partition.

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

Eq ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Methods (==) :: ResponseResourceMetricKey -> ResponseResourceMetricKey -> Bool # (/=) :: ResponseResourceMetricKey -> ResponseResourceMetricKey -> Bool #
Read ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Methods readsPrec :: Int -> ReadS ResponseResourceMetricKey # readList :: ReadS [ResponseResourceMetricKey] # readPrec :: ReadPrec ResponseResourceMetricKey # readListPrec :: ReadPrec [ResponseResourceMetricKey] #
Show ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Methods showsPrec :: Int -> ResponseResourceMetricKey -> ShowS # show :: ResponseResourceMetricKey -> String # showList :: [ResponseResourceMetricKey] -> ShowS #
Generic ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Associated Types type Rep ResponseResourceMetricKey :: Type -> Type # Methods from :: ResponseResourceMetricKey -> Rep ResponseResourceMetricKey x # to :: Rep ResponseResourceMetricKey x -> ResponseResourceMetricKey #
NFData ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Methods rnf :: ResponseResourceMetricKey -> () #
Hashable ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Methods hashWithSalt :: Int -> ResponseResourceMetricKey -> Int # hash :: ResponseResourceMetricKey -> Int #
FromJSON ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey Methods parseJSON :: Value -> Parser ResponseResourceMetricKey # parseJSONList :: Value -> Parser [ResponseResourceMetricKey] #
type Rep ResponseResourceMetricKey Source #
Instance details Defined in Amazonka.Pi.Types.ResponseResourceMetricKey type Rep ResponseResourceMetricKey = D1 ('MetaData "ResponseResourceMetricKey" "Amazonka.Pi.Types.ResponseResourceMetricKey" "libZSservicesZSamazonka-piZSamazonka-pi" '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 #

Arguments

:: Text	`$sel:metric:ResponseResourceMetricKey'`
-> ResponseResourceMetricKey

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.

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_dimensions :: Lens' ResponseResourceMetricKey (Maybe (HashMap Text Text)) Source #

The valid dimensions for the metric.

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.

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.