Struct aws_sdk_lightsail::operation::get_distribution_metric_data::builders::GetDistributionMetricDataInputBuilder

impl GetDistributionMetricDataInputBuilder

pub fn distribution_name(self, input: impl Into<String>) -> Self

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

This field is required.

pub fn set_distribution_name(self, input: Option<String>) -> Self

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

pub fn get_distribution_name(&self) -> &Option<String>

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

pub fn metric_name(self, input: DistributionMetricName) -> Self

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.
4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.

This field is required.

pub fn set_metric_name(self, input: Option<DistributionMetricName>) -> Self

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.
4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.

pub fn get_metric_name(&self) -> &Option<DistributionMetricName>

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

Statistics: The most useful statistic is Sum.

Unit: The published unit is None.
TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.
4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

Statistics: The most useful statistic is Average.

Unit: The published unit is Percent.

pub fn start_time(self, input: DateTime) -> Self

The start of the time interval for 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, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

This field is required.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The start of the time interval for 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, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

pub fn get_start_time(&self) -> &Option<DateTime>

The start of the time interval for 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, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

pub fn end_time(self, input: DateTime) -> Self

The end of the time interval for 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 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

This field is required.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The end of the time interval for 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 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

pub fn get_end_time(&self) -> &Option<DateTime>

The end of the time interval for 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 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

pub fn period(self, input: i32) -> Self

The granularity, in seconds, for the metric data points that will be returned.

This field is required.

pub fn set_period(self, input: Option<i32>) -> Self

The granularity, in seconds, for the metric data points that will be returned.

pub fn get_period(&self) -> &Option<i32>

The granularity, in seconds, for the metric data points that will be returned.

pub fn unit(self, input: MetricUnit) -> Self

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.

This field is required.

pub fn set_unit(self, input: Option<MetricUnit>) -> Self

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.

pub fn get_unit(&self) -> &Option<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.

pub fn statistics(self, input: MetricStatistic) -> Self

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.

pub fn set_statistics(self, input: Option<Vec<MetricStatistic>>) -> Self

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.

pub fn get_statistics(&self) -> &Option<Vec<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.

pub fn build(self) -> Result<GetDistributionMetricDataInput, BuildError>

Consumes the builder and constructs a GetDistributionMetricDataInput.

impl GetDistributionMetricDataInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetDistributionMetricDataOutput, SdkError<GetDistributionMetricDataError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations§

impl Clone for GetDistributionMetricDataInputBuilder

fn clone(&self) -> GetDistributionMetricDataInputBuilder

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for GetDistributionMetricDataInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for GetDistributionMetricDataInputBuilder

fn default() -> GetDistributionMetricDataInputBuilder

Returns the “default value” for a type. Read more

impl PartialEq for GetDistributionMetricDataInputBuilder

fn eq(&self, other: &GetDistributionMetricDataInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetDistributionMetricDataInputBuilder

Auto Trait Implementations§

impl UnwindSafe for GetDistributionMetricDataInputBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more