Struct aws_sdk_cloudwatch::input::GetMetricWidgetImageInput

source ·

#[non_exhaustive]
pub struct GetMetricWidgetImageInput { /* private fields */ }

Implementations§

source §

impl GetMetricWidgetImageInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetMetricWidgetImage, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<GetMetricWidgetImage>

Examples found in repository ?

src/client.rs (line 2994)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::GetMetricWidgetImage,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::GetMetricWidgetImageError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::GetMetricWidgetImageOutput,
            aws_smithy_http::result::SdkError<crate::error::GetMetricWidgetImageError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetMetricWidgetImageInput.

source §

impl GetMetricWidgetImageInput

source

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

A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget parameter in each GetMetricWidgetImage call.

For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax.

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.

source

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

The format of the resulting image. Only PNG images are supported.

The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example:

>

iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...

6f0d4192-4d42-11e8-82c1-f539a07e0e3b

The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image.