| 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
Description
Derived from API version 2018-02-27 of the AWS service descriptions, licensed under Apache 2.0.
Amazon RDS Performance Insights
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
- To learn more about Performance Insights and Amazon Aurora DB instances, go to the <https:docs.aws.amazon.comAmazonRDSlatestAuroraUserGuideUSER_PerfInsights.html Amazon Aurora User Guide> .
- To learn more about Performance Insights and Amazon RDS DB instances, go to the <https:docs.aws.amazon.comAmazonRDSlatestUserGuideUSER_PerfInsights.html Amazon RDS User Guide> .
- To learn more about Performance Insights and Amazon DocumentDB clusters, go to the <https:docs.aws.amazon.comdocumentdblatestdeveloperguideperformance-insights.html Amazon DocumentDB Developer Guide> .
Synopsis
- defaultService :: Service
- _InternalServiceError :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _NotAuthorizedException :: AsError a => Fold a ServiceError
- data DescribeDimensionKeys = DescribeDimensionKeys' (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe Text) (Maybe DimensionGroup) (Maybe Int) ServiceType Text POSIX POSIX Text DimensionGroup
- newDescribeDimensionKeys :: ServiceType -> Text -> UTCTime -> UTCTime -> Text -> DimensionGroup -> DescribeDimensionKeys
- data DescribeDimensionKeysResponse = DescribeDimensionKeysResponse' (Maybe POSIX) (Maybe POSIX) (Maybe [DimensionKeyDescription]) (Maybe Text) (Maybe [ResponsePartitionKey]) Int
- newDescribeDimensionKeysResponse :: Int -> DescribeDimensionKeysResponse
- data GetDimensionKeyDetails = GetDimensionKeyDetails' (Maybe (NonEmpty Text)) ServiceType Text Text Text
- newGetDimensionKeyDetails :: ServiceType -> Text -> Text -> Text -> GetDimensionKeyDetails
- data GetDimensionKeyDetailsResponse = GetDimensionKeyDetailsResponse' (Maybe [DimensionKeyDetail]) Int
- newGetDimensionKeyDetailsResponse :: Int -> GetDimensionKeyDetailsResponse
- data GetResourceMetadata = GetResourceMetadata' ServiceType Text
- newGetResourceMetadata :: ServiceType -> Text -> GetResourceMetadata
- data GetResourceMetadataResponse = GetResourceMetadataResponse' (Maybe (HashMap Text FeatureMetadata)) (Maybe Text) Int
- newGetResourceMetadataResponse :: Int -> GetResourceMetadataResponse
- data GetResourceMetrics = GetResourceMetrics' (Maybe Natural) (Maybe Text) (Maybe Int) ServiceType Text (NonEmpty MetricQuery) POSIX POSIX
- newGetResourceMetrics :: ServiceType -> Text -> NonEmpty MetricQuery -> UTCTime -> UTCTime -> GetResourceMetrics
- data GetResourceMetricsResponse = GetResourceMetricsResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe [MetricKeyDataPoints]) (Maybe Text) Int
- newGetResourceMetricsResponse :: Int -> GetResourceMetricsResponse
- data ListAvailableResourceDimensions = ListAvailableResourceDimensions' (Maybe Natural) (Maybe Text) ServiceType Text (NonEmpty Text)
- newListAvailableResourceDimensions :: ServiceType -> Text -> NonEmpty Text -> ListAvailableResourceDimensions
- data ListAvailableResourceDimensionsResponse = ListAvailableResourceDimensionsResponse' (Maybe [MetricDimensionGroups]) (Maybe Text) Int
- newListAvailableResourceDimensionsResponse :: Int -> ListAvailableResourceDimensionsResponse
- data ListAvailableResourceMetrics = ListAvailableResourceMetrics' (Maybe Natural) (Maybe Text) ServiceType Text [Text]
- newListAvailableResourceMetrics :: ServiceType -> Text -> ListAvailableResourceMetrics
- data ListAvailableResourceMetricsResponse = ListAvailableResourceMetricsResponse' (Maybe [ResponseResourceMetric]) (Maybe Text) Int
- newListAvailableResourceMetricsResponse :: Int -> ListAvailableResourceMetricsResponse
- 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' POSIX Double
- newDataPoint :: UTCTime -> Double -> DataPoint
- data DimensionDetail = DimensionDetail' (Maybe Text)
- newDimensionDetail :: DimensionDetail
- data DimensionGroup = DimensionGroup' (Maybe (NonEmpty Text)) (Maybe Natural) Text
- newDimensionGroup :: Text -> DimensionGroup
- data DimensionGroupDetail = DimensionGroupDetail' (Maybe [DimensionDetail]) (Maybe Text)
- newDimensionGroupDetail :: DimensionGroupDetail
- data DimensionKeyDescription = DimensionKeyDescription' (Maybe (HashMap Text Double)) (Maybe (HashMap Text Text)) (Maybe [Double]) (Maybe Double)
- newDimensionKeyDescription :: DimensionKeyDescription
- data DimensionKeyDetail = DimensionKeyDetail' (Maybe Text) (Maybe DetailStatus) (Maybe Text)
- newDimensionKeyDetail :: DimensionKeyDetail
- data FeatureMetadata = FeatureMetadata' (Maybe FeatureStatus)
- newFeatureMetadata :: FeatureMetadata
- data MetricDimensionGroups = MetricDimensionGroups' (Maybe [DimensionGroupDetail]) (Maybe Text)
- newMetricDimensionGroups :: MetricDimensionGroups
- data MetricKeyDataPoints = MetricKeyDataPoints' (Maybe [DataPoint]) (Maybe ResponseResourceMetricKey)
- newMetricKeyDataPoints :: MetricKeyDataPoints
- data MetricQuery = MetricQuery' (Maybe (HashMap Text Text)) (Maybe DimensionGroup) Text
- newMetricQuery :: Text -> MetricQuery
- data ResponsePartitionKey = ResponsePartitionKey' (HashMap Text Text)
- newResponsePartitionKey :: ResponsePartitionKey
- data ResponseResourceMetric = ResponseResourceMetric' (Maybe Text) (Maybe Text) (Maybe Text)
- newResponseResourceMetric :: ResponseResourceMetric
- data ResponseResourceMetricKey = ResponseResourceMetricKey' (Maybe (HashMap Text Text)) Text
- newResponseResourceMetricKey :: Text -> ResponseResourceMetricKey
Service Configuration
defaultService :: Service Source #
API version 2018-02-27 of the Amazon Performance Insights SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Pi.
InternalServiceError
_InternalServiceError :: AsError a => Fold a ServiceError Source #
The request failed due to an unknown error.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
One of the arguments provided is invalid for this request.
NotAuthorizedException
_NotAuthorizedException :: AsError a => Fold a ServiceError Source #
The user is not authorized to perform this request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeDimensionKeys
data DescribeDimensionKeys Source #
See: newDescribeDimensionKeys smart constructor.
Constructors
| DescribeDimensionKeys' (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe Text) (Maybe DimensionGroup) (Maybe Int) ServiceType Text POSIX POSIX Text DimensionGroup |
Instances
newDescribeDimensionKeys Source #
Arguments
| :: ServiceType | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> DimensionGroup | |
| -> DescribeDimensionKeys |
Create a value of DescribeDimensionKeys 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:
DescribeDimensionKeys, describeDimensionKeys_additionalMetrics - Additional metrics for the top N dimension keys. If the specified
dimension group in the GroupBy parameter is db.sql_tokenized, you
can specify per-SQL metrics to get the values for the top N SQL
digests. The response syntax is as follows:
"AdditionalMetrics" : { "string" : "string" }.
DescribeDimensionKeys, describeDimensionKeys_filter - One or more filters to apply in the request. Restrictions:
- Any number of filters by the same dimension, as specified in the
GroupByorPartitionparameters. - A single filter for any other dimension in this dimension group.
$sel:maxResults:DescribeDimensionKeys', describeDimensionKeys_maxResults - The maximum number of items to return in the response. If more items
exist than the specified MaxRecords value, a pagination token is
included in the response so that the remaining results can be retrieved.
DescribeDimensionKeys, describeDimensionKeys_nextToken - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by MaxRecords.
$sel:partitionBy:DescribeDimensionKeys', describeDimensionKeys_partitionBy - For each dimension specified in GroupBy, specify a secondary dimension
to further subdivide the partition keys in the response.
$sel:periodInSeconds:DescribeDimensionKeys', describeDimensionKeys_periodInSeconds - The granularity, in seconds, of the data points returned from
Performance Insights. A period can be as short as one second, or as long
as one day (86400 seconds). Valid values are:
1(one second)60(one minute)300(five minutes)3600(one hour)86400(twenty-four hours)
If you don't specify PeriodInSeconds, then Performance Insights
chooses a value for you, with a goal of returning roughly 100-200 data
points in the response.
$sel:serviceType:DescribeDimensionKeys', describeDimensionKeys_serviceType - The Amazon Web Services service for which Performance Insights will
return metrics. Valid values are as follows:
RDS
DOCDB
DescribeDimensionKeys, describeDimensionKeys_identifier - An immutable, Amazon Web Services Region-unique identifier for a data
source. Performance Insights gathers metrics from this data source.
To use an Amazon RDS instance as a data source, you specify its
DbiResourceId value. For example, specify
db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
$sel:startTime:DescribeDimensionKeys', describeDimensionKeys_startTime - The date and time specifying the beginning of the requested time series
data. You must specify a StartTime within the past 7 days. The value
specified is inclusive, which means that data points equal to or
greater than StartTime are returned.
The value for StartTime must be earlier than the value for EndTime.
$sel:endTime:DescribeDimensionKeys', describeDimensionKeys_endTime - The date and time specifying the end of the requested time series data.
The value specified is exclusive, which means that data points less
than (but not equal to) EndTime are returned.
The value for EndTime must be later than the value for StartTime.
DescribeDimensionKeys, describeDimensionKeys_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.
DescribeDimensionKeys, describeDimensionKeys_groupBy - A specification for how to aggregate the data points from a query
result. You must specify a valid dimension group. Performance Insights
returns all dimensions within this group, unless you provide the names
of specific dimensions within this group. You can also request that
Performance Insights return a limited number of values for a dimension.
data DescribeDimensionKeysResponse Source #
See: newDescribeDimensionKeysResponse smart constructor.
Constructors
| DescribeDimensionKeysResponse' (Maybe POSIX) (Maybe POSIX) (Maybe [DimensionKeyDescription]) (Maybe Text) (Maybe [ResponsePartitionKey]) Int |
Instances
newDescribeDimensionKeysResponse Source #
Create a value of DescribeDimensionKeysResponse 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:alignedEndTime:DescribeDimensionKeysResponse', describeDimensionKeysResponse_alignedEndTime - The end time for the returned dimension keys, after alignment to a
granular boundary (as specified by PeriodInSeconds). AlignedEndTime
will be greater than or equal to the value of the user-specified
Endtime.
$sel:alignedStartTime:DescribeDimensionKeysResponse', describeDimensionKeysResponse_alignedStartTime - The start time for the returned dimension keys, after alignment to a
granular boundary (as specified by PeriodInSeconds).
AlignedStartTime will be less than or equal to the value of the
user-specified StartTime.
$sel:keys:DescribeDimensionKeysResponse', describeDimensionKeysResponse_keys - The dimension keys that were requested.
DescribeDimensionKeys, describeDimensionKeysResponse_nextToken - A pagination token that indicates the response didn’t return all
available records because MaxRecords was specified in the previous
request. To get the remaining records, specify NextToken in a separate
request with this value.
$sel:partitionKeys:DescribeDimensionKeysResponse', describeDimensionKeysResponse_partitionKeys - If PartitionBy was present in the request, PartitionKeys contains
the breakdown of dimension keys by the specified partitions.
$sel:httpStatus:DescribeDimensionKeysResponse', describeDimensionKeysResponse_httpStatus - The response's http status code.
GetDimensionKeyDetails
data GetDimensionKeyDetails Source #
See: newGetDimensionKeyDetails smart constructor.
Constructors
| GetDimensionKeyDetails' (Maybe (NonEmpty Text)) ServiceType Text Text Text |
Instances
newGetDimensionKeyDetails Source #
Arguments
| :: ServiceType | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> GetDimensionKeyDetails |
Create a value of GetDimensionKeyDetails 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:requestedDimensions:GetDimensionKeyDetails', getDimensionKeyDetails_requestedDimensions - A list of dimensions to retrieve the detail data for within the given
dimension group. If you don't specify this parameter, Performance
Insights returns all dimension data within the specified dimension
group. Specify dimension names for the following dimension groups:
db.sql- Specify either the full dimension namedb.sql.statementor the short dimension namestatement(Aurora and RDS only).db.query- Specify either the full dimension namedb.query.statementor the short dimension namestatement(DocumentDB only).
$sel:serviceType:GetDimensionKeyDetails', getDimensionKeyDetails_serviceType - The Amazon Web Services service for which Performance Insights returns
data. The only valid value is RDS.
GetDimensionKeyDetails, getDimensionKeyDetails_identifier - The ID for a data source from which to gather dimension data. This ID
must be immutable and unique within an Amazon Web Services Region. When
a DB instance is the data source, specify its DbiResourceId value. For
example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
GetDimensionKeyDetails, getDimensionKeyDetails_group - The name of the dimension group. Performance Insights searches the
specified group for the dimension group ID. The following group name
values are valid:
db.query(Amazon DocumentDB only)db.sql(Amazon RDS and Aurora only)
$sel:groupIdentifier:GetDimensionKeyDetails', getDimensionKeyDetails_groupIdentifier - The ID of the dimension group from which to retrieve dimension details.
For dimension group db.sql, the group ID is db.sql.id. The following
group ID values are valid:
db.sql.idfor dimension groupdb.sql(Aurora and RDS only)db.query.idfor dimension groupdb.query(DocumentDB only)
data GetDimensionKeyDetailsResponse Source #
See: newGetDimensionKeyDetailsResponse smart constructor.
Constructors
| GetDimensionKeyDetailsResponse' (Maybe [DimensionKeyDetail]) Int |
Instances
newGetDimensionKeyDetailsResponse Source #
Create a value of GetDimensionKeyDetailsResponse 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:
GetDimensionKeyDetailsResponse, getDimensionKeyDetailsResponse_dimensions - The details for the requested dimensions.
$sel:httpStatus:GetDimensionKeyDetailsResponse', getDimensionKeyDetailsResponse_httpStatus - The response's http status code.
GetResourceMetadata
data GetResourceMetadata Source #
See: newGetResourceMetadata smart constructor.
Constructors
| GetResourceMetadata' ServiceType Text |
Instances
newGetResourceMetadata Source #
Arguments
| :: ServiceType | |
| -> Text | |
| -> GetResourceMetadata |
Create a value of GetResourceMetadata 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:serviceType:GetResourceMetadata', getResourceMetadata_serviceType - The Amazon Web Services service for which Performance Insights returns
metrics.
GetResourceMetadata, getResourceMetadata_identifier - An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. To use a DB instance as a data source, specify its
DbiResourceId value. For example, specify
db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
data GetResourceMetadataResponse Source #
See: newGetResourceMetadataResponse smart constructor.
Constructors
| GetResourceMetadataResponse' (Maybe (HashMap Text FeatureMetadata)) (Maybe Text) Int |
Instances
newGetResourceMetadataResponse Source #
Create a value of GetResourceMetadataResponse 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:features:GetResourceMetadataResponse', getResourceMetadataResponse_features - The metadata for different features. For example, the metadata might
indicate that a feature is turned on or off on a specific DB instance.
GetResourceMetadata, getResourceMetadataResponse_identifier - An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. To use a DB instance as a data source, specify its
DbiResourceId value. For example, specify
db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
$sel:httpStatus:GetResourceMetadataResponse', getResourceMetadataResponse_httpStatus - The response's http status code.
GetResourceMetrics
data GetResourceMetrics Source #
See: newGetResourceMetrics smart constructor.
Constructors
| GetResourceMetrics' (Maybe Natural) (Maybe Text) (Maybe Int) ServiceType Text (NonEmpty MetricQuery) POSIX POSIX |
Instances
newGetResourceMetrics Source #
Arguments
| :: ServiceType | |
| -> Text | |
| -> NonEmpty MetricQuery | |
| -> UTCTime | |
| -> UTCTime | |
| -> GetResourceMetrics |
Create a value of GetResourceMetrics 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:maxResults:GetResourceMetrics', getResourceMetrics_maxResults - The maximum number of items to return in the response. If more items
exist than the specified MaxRecords value, a pagination token is
included in the response so that the remaining results can be retrieved.
GetResourceMetrics, getResourceMetrics_nextToken - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by MaxRecords.
$sel:periodInSeconds:GetResourceMetrics', getResourceMetrics_periodInSeconds - The granularity, in seconds, of the data points returned from
Performance Insights. A period can be as short as one second, or as long
as one day (86400 seconds). Valid values are:
1(one second)60(one minute)300(five minutes)3600(one hour)86400(twenty-four hours)
If you don't specify PeriodInSeconds, then Performance Insights will
choose a value for you, with a goal of returning roughly 100-200 data
points in the response.
$sel:serviceType:GetResourceMetrics', getResourceMetrics_serviceType - The Amazon Web Services service for which Performance Insights returns
metrics. Valid values are as follows:
RDS
DOCDB
GetResourceMetrics, getResourceMetrics_identifier - An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. In the console, the identifier is shown as ResourceID. When
you call DescribeDBInstances, the identifier is returned as
DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId
value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
$sel:metricQueries:GetResourceMetrics', getResourceMetrics_metricQueries - An array of one or more queries to perform. Each query must specify a
Performance Insights metric, and can optionally specify aggregation and
filtering criteria.
$sel:startTime:GetResourceMetrics', getResourceMetrics_startTime - The date and time specifying the beginning of the requested time series
query range. You can't specify a StartTime that is earlier than 7
days ago. By default, Performance Insights has 7 days of retention, but
you can extend this range up to 2 years. The value specified is
inclusive. Thus, the command returns data points equal to or greater
than StartTime.
The value for StartTime must be earlier than the value for EndTime.
$sel:endTime:GetResourceMetrics', getResourceMetrics_endTime - The date and time specifying the end of the requested time series query
range. The value specified is exclusive. Thus, the command returns
data points less than (but not equal to) EndTime.
The value for EndTime must be later than the value for StartTime.
data GetResourceMetricsResponse Source #
See: newGetResourceMetricsResponse smart constructor.
Constructors
| GetResourceMetricsResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe [MetricKeyDataPoints]) (Maybe Text) Int |
Instances
newGetResourceMetricsResponse Source #
Create a value of GetResourceMetricsResponse 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:alignedEndTime:GetResourceMetricsResponse', getResourceMetricsResponse_alignedEndTime - The end time for the returned metrics, after alignment to a granular
boundary (as specified by PeriodInSeconds). AlignedEndTime will be
greater than or equal to the value of the user-specified Endtime.
$sel:alignedStartTime:GetResourceMetricsResponse', getResourceMetricsResponse_alignedStartTime - The start time for the returned metrics, after alignment to a granular
boundary (as specified by PeriodInSeconds). AlignedStartTime will be
less than or equal to the value of the user-specified StartTime.
GetResourceMetrics, getResourceMetricsResponse_identifier - An immutable identifier for a data source that is unique for an Amazon
Web Services Region. Performance Insights gathers metrics from this data
source. In the console, the identifier is shown as ResourceID. When
you call DescribeDBInstances, the identifier is returned as
DbiResourceId.
$sel:metricList:GetResourceMetricsResponse', getResourceMetricsResponse_metricList - An array of metric results, where each array element contains all of the
data points for a particular dimension.
GetResourceMetrics, getResourceMetricsResponse_nextToken - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by MaxRecords.
$sel:httpStatus:GetResourceMetricsResponse', getResourceMetricsResponse_httpStatus - The response's http status code.
ListAvailableResourceDimensions
data ListAvailableResourceDimensions Source #
See: newListAvailableResourceDimensions smart constructor.
Constructors
| ListAvailableResourceDimensions' (Maybe Natural) (Maybe Text) ServiceType Text (NonEmpty Text) |
Instances
newListAvailableResourceDimensions Source #
Arguments
| :: ServiceType | |
| -> Text | |
| -> NonEmpty Text | |
| -> ListAvailableResourceDimensions |
Create a value of ListAvailableResourceDimensions 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:maxResults:ListAvailableResourceDimensions', listAvailableResourceDimensions_maxResults - The maximum number of items to return in the response. If more items
exist than the specified MaxRecords value, a pagination token is
included in the response so that the remaining results can be retrieved.
ListAvailableResourceDimensions, listAvailableResourceDimensions_nextToken - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by MaxRecords.
$sel:serviceType:ListAvailableResourceDimensions', listAvailableResourceDimensions_serviceType - The Amazon Web Services service for which Performance Insights returns
metrics.
ListAvailableResourceDimensions, listAvailableResourceDimensions_identifier - An immutable identifier for a data source that is unique within an
Amazon Web Services Region. Performance Insights gathers metrics from
this data source. To use an Amazon RDS DB instance as a data source,
specify its DbiResourceId value. For example, specify
db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
$sel:metrics:ListAvailableResourceDimensions', listAvailableResourceDimensions_metrics - The types of metrics for which to retrieve dimensions. Valid values
include db.load.
data ListAvailableResourceDimensionsResponse Source #
See: newListAvailableResourceDimensionsResponse smart constructor.
Constructors
| ListAvailableResourceDimensionsResponse' (Maybe [MetricDimensionGroups]) (Maybe Text) Int |
Instances
newListAvailableResourceDimensionsResponse Source #
Arguments
| :: Int | |
| -> ListAvailableResourceDimensionsResponse |
Create a value of ListAvailableResourceDimensionsResponse 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:metricDimensions:ListAvailableResourceDimensionsResponse', listAvailableResourceDimensionsResponse_metricDimensions - The dimension information returned for requested metric types.
ListAvailableResourceDimensions, listAvailableResourceDimensionsResponse_nextToken - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by MaxRecords.
$sel:httpStatus:ListAvailableResourceDimensionsResponse', listAvailableResourceDimensionsResponse_httpStatus - The response's http status code.
ListAvailableResourceMetrics
data ListAvailableResourceMetrics Source #
See: newListAvailableResourceMetrics smart constructor.
Constructors
| ListAvailableResourceMetrics' (Maybe Natural) (Maybe Text) ServiceType Text [Text] |
Instances
newListAvailableResourceMetrics Source #
Arguments
| :: ServiceType | |
| -> Text | |
| -> ListAvailableResourceMetrics |
Create a value of ListAvailableResourceMetrics 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:maxResults:ListAvailableResourceMetrics', listAvailableResourceMetrics_maxResults - The maximum number of items to return. If the MaxRecords value is less
than the number of existing items, the response includes a pagination
token.
ListAvailableResourceMetrics, listAvailableResourceMetrics_nextToken - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
token, up to the value specified by MaxRecords.
$sel:serviceType:ListAvailableResourceMetrics', listAvailableResourceMetrics_serviceType - The Amazon Web Services service for which Performance Insights returns
metrics.
ListAvailableResourceMetrics, listAvailableResourceMetrics_identifier - An immutable identifier for a data source that is unique within an
Amazon Web Services Region. Performance Insights gathers metrics from
this data source. To use an Amazon RDS DB instance as a data source,
specify its DbiResourceId value. For example, specify
db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
$sel:metricTypes:ListAvailableResourceMetrics', listAvailableResourceMetrics_metricTypes - The types of metrics to return in the response. Valid values in the
array include the following:
os(OS counter metrics) - All enginesdb(DB load metrics) - All engines except for Amazon DocumentDBdb.sql.stats(per-SQL metrics) - All engines except for Amazon DocumentDBdb.sql_tokenized.stats(per-SQL digest metrics) - All engines except for Amazon DocumentDB
data ListAvailableResourceMetricsResponse Source #
See: newListAvailableResourceMetricsResponse smart constructor.
Constructors
| ListAvailableResourceMetricsResponse' (Maybe [ResponseResourceMetric]) (Maybe Text) Int |
Instances
newListAvailableResourceMetricsResponse Source #
Arguments
| :: Int | |
| -> ListAvailableResourceMetricsResponse |
Create a value of ListAvailableResourceMetricsResponse 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:metrics:ListAvailableResourceMetricsResponse', listAvailableResourceMetricsResponse_metrics - An array of metrics available to query. Each array element contains the
full name, description, and unit of the metric.
ListAvailableResourceMetrics, listAvailableResourceMetricsResponse_nextToken - A pagination token that indicates the response didn’t return all
available records because MaxRecords was specified in the previous
request. To get the remaining records, specify NextToken in a separate
request with this value.
$sel:httpStatus:ListAvailableResourceMetricsResponse', listAvailableResourceMetricsResponse_httpStatus - The response's http status code.
Types
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' POSIX Double |
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.
DimensionDetail
data DimensionDetail Source #
The information about a dimension.
See: newDimensionDetail smart constructor.
Constructors
| DimensionDetail' (Maybe Text) |
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.
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.
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.idis 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-2372568224that 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).
DimensionGroupDetail
data DimensionGroupDetail Source #
Information about dimensions within a dimension group.
See: newDimensionGroupDetail smart constructor.
Constructors
| DimensionGroupDetail' (Maybe [DimensionDetail]) (Maybe Text) |
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.
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' (Maybe (HashMap Text Double)) (Maybe (HashMap Text Text)) (Maybe [Double]) (Maybe Double) |
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.
DimensionKeyDetail
data DimensionKeyDetail Source #
An object that describes the details for a specified dimension.
See: newDimensionKeyDetail smart constructor.
Constructors
| DimensionKeyDetail' (Maybe Text) (Maybe DetailStatus) (Maybe Text) |
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)
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' (Maybe FeatureStatus) |
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.
MetricDimensionGroups
data MetricDimensionGroups Source #
The available dimension information for a metric type.
See: newMetricDimensionGroups smart constructor.
Constructors
| MetricDimensionGroups' (Maybe [DimensionGroupDetail]) (Maybe Text) |
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.
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' (Maybe [DataPoint]) (Maybe ResponseResourceMetricKey) |
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.
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' (Maybe (HashMap Text Text)) (Maybe DimensionGroup) Text |
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
GroupByparameter. - 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.
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' (HashMap Text Text) |
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.
ResponseResourceMetric
data ResponseResourceMetric Source #
An object that contains the full name, description, and unit of a metric.
See: newResponseResourceMetric smart constructor.
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.
ResponseResourceMetricKey
data ResponseResourceMetricKey Source #
An object describing a Performance Insights metric and one or more dimensions for that metric.
See: newResponseResourceMetricKey smart constructor.
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.