pub struct GetMetricWidgetImage { /* private fields */ }Expand description
Fluent builder constructing a request to GetMetricWidgetImage.
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:
-
As many as 100 metrics in the graph.
-
Up to 100 KB uncompressed payload.
Implementations
sourceimpl GetMetricWidgetImage
impl GetMetricWidgetImage
sourcepub async fn send(
self
) -> Result<GetMetricWidgetImageOutput, SdkError<GetMetricWidgetImageError>>
pub async fn send(
self
) -> Result<GetMetricWidgetImageOutput, SdkError<GetMetricWidgetImageError>>
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.
sourcepub fn metric_widget(self, input: impl Into<String>) -> Self
pub fn metric_widget(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_metric_widget(self, input: Option<String>) -> Self
pub fn set_metric_widget(self, input: Option<String>) -> Self
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.
sourcepub fn output_format(self, input: impl Into<String>) -> Self
pub fn output_format(self, input: impl Into<String>) -> Self
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...
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.
sourcepub fn set_output_format(self, input: Option<String>) -> Self
pub fn set_output_format(self, input: Option<String>) -> Self
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...
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.
Trait Implementations
sourceimpl Clone for GetMetricWidgetImage
impl Clone for GetMetricWidgetImage
sourcefn clone(&self) -> GetMetricWidgetImage
fn clone(&self) -> GetMetricWidgetImage
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for GetMetricWidgetImage
impl Send for GetMetricWidgetImage
impl Sync for GetMetricWidgetImage
impl Unpin for GetMetricWidgetImage
impl !UnwindSafe for GetMetricWidgetImage
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more