Struct aws_sdk_internetmonitor::operation::start_query::StartQueryInput

#[non_exhaustive]
pub struct StartQueryInput {
    pub monitor_name: Option<String>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub query_type: Option<QueryType>,
    pub filter_parameters: Option<Vec<FilterParameter>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

monitor_name: Option<String>

The name of the monitor to query.

start_time: Option<DateTime>

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

end_time: Option<DateTime>

The timestamp that is the end of the period that you want to retrieve data for with your query.

query_type: Option<QueryType>

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

• MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.

• TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.

• TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

filter_parameters: Option<Vec<FilterParameter>>

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Implementations

impl StartQueryInput

pub fn monitor_name(&self) -> Option<&str>

The name of the monitor to query.

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

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

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

The timestamp that is the end of the period that you want to retrieve data for with your query.

pub fn query_type(&self) -> Option<&QueryType>

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

• MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.

• TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.

• TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

pub fn filter_parameters(&self) -> &[FilterParameter]

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filter_parameters.is_none().

impl StartQueryInput

pub fn builder() -> StartQueryInputBuilder

Creates a new builder-style object to manufacture StartQueryInput.

Trait Implementations

impl Clone for StartQueryInput

fn clone(&self) -> StartQueryInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryInput

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

Formats the value using the given formatter.

impl PartialEq for StartQueryInput

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

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

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 StartQueryInput