GETMETRICWIDGETIMAGE()`¶

About 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.

Method Signature¶

METHODS /AWS1/IF_CWT~GETMETRICWIDGETIMAGE
  IMPORTING
    !IV_METRICWIDGET TYPE /AWS1/CWTMETRICWIDGET OPTIONAL
    !IV_OUTPUTFORMAT TYPE /AWS1/CWTOUTPUTFORMAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwtgetmetricwidgeti01
  RAISING
    /AWS1/CX_CWTCLIENTEXC
    /AWS1/CX_CWTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_metricwidget` `TYPE /AWS1/CWTMETRICWIDGET` `/AWS1/CWTMETRICWIDGET`¶

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.

Optional arguments:¶

`iv_outputformat` `TYPE /AWS1/CWTOUTPUTFORMAT` `/AWS1/CWTOUTPUTFORMAT`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cwtgetmetricwidgeti01` `/AWS1/CL_CWTGETMETRICWIDGETI01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getmetricwidgetimage(
  iv_metricwidget = |string|
  iv_outputformat = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_metricwidgetimage = lo_result->get_metricwidgetimage( ).
ENDIF.

/AWS1/IF_CWT=>GETMETRICWIDGETIMAGE()¶