Struct aws_sdk_internetmonitor::operation::start_query::builders::StartQueryFluentBuilder

pub struct StartQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartQuery.

Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters.

For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Implementations

impl StartQueryFluentBuilder

pub fn as_input(&self) -> &StartQueryInputBuilder

Access the StartQuery as a reference.

pub async fn send( self, ) -> Result<StartQueryOutput, SdkError<StartQueryError, HttpResponse>>

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.

pub fn customize( self, ) -> CustomizableOperation<StartQueryOutput, StartQueryError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The name of the monitor to query.

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

The name of the monitor to query.

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

The name of the monitor to query.

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

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

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

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

pub fn get_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, input: DateTime) -> Self

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

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

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

pub fn get_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, input: QueryType) -> Self

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 set_query_type(self, input: Option<QueryType>) -> Self

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 get_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, input: FilterParameter) -> Self

Appends an item to FilterParameters.

To override the contents of this collection use set_filter_parameters.

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.

pub fn set_filter_parameters(self, input: Option<Vec<FilterParameter>>) -> Self

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.

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

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

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

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

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

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

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Trait Implementations

impl Clone for StartQueryFluentBuilder

fn clone(&self) -> StartQueryFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartQueryFluentBuilder

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

Formats the value using the given formatter.