cloudwatch_get_metric_widget_image: You can use the GetMetricWidgetImage API to retrieve a...
In paws.management: 'Amazon Web Services' Management & Governance Services
View source: R/cloudwatch_operations.R
cloudwatch_get_metric_widget_image R Documentation
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of
one or more Amazon CloudWatch metrics as a bitmap image
Description
You can use the get_metric_widget_image 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.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_metric_widget_image/ for full documentation.
Usage
cloudwatch_get_metric_widget_image(MetricWidget, OutputFormat = NULL)
Arguments
MetricWidget
[required] 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
get_metric_widget_image 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.
OutputFormat
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:
<GetMetricWidgetImageResponse xmlns=<URLstring>>
<GetMetricWidgetImageResult>
<MetricWidgetImage>
iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
</MetricWidgetImage>
</GetMetricWidgetImageResult>
<ResponseMetadata>
<RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
</ResponseMetadata>
</GetMetricWidgetImageResponse>
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.
paws.management documentation built on Sept. 12, 2023, 1:06 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/cloudwatch_operations.R
| cloudwatch_get_metric_widget_image | R Documentation |
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image
Description
You can use the get_metric_widget_image 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.
See https://www.paws-r-sdk.com/docs/cloudwatch_get_metric_widget_image/ for full documentation.
Usage
cloudwatch_get_metric_widget_image(MetricWidget, OutputFormat = NULL)
Arguments
MetricWidget |
[required] 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 For more information about the syntax of 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. |
OutputFormat |
The format of the resulting image. Only PNG images are supported. The default is
The |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.