aws-sdk-cloudwatch 1.9.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- data/lib/aws-sdk-cloudwatch/client.rb +90 -1
- data/lib/aws-sdk-cloudwatch/client_api.rb +20 -0
- data/lib/aws-sdk-cloudwatch/types.rb +76 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 388deaaf8d21a67a8086a7286c70a8a558c6a8a1
|
4
|
+
data.tar.gz: 0bb705c87d45bfb2034e90f65cad8b6e8e3df6ea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a652578241dc0540d5c4c3f621efaa4708c0a8448f6a92195b3a93c08e9feba7b2a0728252ac9abc203e98b1f99c7ba91fb29a10bdb6b660658b0fa51e195dc9
|
7
|
+
data.tar.gz: b5740d08e5e33ae7516ff51bc6ebbd465b0cd19d8584e48560c5a59b7c81082e7ccc41dc08ba553ad8a7f4f72ca014a28f59f5fd0ae367ee9829d8ee865bbdb8
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
@@ -898,6 +898,95 @@ module Aws::CloudWatch
|
|
898
898
|
req.send_request(options)
|
899
899
|
end
|
900
900
|
|
901
|
+
# You can use the `GetMetricWidgetImage` API to retrieve a snapshot
|
902
|
+
# graph of one or more Amazon CloudWatch metrics as a bitmap image. You
|
903
|
+
# can then embed this image into your services and products, such as
|
904
|
+
# wiki pages, reports, and documents. You could also retrieve images
|
905
|
+
# regularly, such as every minute, and create your own custom live
|
906
|
+
# dashboard.
|
907
|
+
#
|
908
|
+
# The graph you retrieve can include all CloudWatch metric graph
|
909
|
+
# features, including metric math and horizontal and vertical
|
910
|
+
# annotations.
|
911
|
+
#
|
912
|
+
# There is a limit of 20 transactions per second for this API. Each
|
913
|
+
# `GetMetricWidgetImage` action has the following limits:
|
914
|
+
#
|
915
|
+
# * As many as 100 metrics in the graph.
|
916
|
+
#
|
917
|
+
# * Up to 100 KB uncompressed payload.
|
918
|
+
#
|
919
|
+
# @option params [required, String] :metric_widget
|
920
|
+
# A JSON string that defines the bitmap graph to be retrieved. The
|
921
|
+
# string includes the metrics to include in the graph, statistics,
|
922
|
+
# annotations, title, axis limits, and so on. You can include only one
|
923
|
+
# `MetricWidget` parameter in each `GetMetricWidgetImage` call.
|
924
|
+
#
|
925
|
+
# For more information about the syntax of `MetricWidget` see
|
926
|
+
# CloudWatch-Metric-Widget-Structure.
|
927
|
+
#
|
928
|
+
# If any metric on the graph could not load all the requested data
|
929
|
+
# points, an orange triangle with an exclamation point appears next to
|
930
|
+
# the graph legend.
|
931
|
+
#
|
932
|
+
# @option params [String] :output_format
|
933
|
+
# The format of the resulting image. Only PNG images are supported.
|
934
|
+
#
|
935
|
+
# The default is `png`. If you specify `png`, the API returns an HTTP
|
936
|
+
# response with the content-type set to `text/xml`. The image data is in
|
937
|
+
# a `MetricWidgetImage` field. For example:
|
938
|
+
#
|
939
|
+
# ` <GetMetricWidgetImageResponse
|
940
|
+
# xmlns="http://monitoring.amazonaws.com/doc/2010-08-01/">`
|
941
|
+
#
|
942
|
+
# ` <GetMetricWidgetImageResult>`
|
943
|
+
#
|
944
|
+
# ` <MetricWidgetImage>`
|
945
|
+
#
|
946
|
+
# ` iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...`
|
947
|
+
#
|
948
|
+
# ` </MetricWidgetImage>`
|
949
|
+
#
|
950
|
+
# ` </GetMetricWidgetImageResult>`
|
951
|
+
#
|
952
|
+
# ` <ResponseMetadata>`
|
953
|
+
#
|
954
|
+
# ` <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>`
|
955
|
+
#
|
956
|
+
# ` </ResponseMetadata>`
|
957
|
+
#
|
958
|
+
# `</GetMetricWidgetImageResponse>`
|
959
|
+
#
|
960
|
+
# The `image/png` setting is intended only for custom HTTP requests. For
|
961
|
+
# most use cases, and all actions using an AWS SDK, you should use
|
962
|
+
# `png`. If you specify `image/png`, the HTTP response has a
|
963
|
+
# content-type set to `image/png`, and the body of the response is a PNG
|
964
|
+
# image.
|
965
|
+
#
|
966
|
+
# @return [Types::GetMetricWidgetImageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
967
|
+
#
|
968
|
+
# * {Types::GetMetricWidgetImageOutput#metric_widget_image #metric_widget_image} => String
|
969
|
+
#
|
970
|
+
# @example Request syntax with placeholder values
|
971
|
+
#
|
972
|
+
# resp = client.get_metric_widget_image({
|
973
|
+
# metric_widget: "MetricWidget", # required
|
974
|
+
# output_format: "OutputFormat",
|
975
|
+
# })
|
976
|
+
#
|
977
|
+
# @example Response structure
|
978
|
+
#
|
979
|
+
# resp.metric_widget_image #=> String
|
980
|
+
#
|
981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImage AWS API Documentation
|
982
|
+
#
|
983
|
+
# @overload get_metric_widget_image(params = {})
|
984
|
+
# @param [Hash] params ({})
|
985
|
+
def get_metric_widget_image(params = {}, options = {})
|
986
|
+
req = build_request(:get_metric_widget_image, params)
|
987
|
+
req.send_request(options)
|
988
|
+
end
|
989
|
+
|
901
990
|
# Returns a list of the dashboards for your account. If you include
|
902
991
|
# `DashboardNamePrefix`, only those dashboards with names starting with
|
903
992
|
# the prefix are listed. Otherwise, all dashboards in your account are
|
@@ -1502,7 +1591,7 @@ module Aws::CloudWatch
|
|
1502
1591
|
params: params,
|
1503
1592
|
config: config)
|
1504
1593
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
1505
|
-
context[:gem_version] = '1.
|
1594
|
+
context[:gem_version] = '1.10.0'
|
1506
1595
|
Seahorse::Client::Request.new(handlers, context)
|
1507
1596
|
end
|
1508
1597
|
|
@@ -72,6 +72,8 @@ module Aws::CloudWatch
|
|
72
72
|
GetMetricDataOutput = Shapes::StructureShape.new(name: 'GetMetricDataOutput')
|
73
73
|
GetMetricStatisticsInput = Shapes::StructureShape.new(name: 'GetMetricStatisticsInput')
|
74
74
|
GetMetricStatisticsOutput = Shapes::StructureShape.new(name: 'GetMetricStatisticsOutput')
|
75
|
+
GetMetricWidgetImageInput = Shapes::StructureShape.new(name: 'GetMetricWidgetImageInput')
|
76
|
+
GetMetricWidgetImageOutput = Shapes::StructureShape.new(name: 'GetMetricWidgetImageOutput')
|
75
77
|
HistoryData = Shapes::StringShape.new(name: 'HistoryData')
|
76
78
|
HistoryItemType = Shapes::StringShape.new(name: 'HistoryItemType')
|
77
79
|
HistorySummary = Shapes::StringShape.new(name: 'HistorySummary')
|
@@ -106,10 +108,13 @@ module Aws::CloudWatch
|
|
106
108
|
MetricLabel = Shapes::StringShape.new(name: 'MetricLabel')
|
107
109
|
MetricName = Shapes::StringShape.new(name: 'MetricName')
|
108
110
|
MetricStat = Shapes::StructureShape.new(name: 'MetricStat')
|
111
|
+
MetricWidget = Shapes::StringShape.new(name: 'MetricWidget')
|
112
|
+
MetricWidgetImage = Shapes::BlobShape.new(name: 'MetricWidgetImage')
|
109
113
|
Metrics = Shapes::ListShape.new(name: 'Metrics')
|
110
114
|
MissingRequiredParameterException = Shapes::StructureShape.new(name: 'MissingRequiredParameterException')
|
111
115
|
Namespace = Shapes::StringShape.new(name: 'Namespace')
|
112
116
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
117
|
+
OutputFormat = Shapes::StringShape.new(name: 'OutputFormat')
|
113
118
|
Period = Shapes::IntegerShape.new(name: 'Period')
|
114
119
|
PutDashboardInput = Shapes::StructureShape.new(name: 'PutDashboardInput')
|
115
120
|
PutDashboardOutput = Shapes::StructureShape.new(name: 'PutDashboardOutput')
|
@@ -283,6 +288,13 @@ module Aws::CloudWatch
|
|
283
288
|
GetMetricStatisticsOutput.add_member(:datapoints, Shapes::ShapeRef.new(shape: Datapoints, location_name: "Datapoints"))
|
284
289
|
GetMetricStatisticsOutput.struct_class = Types::GetMetricStatisticsOutput
|
285
290
|
|
291
|
+
GetMetricWidgetImageInput.add_member(:metric_widget, Shapes::ShapeRef.new(shape: MetricWidget, required: true, location_name: "MetricWidget"))
|
292
|
+
GetMetricWidgetImageInput.add_member(:output_format, Shapes::ShapeRef.new(shape: OutputFormat, location_name: "OutputFormat"))
|
293
|
+
GetMetricWidgetImageInput.struct_class = Types::GetMetricWidgetImageInput
|
294
|
+
|
295
|
+
GetMetricWidgetImageOutput.add_member(:metric_widget_image, Shapes::ShapeRef.new(shape: MetricWidgetImage, location_name: "MetricWidgetImage"))
|
296
|
+
GetMetricWidgetImageOutput.struct_class = Types::GetMetricWidgetImageOutput
|
297
|
+
|
286
298
|
ListDashboardsInput.add_member(:dashboard_name_prefix, Shapes::ShapeRef.new(shape: DashboardNamePrefix, location_name: "DashboardNamePrefix"))
|
287
299
|
ListDashboardsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
288
300
|
ListDashboardsInput.struct_class = Types::ListDashboardsInput
|
@@ -557,6 +569,14 @@ module Aws::CloudWatch
|
|
557
569
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
|
558
570
|
end)
|
559
571
|
|
572
|
+
api.add_operation(:get_metric_widget_image, Seahorse::Model::Operation.new.tap do |o|
|
573
|
+
o.name = "GetMetricWidgetImage"
|
574
|
+
o.http_method = "POST"
|
575
|
+
o.http_request_uri = "/"
|
576
|
+
o.input = Shapes::ShapeRef.new(shape: GetMetricWidgetImageInput)
|
577
|
+
o.output = Shapes::ShapeRef.new(shape: GetMetricWidgetImageOutput)
|
578
|
+
end)
|
579
|
+
|
560
580
|
api.add_operation(:list_dashboards, Seahorse::Model::Operation.new.tap do |o|
|
561
581
|
o.name = "ListDashboards"
|
562
582
|
o.http_method = "POST"
|
@@ -788,6 +788,82 @@ module Aws::CloudWatch
|
|
788
788
|
include Aws::Structure
|
789
789
|
end
|
790
790
|
|
791
|
+
# @note When making an API call, you may pass GetMetricWidgetImageInput
|
792
|
+
# data as a hash:
|
793
|
+
#
|
794
|
+
# {
|
795
|
+
# metric_widget: "MetricWidget", # required
|
796
|
+
# output_format: "OutputFormat",
|
797
|
+
# }
|
798
|
+
#
|
799
|
+
# @!attribute [rw] metric_widget
|
800
|
+
# A JSON string that defines the bitmap graph to be retrieved. The
|
801
|
+
# string includes the metrics to include in the graph, statistics,
|
802
|
+
# annotations, title, axis limits, and so on. You can include only one
|
803
|
+
# `MetricWidget` parameter in each `GetMetricWidgetImage` call.
|
804
|
+
#
|
805
|
+
# For more information about the syntax of `MetricWidget` see
|
806
|
+
# CloudWatch-Metric-Widget-Structure.
|
807
|
+
#
|
808
|
+
# If any metric on the graph could not load all the requested data
|
809
|
+
# points, an orange triangle with an exclamation point appears next to
|
810
|
+
# the graph legend.
|
811
|
+
# @return [String]
|
812
|
+
#
|
813
|
+
# @!attribute [rw] output_format
|
814
|
+
# The format of the resulting image. Only PNG images are supported.
|
815
|
+
#
|
816
|
+
# The default is `png`. If you specify `png`, the API returns an HTTP
|
817
|
+
# response with the content-type set to `text/xml`. The image data is
|
818
|
+
# in a `MetricWidgetImage` field. For example:
|
819
|
+
#
|
820
|
+
# ` <GetMetricWidgetImageResponse
|
821
|
+
# xmlns="http://monitoring.amazonaws.com/doc/2010-08-01/">`
|
822
|
+
#
|
823
|
+
# ` <GetMetricWidgetImageResult>`
|
824
|
+
#
|
825
|
+
# ` <MetricWidgetImage>`
|
826
|
+
#
|
827
|
+
# ` iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...`
|
828
|
+
#
|
829
|
+
# ` </MetricWidgetImage>`
|
830
|
+
#
|
831
|
+
# ` </GetMetricWidgetImageResult>`
|
832
|
+
#
|
833
|
+
# ` <ResponseMetadata>`
|
834
|
+
#
|
835
|
+
# ` <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>`
|
836
|
+
#
|
837
|
+
# ` </ResponseMetadata>`
|
838
|
+
#
|
839
|
+
# `</GetMetricWidgetImageResponse>`
|
840
|
+
#
|
841
|
+
# The `image/png` setting is intended only for custom HTTP requests.
|
842
|
+
# For most use cases, and all actions using an AWS SDK, you should use
|
843
|
+
# `png`. If you specify `image/png`, the HTTP response has a
|
844
|
+
# content-type set to `image/png`, and the body of the response is a
|
845
|
+
# PNG image.
|
846
|
+
# @return [String]
|
847
|
+
#
|
848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImageInput AWS API Documentation
|
849
|
+
#
|
850
|
+
class GetMetricWidgetImageInput < Struct.new(
|
851
|
+
:metric_widget,
|
852
|
+
:output_format)
|
853
|
+
include Aws::Structure
|
854
|
+
end
|
855
|
+
|
856
|
+
# @!attribute [rw] metric_widget_image
|
857
|
+
# The image of the graph, in the output format specified.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImageOutput AWS API Documentation
|
861
|
+
#
|
862
|
+
class GetMetricWidgetImageOutput < Struct.new(
|
863
|
+
:metric_widget_image)
|
864
|
+
include Aws::Structure
|
865
|
+
end
|
866
|
+
|
791
867
|
# @note When making an API call, you may pass ListDashboardsInput
|
792
868
|
# data as a hash:
|
793
869
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudwatch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-09-
|
11
|
+
date: 2018-09-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|