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 |
Retrieve metrics of the specified types that can be queried for a specified DB instance.
Synopsis
- data ListAvailableResourceMetrics = ListAvailableResourceMetrics' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- serviceType :: ServiceType
- identifier :: Text
- metricTypes :: [Text]
- newListAvailableResourceMetrics :: ServiceType -> Text -> ListAvailableResourceMetrics
- listAvailableResourceMetrics_maxResults :: Lens' ListAvailableResourceMetrics (Maybe Natural)
- listAvailableResourceMetrics_nextToken :: Lens' ListAvailableResourceMetrics (Maybe Text)
- listAvailableResourceMetrics_serviceType :: Lens' ListAvailableResourceMetrics ServiceType
- listAvailableResourceMetrics_identifier :: Lens' ListAvailableResourceMetrics Text
- listAvailableResourceMetrics_metricTypes :: Lens' ListAvailableResourceMetrics [Text]
- data ListAvailableResourceMetricsResponse = ListAvailableResourceMetricsResponse' {}
- newListAvailableResourceMetricsResponse :: Int -> ListAvailableResourceMetricsResponse
- listAvailableResourceMetricsResponse_metrics :: Lens' ListAvailableResourceMetricsResponse (Maybe [ResponseResourceMetric])
- listAvailableResourceMetricsResponse_nextToken :: Lens' ListAvailableResourceMetricsResponse (Maybe Text)
- listAvailableResourceMetricsResponse_httpStatus :: Lens' ListAvailableResourceMetricsResponse Int
Creating a Request
data ListAvailableResourceMetrics Source #
See: newListAvailableResourceMetrics
smart constructor.
ListAvailableResourceMetrics' | |
|
Instances
newListAvailableResourceMetrics Source #
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
Request Lenses
listAvailableResourceMetrics_maxResults :: Lens' ListAvailableResourceMetrics (Maybe Natural) Source #
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_nextToken :: Lens' ListAvailableResourceMetrics (Maybe Text) Source #
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
.
listAvailableResourceMetrics_serviceType :: Lens' ListAvailableResourceMetrics ServiceType Source #
The Amazon Web Services service for which Performance Insights returns metrics.
listAvailableResourceMetrics_identifier :: Lens' ListAvailableResourceMetrics Text Source #
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
.
listAvailableResourceMetrics_metricTypes :: Lens' ListAvailableResourceMetrics [Text] Source #
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
Destructuring the Response
data ListAvailableResourceMetricsResponse Source #
See: newListAvailableResourceMetricsResponse
smart constructor.
ListAvailableResourceMetricsResponse' | |
|
Instances
newListAvailableResourceMetricsResponse Source #
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.
Response Lenses
listAvailableResourceMetricsResponse_metrics :: Lens' ListAvailableResourceMetricsResponse (Maybe [ResponseResourceMetric]) Source #
An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.
listAvailableResourceMetricsResponse_nextToken :: Lens' ListAvailableResourceMetricsResponse (Maybe Text) Source #
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.
listAvailableResourceMetricsResponse_httpStatus :: Lens' ListAvailableResourceMetricsResponse Int Source #
The response's http status code.