Struct aws_sdk_cloudwatch::client::fluent_builders::GetMetricWidgetImage [−][src]
pub struct GetMetricWidgetImage<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
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
impl<C, M, R> GetMetricWidgetImage<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> GetMetricWidgetImage<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<GetMetricWidgetImageOutput, SdkError<GetMetricWidgetImageError>> where
R::Policy: SmithyRetryPolicy<GetMetricWidgetImageInputOperationOutputAlias, GetMetricWidgetImageOutput, GetMetricWidgetImageError, GetMetricWidgetImageInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<GetMetricWidgetImageOutput, SdkError<GetMetricWidgetImageError>> where
R::Policy: SmithyRetryPolicy<GetMetricWidgetImageInputOperationOutputAlias, GetMetricWidgetImageOutput, GetMetricWidgetImageError, GetMetricWidgetImageInputOperationRetryAlias>,
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.
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.
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.
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.
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
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for GetMetricWidgetImage<C, M, R>
impl<C, M, R> Send for GetMetricWidgetImage<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for GetMetricWidgetImage<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for GetMetricWidgetImage<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for GetMetricWidgetImage<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more