class
Amazonite::CloudWatch::GetMetricWidgetImageInput
- Amazonite::CloudWatch::GetMetricWidgetImageInput
- Reference
- Object
Included Modules
- JSON::Serializable
Defined in:
cloudwatch/get_metric_widget_image_input.crConstructors
- .new(pull : JSON::PullParser)
- .new(metric_widget : String, output_format : String | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#metric_widget : String
A JSON string that defines the bitmap graph to be retrieved.
-
#metric_widget=(metric_widget : String)
A JSON string that defines the bitmap graph to be retrieved.
-
#output_format : String | Nil
The format of the resulting image.
-
#output_format=(output_format : String | Nil)
The format of the resulting image.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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...
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.
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.