Struct aws_sdk_lightsail::client::fluent_builders::GetRelationalDatabaseMetricData [−][src]
pub struct GetRelationalDatabaseMetricData<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to 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.
Implementations
impl<C, M, R> GetRelationalDatabaseMetricData<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> GetRelationalDatabaseMetricData<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<GetRelationalDatabaseMetricDataOutput, SdkError<GetRelationalDatabaseMetricDataError>> where
R::Policy: SmithyRetryPolicy<GetRelationalDatabaseMetricDataInputOperationOutputAlias, GetRelationalDatabaseMetricDataOutput, GetRelationalDatabaseMetricDataError, GetRelationalDatabaseMetricDataInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<GetRelationalDatabaseMetricDataOutput, SdkError<GetRelationalDatabaseMetricDataError>> where
R::Policy: SmithyRetryPolicy<GetRelationalDatabaseMetricDataInputOperationOutputAlias, GetRelationalDatabaseMetricDataOutput, GetRelationalDatabaseMetricDataError, GetRelationalDatabaseMetricDataInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
The name of your database from which to get metric data.
The name of your database from which to get metric data.
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
DatabaseConnections
- The number of database connections in use.Statistics
: The most useful statistics areMaximum
andSum
.Unit
: The published unit isCount
. -
DiskQueueDepth
- The number of outstanding IOs (read/write requests) that are waiting to access the disk.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
FreeStorageSpace
- The amount of available storage space.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
. -
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 isAverage
.Unit
: The published unit isBytes/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 isAverage
.Unit
: The published unit isBytes/Second
.
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
DatabaseConnections
- The number of database connections in use.Statistics
: The most useful statistics areMaximum
andSum
.Unit
: The published unit isCount
. -
DiskQueueDepth
- The number of outstanding IOs (read/write requests) that are waiting to access the disk.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
FreeStorageSpace
- The amount of available storage space.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
. -
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 isAverage
.Unit
: The published unit isBytes/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 isAverage
.Unit
: The published unit isBytes/Second
.
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
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.
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.
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.
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.
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.
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.
Appends an item to statistics
.
To override the contents of this collection use set_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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for GetRelationalDatabaseMetricData<C, M, R>
impl<C, M, R> Send for GetRelationalDatabaseMetricData<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for GetRelationalDatabaseMetricData<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for GetRelationalDatabaseMetricData<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for GetRelationalDatabaseMetricData<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more