Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Lightsail.GetRelationalDatabaseMetricData

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the data points of the specified metric for a database in Amazon Lightsail.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

Synopsis

Creating a Request

data GetRelationalDatabaseMetricData Source #

See: newGetRelationalDatabaseMetricData smart constructor.

Constructors

GetRelationalDatabaseMetricData'

Fields

relationalDatabaseName :: Text
The name of your database from which to get metric data.
metricName :: RelationalDatabaseMetricName
The metric for which you want to return information.
Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.
- CPUUtilization - The percentage of CPU utilization currently in use on the database.
  Statistics: The most useful statistics are Maximum and Average.
  Unit: The published unit is Percent.
- DatabaseConnections - The number of database connections in use.
  Statistics: The most useful statistics are Maximum and Sum.
  Unit: The published unit is Count.
- DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.
  Statistics: The most useful statistic is Sum.
  Unit: The published unit is Count.
- FreeStorageSpace - The amount of available storage space.
  Statistics: The most useful statistic is Sum.
  Unit: The published unit is Bytes.
- NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
  Statistics: The most useful statistic is Average.
  Unit: The published unit is Bytes/Second.
- NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
  Statistics: The most useful statistic is Average.
  Unit: The published unit is Bytes/Second.
period :: Natural
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
startTime :: POSIX
The start of the time interval from which to get metric data.
Constraints:
- Specified in Coordinated Universal Time (UTC).
- Specified in the Unix time format.
  For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.
endTime :: POSIX
The end of the time interval from which to get metric data.
Constraints:
- Specified in Coordinated Universal Time (UTC).
- Specified in the Unix time format.
  For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.
unit :: MetricUnit
The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.
statistics :: [MetricStatistic]
The statistic for the metric.
The following statistics are available:
- Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
- Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
- Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
- Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
- SampleCount - The count, or number, of data points used for the statistical calculation.

Instances

Instances details

Eq GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods (==) :: GetRelationalDatabaseMetricData -> GetRelationalDatabaseMetricData -> Bool # (/=) :: GetRelationalDatabaseMetricData -> GetRelationalDatabaseMetricData -> Bool #
Read GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods readsPrec :: Int -> ReadS GetRelationalDatabaseMetricData # readList :: ReadS [GetRelationalDatabaseMetricData] # readPrec :: ReadPrec GetRelationalDatabaseMetricData # readListPrec :: ReadPrec [GetRelationalDatabaseMetricData] #
Show GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods showsPrec :: Int -> GetRelationalDatabaseMetricData -> ShowS # show :: GetRelationalDatabaseMetricData -> String # showList :: [GetRelationalDatabaseMetricData] -> ShowS #
Generic GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Associated Types type Rep GetRelationalDatabaseMetricData :: Type -> Type # Methods from :: GetRelationalDatabaseMetricData -> Rep GetRelationalDatabaseMetricData x # to :: Rep GetRelationalDatabaseMetricData x -> GetRelationalDatabaseMetricData #
NFData GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods rnf :: GetRelationalDatabaseMetricData -> () #
Hashable GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods hashWithSalt :: Int -> GetRelationalDatabaseMetricData -> Int # hash :: GetRelationalDatabaseMetricData -> Int #
ToJSON GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods toJSON :: GetRelationalDatabaseMetricData -> Value # toEncoding :: GetRelationalDatabaseMetricData -> Encoding # toJSONList :: [GetRelationalDatabaseMetricData] -> Value # toEncodingList :: [GetRelationalDatabaseMetricData] -> Encoding #
AWSRequest GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Associated Types type AWSResponse GetRelationalDatabaseMetricData # Methods request :: GetRelationalDatabaseMetricData -> Request GetRelationalDatabaseMetricData # response :: MonadResource m => Logger -> Service -> Proxy GetRelationalDatabaseMetricData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRelationalDatabaseMetricData))) #
ToHeaders GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods toHeaders :: GetRelationalDatabaseMetricData -> [Header] #
ToPath GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods toPath :: GetRelationalDatabaseMetricData -> ByteString #
ToQuery GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods toQuery :: GetRelationalDatabaseMetricData -> QueryString #
type Rep GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData type Rep GetRelationalDatabaseMetricData = D1 ('MetaData "GetRelationalDatabaseMetricData" "Amazonka.Lightsail.GetRelationalDatabaseMetricData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetRelationalDatabaseMetricData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "relationalDatabaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelationalDatabaseMetricName) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) :: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricUnit) :: S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricStatistic])))))
type AWSResponse GetRelationalDatabaseMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData type AWSResponse GetRelationalDatabaseMetricData = GetRelationalDatabaseMetricDataResponse

newGetRelationalDatabaseMetricData Source #

Arguments

:: Text	`$sel:relationalDatabaseName:GetRelationalDatabaseMetricData'`
-> RelationalDatabaseMetricName	`$sel:metricName:GetRelationalDatabaseMetricData'`
-> Natural	`$sel:period:GetRelationalDatabaseMetricData'`
-> UTCTime	`$sel:startTime:GetRelationalDatabaseMetricData'`
-> UTCTime	`$sel:endTime:GetRelationalDatabaseMetricData'`
-> MetricUnit	`$sel:unit:GetRelationalDatabaseMetricData'`
-> GetRelationalDatabaseMetricData

Create a value of GetRelationalDatabaseMetricData 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:relationalDatabaseName:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_relationalDatabaseName - The name of your database from which to get metric data.

$sel:metricName:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_metricName - The metric for which you want to return information.

Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

CPUUtilization - The percentage of CPU utilization currently in use on the database.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
DatabaseConnections - The number of database connections in use.
Statistics: The most useful statistics are Maximum and Sum.
Unit: The published unit is Count.
DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
FreeStorageSpace - The amount of available storage space.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.
NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.

$sel:period:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_period - The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60 seconds) granularity.

$sel:startTime:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_startTime - The start of the time interval from which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

$sel:endTime:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_endTime - The end of the time interval from which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

$sel:unit:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_unit - The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

$sel:statistics:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricData_statistics - The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

Request Lenses

getRelationalDatabaseMetricData_relationalDatabaseName :: Lens' GetRelationalDatabaseMetricData Text Source #

The name of your database from which to get metric data.

getRelationalDatabaseMetricData_metricName :: Lens' GetRelationalDatabaseMetricData RelationalDatabaseMetricName Source #

The metric for which you want to return information.

Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

CPUUtilization - The percentage of CPU utilization currently in use on the database.
Statistics: The most useful statistics are Maximum and Average.
Unit: The published unit is Percent.
DatabaseConnections - The number of database connections in use.
Statistics: The most useful statistics are Maximum and Sum.
Unit: The published unit is Count.
DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Count.
FreeStorageSpace - The amount of available storage space.
Statistics: The most useful statistic is Sum.
Unit: The published unit is Bytes.
NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.
NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
Statistics: The most useful statistic is Average.
Unit: The published unit is Bytes/Second.

getRelationalDatabaseMetricData_period :: Lens' GetRelationalDatabaseMetricData Natural Source #

The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60 seconds) granularity.

getRelationalDatabaseMetricData_startTime :: Lens' GetRelationalDatabaseMetricData UTCTime Source #

The start of the time interval from which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

getRelationalDatabaseMetricData_endTime :: Lens' GetRelationalDatabaseMetricData UTCTime Source #

The end of the time interval from which to get metric data.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

getRelationalDatabaseMetricData_unit :: Lens' GetRelationalDatabaseMetricData MetricUnit Source #

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

getRelationalDatabaseMetricData_statistics :: Lens' GetRelationalDatabaseMetricData [MetricStatistic] Source #

The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

Destructuring the Response

data GetRelationalDatabaseMetricDataResponse Source #

See: newGetRelationalDatabaseMetricDataResponse smart constructor.

Constructors

GetRelationalDatabaseMetricDataResponse'
Fields metricName :: Maybe RelationalDatabaseMetricName The name of the metric returned. metricData :: Maybe [MetricDatapoint] An array of objects that describe the metric data returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetRelationalDatabaseMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods (==) :: GetRelationalDatabaseMetricDataResponse -> GetRelationalDatabaseMetricDataResponse -> Bool # (/=) :: GetRelationalDatabaseMetricDataResponse -> GetRelationalDatabaseMetricDataResponse -> Bool #
Read GetRelationalDatabaseMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods readsPrec :: Int -> ReadS GetRelationalDatabaseMetricDataResponse # readList :: ReadS [GetRelationalDatabaseMetricDataResponse] # readPrec :: ReadPrec GetRelationalDatabaseMetricDataResponse # readListPrec :: ReadPrec [GetRelationalDatabaseMetricDataResponse] #
Show GetRelationalDatabaseMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods showsPrec :: Int -> GetRelationalDatabaseMetricDataResponse -> ShowS # show :: GetRelationalDatabaseMetricDataResponse -> String # showList :: [GetRelationalDatabaseMetricDataResponse] -> ShowS #
Generic GetRelationalDatabaseMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Associated Types type Rep GetRelationalDatabaseMetricDataResponse :: Type -> Type # Methods from :: GetRelationalDatabaseMetricDataResponse -> Rep GetRelationalDatabaseMetricDataResponse x # to :: Rep GetRelationalDatabaseMetricDataResponse x -> GetRelationalDatabaseMetricDataResponse #
NFData GetRelationalDatabaseMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData Methods rnf :: GetRelationalDatabaseMetricDataResponse -> () #
type Rep GetRelationalDatabaseMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData type Rep GetRelationalDatabaseMetricDataResponse = D1 ('MetaData "GetRelationalDatabaseMetricDataResponse" "Amazonka.Lightsail.GetRelationalDatabaseMetricData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetRelationalDatabaseMetricDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelationalDatabaseMetricName)) :: (S1 ('MetaSel ('Just "metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDatapoint])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRelationalDatabaseMetricDataResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRelationalDatabaseMetricDataResponse'`
-> GetRelationalDatabaseMetricDataResponse

Create a value of GetRelationalDatabaseMetricDataResponse 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:metricName:GetRelationalDatabaseMetricData', getRelationalDatabaseMetricDataResponse_metricName - The name of the metric returned.

$sel:metricData:GetRelationalDatabaseMetricDataResponse', getRelationalDatabaseMetricDataResponse_metricData - An array of objects that describe the metric data returned.

$sel:httpStatus:GetRelationalDatabaseMetricDataResponse', getRelationalDatabaseMetricDataResponse_httpStatus - The response's http status code.

Response Lenses

getRelationalDatabaseMetricDataResponse_metricName :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe RelationalDatabaseMetricName) Source #

The name of the metric returned.

getRelationalDatabaseMetricDataResponse_metricData :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getRelationalDatabaseMetricDataResponse_httpStatus :: Lens' GetRelationalDatabaseMetricDataResponse Int Source #

The response's http status code.