Class: Aws::CloudWatch::Types::GetMetricWidgetImageInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass GetMetricWidgetImageInput data as a hash:

{
  metric_widget: "MetricWidget", # required
  output_format: "OutputFormat",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#metric_widgetString

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.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html

Returns:

  • (String)

1768
1769
1770
1771
1772
1773
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1768

class GetMetricWidgetImageInput < Struct.new(
  :metric_widget,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end

#output_formatString

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.

Returns:

  • (String)

1768
1769
1770
1771
1772
1773
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1768

class GetMetricWidgetImageInput < Struct.new(
  :metric_widget,
  :output_format)
  SENSITIVE = []
  include Aws::Structure
end