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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve metrics of the specified types that can be queried for a specified DB instance.

Synopsis

Creating a Request

data ListAvailableResourceMetrics Source #

See: newListAvailableResourceMetrics smart constructor.

Constructors

ListAvailableResourceMetrics'

Fields

maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
serviceType :: ServiceType
The Amazon Web Services service for which Performance Insights returns metrics.
identifier :: Text
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.
metricTypes :: [Text]
The types of metrics to return in the response. Valid values in the array include the following:
- os (OS counter metrics) - All engines
- db (DB load metrics) - All engines except for Amazon DocumentDB
- db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
- db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

Instances

Instances details

ToJSON ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods toJSON :: ListAvailableResourceMetrics -> Value # toEncoding :: ListAvailableResourceMetrics -> Encoding # toJSONList :: [ListAvailableResourceMetrics] -> Value # toEncodingList :: [ListAvailableResourceMetrics] -> Encoding #
ToHeaders ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods toHeaders :: ListAvailableResourceMetrics -> [Header] #
ToPath ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods toPath :: ListAvailableResourceMetrics -> ByteString #
ToQuery ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods toQuery :: ListAvailableResourceMetrics -> QueryString #
AWSRequest ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Associated Types type AWSResponse ListAvailableResourceMetrics # Methods request :: (Service -> Service) -> ListAvailableResourceMetrics -> Request ListAvailableResourceMetrics # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAvailableResourceMetrics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAvailableResourceMetrics))) #
Generic ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Associated Types type Rep ListAvailableResourceMetrics :: Type -> Type # Methods from :: ListAvailableResourceMetrics -> Rep ListAvailableResourceMetrics x # to :: Rep ListAvailableResourceMetrics x -> ListAvailableResourceMetrics #
Read ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods readsPrec :: Int -> ReadS ListAvailableResourceMetrics # readList :: ReadS [ListAvailableResourceMetrics] # readPrec :: ReadPrec ListAvailableResourceMetrics # readListPrec :: ReadPrec [ListAvailableResourceMetrics] #
Show ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods showsPrec :: Int -> ListAvailableResourceMetrics -> ShowS # show :: ListAvailableResourceMetrics -> String # showList :: [ListAvailableResourceMetrics] -> ShowS #
NFData ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods rnf :: ListAvailableResourceMetrics -> () #
Eq ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods (==) :: ListAvailableResourceMetrics -> ListAvailableResourceMetrics -> Bool # (/=) :: ListAvailableResourceMetrics -> ListAvailableResourceMetrics -> Bool #
Hashable ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods hashWithSalt :: Int -> ListAvailableResourceMetrics -> Int # hash :: ListAvailableResourceMetrics -> Int #
type AWSResponse ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics type AWSResponse ListAvailableResourceMetrics = ListAvailableResourceMetricsResponse
type Rep ListAvailableResourceMetrics Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics type Rep ListAvailableResourceMetrics = D1 ('MetaData "ListAvailableResourceMetrics" "Amazonka.Pi.ListAvailableResourceMetrics" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ListAvailableResourceMetrics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceType) :: (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "metricTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newListAvailableResourceMetrics Source #

Arguments

:: ServiceType	`$sel:serviceType:ListAvailableResourceMetrics'`
-> Text	`ListAvailableResourceMetrics`
-> 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 engines
db (DB load metrics) - All engines except for Amazon DocumentDB
db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
db.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 engines
db (DB load metrics) - All engines except for Amazon DocumentDB
db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

Destructuring the Response

data ListAvailableResourceMetricsResponse Source #

See: newListAvailableResourceMetricsResponse smart constructor.

Constructors

ListAvailableResourceMetricsResponse'

Fields

metrics :: Maybe [ResponseResourceMetric]
An array of metrics available to query. Each array element contains the full name, description, and unit of the metric.
nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListAvailableResourceMetricsResponse Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Associated Types type Rep ListAvailableResourceMetricsResponse :: Type -> Type # Methods from :: ListAvailableResourceMetricsResponse -> Rep ListAvailableResourceMetricsResponse x # to :: Rep ListAvailableResourceMetricsResponse x -> ListAvailableResourceMetricsResponse #
Read ListAvailableResourceMetricsResponse Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods readsPrec :: Int -> ReadS ListAvailableResourceMetricsResponse # readList :: ReadS [ListAvailableResourceMetricsResponse] # readPrec :: ReadPrec ListAvailableResourceMetricsResponse # readListPrec :: ReadPrec [ListAvailableResourceMetricsResponse] #
Show ListAvailableResourceMetricsResponse Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods showsPrec :: Int -> ListAvailableResourceMetricsResponse -> ShowS # show :: ListAvailableResourceMetricsResponse -> String # showList :: [ListAvailableResourceMetricsResponse] -> ShowS #
NFData ListAvailableResourceMetricsResponse Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods rnf :: ListAvailableResourceMetricsResponse -> () #
Eq ListAvailableResourceMetricsResponse Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics Methods (==) :: ListAvailableResourceMetricsResponse -> ListAvailableResourceMetricsResponse -> Bool # (/=) :: ListAvailableResourceMetricsResponse -> ListAvailableResourceMetricsResponse -> Bool #
type Rep ListAvailableResourceMetricsResponse Source #
Instance details Defined in Amazonka.Pi.ListAvailableResourceMetrics type Rep ListAvailableResourceMetricsResponse = D1 ('MetaData "ListAvailableResourceMetricsResponse" "Amazonka.Pi.ListAvailableResourceMetrics" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ListAvailableResourceMetricsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResponseResourceMetric])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAvailableResourceMetricsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAvailableResourceMetricsResponse'`
-> 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.

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.