Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.Pi.Types
Contents
Description
Synopsis
- defaultService :: Service
- _InternalServiceError :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _NotAuthorizedException :: AsError a => Fold a ServiceError
- newtype DetailStatus where
- DetailStatus' { }
- pattern DetailStatus_AVAILABLE :: DetailStatus
- pattern DetailStatus_PROCESSING :: DetailStatus
- pattern DetailStatus_UNAVAILABLE :: DetailStatus
- newtype FeatureStatus where
- FeatureStatus' { }
- pattern FeatureStatus_DISABLED :: FeatureStatus
- pattern FeatureStatus_DISABLED_PENDING_REBOOT :: FeatureStatus
- pattern FeatureStatus_ENABLED :: FeatureStatus
- pattern FeatureStatus_ENABLED_PENDING_REBOOT :: FeatureStatus
- pattern FeatureStatus_UNKNOWN :: FeatureStatus
- pattern FeatureStatus_UNSUPPORTED :: FeatureStatus
- newtype ServiceType where
- ServiceType' { }
- pattern ServiceType_DOCDB :: ServiceType
- pattern ServiceType_RDS :: ServiceType
- data DataPoint = DataPoint' {}
- newDataPoint :: UTCTime -> Double -> DataPoint
- dataPoint_timestamp :: Lens' DataPoint UTCTime
- dataPoint_value :: Lens' DataPoint Double
- data DimensionDetail = DimensionDetail' {
- identifier :: Maybe Text
- newDimensionDetail :: DimensionDetail
- dimensionDetail_identifier :: Lens' DimensionDetail (Maybe Text)
- data DimensionGroup = DimensionGroup' {}
- newDimensionGroup :: Text -> DimensionGroup
- dimensionGroup_dimensions :: Lens' DimensionGroup (Maybe (NonEmpty Text))
- dimensionGroup_limit :: Lens' DimensionGroup (Maybe Natural)
- dimensionGroup_group :: Lens' DimensionGroup Text
- data DimensionGroupDetail = DimensionGroupDetail' {
- dimensions :: Maybe [DimensionDetail]
- group' :: Maybe Text
- newDimensionGroupDetail :: DimensionGroupDetail
- dimensionGroupDetail_dimensions :: Lens' DimensionGroupDetail (Maybe [DimensionDetail])
- dimensionGroupDetail_group :: Lens' DimensionGroupDetail (Maybe Text)
- data DimensionKeyDescription = DimensionKeyDescription' {}
- newDimensionKeyDescription :: DimensionKeyDescription
- dimensionKeyDescription_additionalMetrics :: Lens' DimensionKeyDescription (Maybe (HashMap Text Double))
- dimensionKeyDescription_dimensions :: Lens' DimensionKeyDescription (Maybe (HashMap Text Text))
- dimensionKeyDescription_partitions :: Lens' DimensionKeyDescription (Maybe [Double])
- dimensionKeyDescription_total :: Lens' DimensionKeyDescription (Maybe Double)
- data DimensionKeyDetail = DimensionKeyDetail' {}
- newDimensionKeyDetail :: DimensionKeyDetail
- dimensionKeyDetail_dimension :: Lens' DimensionKeyDetail (Maybe Text)
- dimensionKeyDetail_status :: Lens' DimensionKeyDetail (Maybe DetailStatus)
- dimensionKeyDetail_value :: Lens' DimensionKeyDetail (Maybe Text)
- data FeatureMetadata = FeatureMetadata' {}
- newFeatureMetadata :: FeatureMetadata
- featureMetadata_status :: Lens' FeatureMetadata (Maybe FeatureStatus)
- data MetricDimensionGroups = MetricDimensionGroups' {}
- newMetricDimensionGroups :: MetricDimensionGroups
- metricDimensionGroups_groups :: Lens' MetricDimensionGroups (Maybe [DimensionGroupDetail])
- metricDimensionGroups_metric :: Lens' MetricDimensionGroups (Maybe Text)
- data MetricKeyDataPoints = MetricKeyDataPoints' {}
- newMetricKeyDataPoints :: MetricKeyDataPoints
- metricKeyDataPoints_dataPoints :: Lens' MetricKeyDataPoints (Maybe [DataPoint])
- metricKeyDataPoints_key :: Lens' MetricKeyDataPoints (Maybe ResponseResourceMetricKey)
- data MetricQuery = MetricQuery' {}
- newMetricQuery :: Text -> MetricQuery
- metricQuery_filter :: Lens' MetricQuery (Maybe (HashMap Text Text))
- metricQuery_groupBy :: Lens' MetricQuery (Maybe DimensionGroup)
- metricQuery_metric :: Lens' MetricQuery Text
- data ResponsePartitionKey = ResponsePartitionKey' {}
- newResponsePartitionKey :: ResponsePartitionKey
- responsePartitionKey_dimensions :: Lens' ResponsePartitionKey (HashMap Text Text)
- data ResponseResourceMetric = ResponseResourceMetric' {}
- newResponseResourceMetric :: ResponseResourceMetric
- responseResourceMetric_description :: Lens' ResponseResourceMetric (Maybe Text)
- responseResourceMetric_metric :: Lens' ResponseResourceMetric (Maybe Text)
- responseResourceMetric_unit :: Lens' ResponseResourceMetric (Maybe Text)
- data ResponseResourceMetricKey = ResponseResourceMetricKey' {}
- 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
_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' | |
Fields |
Bundled Patterns
pattern DetailStatus_AVAILABLE :: DetailStatus | |
pattern DetailStatus_PROCESSING :: DetailStatus | |
pattern DetailStatus_UNAVAILABLE :: DetailStatus |
Instances
FeatureStatus
newtype FeatureStatus Source #
Constructors
FeatureStatus' | |
Fields |
Bundled Patterns
pattern FeatureStatus_DISABLED :: FeatureStatus | |
pattern FeatureStatus_DISABLED_PENDING_REBOOT :: FeatureStatus | |
pattern FeatureStatus_ENABLED :: FeatureStatus | |
pattern FeatureStatus_ENABLED_PENDING_REBOOT :: FeatureStatus | |
pattern FeatureStatus_UNKNOWN :: FeatureStatus | |
pattern FeatureStatus_UNSUPPORTED :: FeatureStatus |
Instances
ServiceType
newtype ServiceType Source #
Constructors
ServiceType' | |
Fields |
Bundled Patterns
pattern ServiceType_DOCDB :: ServiceType | |
pattern ServiceType_RDS :: ServiceType |
Instances
DataPoint
A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
See: newDataPoint
smart constructor.
Constructors
DataPoint' | |
Instances
FromJSON DataPoint Source # | |
Generic DataPoint Source # | |
Read DataPoint Source # | |
Show DataPoint Source # | |
NFData DataPoint Source # | |
Defined in Amazonka.Pi.Types.DataPoint | |
Eq DataPoint Source # | |
Hashable DataPoint Source # | |
Defined in Amazonka.Pi.Types.DataPoint | |
type Rep DataPoint Source # | |
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))) |
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
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.
dimensionDetail_identifier :: Lens' DimensionDetail (Maybe Text) Source #
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 withpi-
.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
|
Instances
Arguments
:: Text | |
-> 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: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 withpi-
(all engines except Amazon DocumentDB).db.sql.statement
- The full text of the SQL statement that is running, as inSELECT * 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 aspi-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 inSELECT * 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 withpi-
(all engines except Amazon DocumentDB).db.sql.statement
- The full text of the SQL statement that is running, as inSELECT * 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 aspi-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 inSELECT * 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
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.
dimensionGroupDetail_dimensions :: Lens' DimensionGroupDetail (Maybe [DimensionDetail]) Source #
The dimensions within a dimension group.
dimensionGroupDetail_group :: Lens' DimensionGroupDetail (Maybe Text) Source #
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
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
|
Instances
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 statusPROCESSING
, 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 statusPROCESSING
, 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
|
Instances
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' | |
Instances
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
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
|
Instances
Arguments
:: Text | |
-> 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: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
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' | |
Instances
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.
responseResourceMetric_description :: Lens' ResponseResourceMetric (Maybe Text) Source #
The description of the metric.
responseResourceMetric_metric :: Lens' ResponseResourceMetric (Maybe Text) Source #
The full name of the metric.
responseResourceMetric_unit :: Lens' ResponseResourceMetric (Maybe Text) Source #
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
|
Instances
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_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.- 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.