Amazonka.Lightsail.GetRelationalDatabaseMetricData

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.

Creating a Request

data GetRelationalDatabaseMetricData

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

ToJSON GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

toJSON :: GetRelationalDatabaseMetricData -> Value

toEncoding :: GetRelationalDatabaseMetricData -> Encoding

toJSONList :: [GetRelationalDatabaseMetricData] -> Value

toEncodingList :: [GetRelationalDatabaseMetricData] -> Encoding

ToHeaders GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

toHeaders :: GetRelationalDatabaseMetricData -> [Header]

ToPath GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

toPath :: GetRelationalDatabaseMetricData -> ByteString

ToQuery GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

toQuery :: GetRelationalDatabaseMetricData -> QueryString

AWSRequest GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Associated Types

type AWSResponse GetRelationalDatabaseMetricData

Methods

request :: (Service -> Service) -> GetRelationalDatabaseMetricData -> Request GetRelationalDatabaseMetricData

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRelationalDatabaseMetricData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRelationalDatabaseMetricData)))

Generic GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Associated Types

type Rep GetRelationalDatabaseMetricData :: Type -> Type

Methods

from :: GetRelationalDatabaseMetricData -> Rep GetRelationalDatabaseMetricData x

to :: Rep GetRelationalDatabaseMetricData x -> GetRelationalDatabaseMetricData

Read GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

readsPrec :: Int -> ReadS GetRelationalDatabaseMetricData

readList :: ReadS [GetRelationalDatabaseMetricData]

readPrec :: ReadPrec GetRelationalDatabaseMetricData

readListPrec :: ReadPrec [GetRelationalDatabaseMetricData]

Show GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

showsPrec :: Int -> GetRelationalDatabaseMetricData -> ShowS

show :: GetRelationalDatabaseMetricData -> String

showList :: [GetRelationalDatabaseMetricData] -> ShowS

NFData GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

rnf :: GetRelationalDatabaseMetricData -> ()

Eq GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

(==) :: GetRelationalDatabaseMetricData -> GetRelationalDatabaseMetricData -> Bool

(/=) :: GetRelationalDatabaseMetricData -> GetRelationalDatabaseMetricData -> Bool

Hashable GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

hashWithSalt :: Int -> GetRelationalDatabaseMetricData -> Int

hash :: GetRelationalDatabaseMetricData -> Int

type AWSResponse GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

type AWSResponse GetRelationalDatabaseMetricData = GetRelationalDatabaseMetricDataResponse

type Rep GetRelationalDatabaseMetricData

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

type Rep GetRelationalDatabaseMetricData = D1 ('MetaData "GetRelationalDatabaseMetricData" "Amazonka.Lightsail.GetRelationalDatabaseMetricData" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" '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])))))

newGetRelationalDatabaseMetricData

Arguments

:: Text

$sel:relationalDatabaseName:GetRelationalDatabaseMetricData'

-> RelationalDatabaseMetricName

GetRelationalDatabaseMetricData

-> Natural

GetRelationalDatabaseMetricData

-> UTCTime

$sel:startTime:GetRelationalDatabaseMetricData'

-> UTCTime

$sel:endTime:GetRelationalDatabaseMetricData'

-> MetricUnit

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.

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.

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.

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

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

getRelationalDatabaseMetricData_metricName :: Lens' GetRelationalDatabaseMetricData 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.

getRelationalDatabaseMetricData_period :: Lens' GetRelationalDatabaseMetricData Natural

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

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

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

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]

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

See: newGetRelationalDatabaseMetricDataResponse smart constructor.

Constructors

GetRelationalDatabaseMetricDataResponse'

Fields

• metricData :: Maybe [MetricDatapoint]

  An array of objects that describe the metric data returned.

• metricName :: Maybe RelationalDatabaseMetricName

  The name of the metric returned.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRelationalDatabaseMetricDataResponse

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Associated Types

type Rep GetRelationalDatabaseMetricDataResponse :: Type -> Type

Methods

from :: GetRelationalDatabaseMetricDataResponse -> Rep GetRelationalDatabaseMetricDataResponse x

to :: Rep GetRelationalDatabaseMetricDataResponse x -> GetRelationalDatabaseMetricDataResponse

Read GetRelationalDatabaseMetricDataResponse

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

readsPrec :: Int -> ReadS GetRelationalDatabaseMetricDataResponse

readList :: ReadS [GetRelationalDatabaseMetricDataResponse]

readPrec :: ReadPrec GetRelationalDatabaseMetricDataResponse

readListPrec :: ReadPrec [GetRelationalDatabaseMetricDataResponse]

Show GetRelationalDatabaseMetricDataResponse

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

showsPrec :: Int -> GetRelationalDatabaseMetricDataResponse -> ShowS

show :: GetRelationalDatabaseMetricDataResponse -> String

showList :: [GetRelationalDatabaseMetricDataResponse] -> ShowS

NFData GetRelationalDatabaseMetricDataResponse

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

rnf :: GetRelationalDatabaseMetricDataResponse -> ()

Eq GetRelationalDatabaseMetricDataResponse

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

Methods

(==) :: GetRelationalDatabaseMetricDataResponse -> GetRelationalDatabaseMetricDataResponse -> Bool

(/=) :: GetRelationalDatabaseMetricDataResponse -> GetRelationalDatabaseMetricDataResponse -> Bool

type Rep GetRelationalDatabaseMetricDataResponse

Defined in Amazonka.Lightsail.GetRelationalDatabaseMetricData

type Rep GetRelationalDatabaseMetricDataResponse = D1 ('MetaData "GetRelationalDatabaseMetricDataResponse" "Amazonka.Lightsail.GetRelationalDatabaseMetricData" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetRelationalDatabaseMetricDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDatapoint])) :*: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelationalDatabaseMetricName)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRelationalDatabaseMetricDataResponse

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:metricData:GetRelationalDatabaseMetricDataResponse', getRelationalDatabaseMetricDataResponse_metricData - An array of objects that describe the metric data returned.

GetRelationalDatabaseMetricData, getRelationalDatabaseMetricDataResponse_metricName - The name of the metric returned.

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

Response Lenses

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

An array of objects that describe the metric data returned.

getRelationalDatabaseMetricDataResponse_metricName :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe RelationalDatabaseMetricName)

The name of the metric returned.

getRelationalDatabaseMetricDataResponse_httpStatus :: Lens' GetRelationalDatabaseMetricDataResponse Int

The response's http status code.