aws-sdk-cloudwatch 1.51.0 → 1.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4564760b7b8d0aaad992dcca3f21ab5826f3adcf37f4be062726ce64253b0d8d
-  data.tar.gz: 888a205121f81f9ffe4b3c39d04bc7e3365493a096503b0f6a30ed38f8decf4f
+  metadata.gz: b09a499a0ebd8466f0cf1e54facc543fedd2fd9370d9cb09d45869315cde8eff
+  data.tar.gz: 541e2421917ea47f92a462103aabffeb1a1c9faedf990ff52f85e13f6de2c717
 SHA512:
-  metadata.gz: c42f3480584c4a8513b7f6c33549b8c232ff6a5fd2463e8fb727a6a6e9105ec1f4d843d72cdb10d802ec860e551ee15df7b425e7b52b1b8ed07a2e041fb39ac5
-  data.tar.gz: b26baaa6c7288b95c1786c8931cbe0919f2727f27969e4df5e911664223181f4aa0599b9224bb1c552fa98a11dc6725ff2f373ac95ad6a783422c5384c86dadd
+  metadata.gz: 9e2fb5a2f727e7a2bbc352c4a465fa1bdad1b4861af26da5d426509de50996e756df0042557ba4aab71e83e6aa7edf096788282907b1ea4bb86a92b059d61712
+  data.tar.gz: b55dc1d9fb04f29a942356f5d4eff1162ca1b9eca8b8c430934b893d1638b8c5314951aa5425742d6495a0e6a176af4780a76c1720d25dfc7f2306d3fa9fe4ea

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.52.0 (2021-07-26)
+------------------
+
+* Feature - SDK update to support creation of Cross-Account Metric Alarms and update API documentation.
+
 1.51.0 (2021-03-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.51.0
+1.52.0

data/lib/aws-sdk-cloudwatch.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-cloudwatch/customizations'
 # @!group service
 module Aws::CloudWatch
 
-  GEM_VERSION = '1.51.0'
+  GEM_VERSION = '1.52.0'
 
 end

data/lib/aws-sdk-cloudwatch/client.rb

@@ -740,6 +740,7 @@ module Aws::CloudWatch
     #   resp.metric_alarms[0].metrics[0].label #=> String
     #   resp.metric_alarms[0].metrics[0].return_data #=> Boolean
     #   resp.metric_alarms[0].metrics[0].period #=> Integer
+    #   resp.metric_alarms[0].metrics[0].account_id #=> String
     #   resp.metric_alarms[0].threshold_metric_id #=> String
     #   resp.next_token #=> String
     #
@@ -859,6 +860,7 @@ module Aws::CloudWatch
     #   resp.metric_alarms[0].metrics[0].label #=> String
     #   resp.metric_alarms[0].metrics[0].return_data #=> Boolean
     #   resp.metric_alarms[0].metrics[0].period #=> Integer
+    #   resp.metric_alarms[0].metrics[0].account_id #=> String
     #   resp.metric_alarms[0].threshold_metric_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric AWS API Documentation
@@ -1455,6 +1457,7 @@ module Aws::CloudWatch
     #         label: "MetricLabel",
     #         return_data: false,
     #         period: 1,
+    #         account_id: "AccountId",
     #       },
     #     ],
     #     start_time: Time.now, # required
@@ -1549,8 +1552,8 @@ module Aws::CloudWatch
     # CloudWatch started retaining 5-minute and 1-hour metric data as of
     # July 9, 2016.
     #
-    # For information about metrics and dimensions supported by AWS
-    # services, see the [Amazon CloudWatch Metrics and Dimensions
+    # For information about metrics and dimensions supported by Amazon Web
+    # Services services, see the [Amazon CloudWatch Metrics and Dimensions
     # Reference][1] in the *Amazon CloudWatch User Guide*.
     #
     #
@@ -1819,8 +1822,8 @@ module Aws::CloudWatch
     #   `</GetMetricWidgetImageResponse>`
     #
     #   The `image/png` setting is intended only for custom HTTP requests. For
-    #   most use cases, and all actions using an AWS SDK, you should use
-    #   `png`. If you specify `image/png`, the HTTP response has a
+    #   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.
     #
@@ -1911,7 +1914,7 @@ module Aws::CloudWatch
     # @return [Types::ListMetricStreamsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListMetricStreamsOutput#next_token #next_token} => String
-    #   * {Types::ListMetricStreamsOutput#entries #entries} => Array&lt;Types::MetricStreamEntry&gt;
+    #   * {Types::ListMetricStreamsOutput#entries #data.entries} => Array&lt;Types::MetricStreamEntry&gt; (This method conflicts with a method on Response, call it through the data member)
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
@@ -1925,14 +1928,14 @@ module Aws::CloudWatch
     # @example Response structure
     #
     #   resp.next_token #=> String
-    #   resp.entries #=> Array
-    #   resp.entries[0].arn #=> String
-    #   resp.entries[0].creation_date #=> Time
-    #   resp.entries[0].last_update_date #=> Time
-    #   resp.entries[0].name #=> String
-    #   resp.entries[0].firehose_arn #=> String
-    #   resp.entries[0].state #=> String
-    #   resp.entries[0].output_format #=> String, one of "json", "opentelemetry0.7"
+    #   resp.data.entries #=> Array
+    #   resp.data.entries[0].arn #=> String
+    #   resp.data.entries[0].creation_date #=> Time
+    #   resp.data.entries[0].last_update_date #=> Time
+    #   resp.data.entries[0].name #=> String
+    #   resp.data.entries[0].firehose_arn #=> String
+    #   resp.data.entries[0].state #=> String
+    #   resp.data.entries[0].output_format #=> String, one of "json", "opentelemetry0.7"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricStreams AWS API Documentation
     #
@@ -2476,16 +2479,39 @@ module Aws::CloudWatch
     # * The `iam:CreateServiceLinkedRole` to create an alarm with Systems
     #   Manager OpsItem actions.
     #
-    # The first time you create an alarm in the AWS Management Console, the
-    # CLI, or by using the PutMetricAlarm API, CloudWatch creates the
-    # necessary service-linked role for you. The service-linked roles are
-    # called `AWSServiceRoleForCloudWatchEvents` and
+    # The first time you create an alarm in the Management Console, the CLI,
+    # or by using the PutMetricAlarm API, CloudWatch creates the necessary
+    # service-linked role for you. The service-linked roles are called
+    # `AWSServiceRoleForCloudWatchEvents` and
     # `AWSServiceRoleForCloudWatchAlarms_ActionSSM`. For more information,
-    # see [AWS service-linked role][1].
+    # see [Amazon Web Services service-linked role][1].
+    #
+    # **Cross-account alarms**
+    #
+    # You can set an alarm on metrics in the current account, or in another
+    # account. To create a cross-account alarm that watches a metric in a
+    # different account, you must have completed the following
+    # pre-requisites:
+    #
+    # * The account where the metrics are located (the *sharing account*)
+    #   must already have a sharing role named
+    #   **CloudWatch-CrossAccountSharingRole**. If it does not already have
+    #   this role, you must create it using the instructions in **Set up a
+    #   sharing account** in [ Cross-account cross-Region CloudWatch
+    #   console][2]. The policy for that role must grant access to the ID of
+    #   the account where you are creating the alarm.
+    #
+    # * The account where you are creating the alarm (the *monitoring
+    #   account*) must already have a service-linked role named
+    #   **AWSServiceRoleForCloudWatchCrossAccount** to allow CloudWatch to
+    #   assume the sharing role in the sharing account. If it does not, you
+    #   must create it following the directions in **Set up a monitoring
+    #   account** in [ Cross-account cross-Region CloudWatch console][2].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role
+    # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region
     #
     # @option params [required, String] :alarm_name
     #   The name for the alarm. This name must be unique within the Region.
@@ -2530,7 +2556,8 @@ module Aws::CloudWatch
     #   `arn:aws:automate:region:ec2:reboot` \|
     #   `arn:aws:sns:region:account-id:sns-topic-name ` \|
     #   `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
-    #   ` \| `arn:aws:ssm:region:account-id:opsitem:severity `
+    #   ` \| `arn:aws:ssm:region:account-id:opsitem:severity ` \|
+    #   `arn:aws:ssm-incidents::account-id:response-plan:response-plan-name `
     #
     #   Valid Values (for use with IAM roles):
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
@@ -2538,6 +2565,8 @@ module Aws::CloudWatch
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
     #   \|
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
+    #   \|
+    #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
     #
     # @option params [Array<String>] :insufficient_data_actions
     #   The actions to execute when this alarm transitions to the
@@ -2801,6 +2830,7 @@ module Aws::CloudWatch
     #         label: "MetricLabel",
     #         return_data: false,
     #         period: 1,
+    #         account_id: "AccountId",
     #       },
     #     ],
     #     tags: [
@@ -2881,8 +2911,8 @@ module Aws::CloudWatch
     # @option params [required, String] :namespace
     #   The namespace for the metric data.
     #
-    #   To avoid conflicts with AWS service namespaces, you should not specify
-    #   a namespace that begins with `AWS/`
+    #   To avoid conflicts with Amazon Web Services service namespaces, you
+    #   should not specify a namespace that begins with `AWS/`
     #
     # @option params [required, Array<Types::MetricDatum>] :metric_data
     #   The data for the metric. The array can include no more than 20 metrics
@@ -2929,8 +2959,8 @@ module Aws::CloudWatch
     end
 
     # Creates or updates a metric stream. Metric streams can automatically
-    # stream CloudWatch metrics to AWS destinations including Amazon S3 and
-    # to many third-party solutions.
+    # stream CloudWatch metrics to Amazon Web Services destinations
+    # including Amazon S3 and to many third-party solutions.
     #
     # For more information, see [ Using Metric Streams][1].
     #
@@ -3014,6 +3044,17 @@ module Aws::CloudWatch
     #   use them to scope user permissions by granting a user permission to
     #   access or change only resources with certain tag values.
     #
+    #   You can use this parameter only when you are creating a new metric
+    #   stream. If you are using this operation to update an existing metric
+    #   stream, any tags you specify in this parameter are ignored. To change
+    #   the tags of an existing metric stream, use [TagResource][1] or
+    #   [UntagResource][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
+    #
     # @return [Types::PutMetricStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::PutMetricStreamOutput#arn #arn} => String
@@ -3181,8 +3222,8 @@ module Aws::CloudWatch
     # use them to scope user permissions by granting a user permission to
     # access or change only resources with certain tag values.
     #
-    # Tags don't have any semantic meaning to AWS and are interpreted
-    # strictly as strings of characters.
+    # Tags don't have any semantic meaning to Amazon Web Services and are
+    # interpreted strictly as strings of characters.
     #
     # You can use the `TagResource` action with an alarm that already has
     # tags. If you specify a new tag key for the alarm, this tag is appended
@@ -3286,7 +3327,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.51.0'
+      context[:gem_version] = '1.52.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudwatch/client_api.rb

@@ -13,6 +13,7 @@ module Aws::CloudWatch
 
     include Seahorse::Model
 
+    AccountId = Shapes::StringShape.new(name: 'AccountId')
     ActionPrefix = Shapes::StringShape.new(name: 'ActionPrefix')
     ActionsEnabled = Shapes::BooleanShape.new(name: 'ActionsEnabled')
     AlarmArn = Shapes::StringShape.new(name: 'AlarmArn')
@@ -686,6 +687,7 @@ module Aws::CloudWatch
     MetricDataQuery.add_member(:label, Shapes::ShapeRef.new(shape: MetricLabel, location_name: "Label"))
     MetricDataQuery.add_member(:return_data, Shapes::ShapeRef.new(shape: ReturnData, location_name: "ReturnData"))
     MetricDataQuery.add_member(:period, Shapes::ShapeRef.new(shape: Period, location_name: "Period"))
+    MetricDataQuery.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
     MetricDataQuery.struct_class = Types::MetricDataQuery
 
     MetricDataResult.add_member(:id, Shapes::ShapeRef.new(shape: MetricId, location_name: "Id"))

data/lib/aws-sdk-cloudwatch/metric.rb

@@ -351,6 +351,7 @@ module Aws::CloudWatch
     #         label: "MetricLabel",
     #         return_data: false,
     #         period: 1,
+    #         account_id: "AccountId",
     #       },
     #     ],
     #     tags: [
@@ -401,7 +402,8 @@ module Aws::CloudWatch
     #   `arn:aws:automate:region:ec2:reboot` \|
     #   `arn:aws:sns:region:account-id:sns-topic-name ` \|
     #   `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
-    #   ` \| `arn:aws:ssm:region:account-id:opsitem:severity `
+    #   ` \| `arn:aws:ssm:region:account-id:opsitem:severity ` \|
+    #   `arn:aws:ssm-incidents::account-id:response-plan:response-plan-name `
     #
     #   Valid Values (for use with IAM roles):
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
@@ -409,6 +411,8 @@ module Aws::CloudWatch
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
     #   \|
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
+    #   \|
+    #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
     # @option options [Array<String>] :insufficient_data_actions
     #   The actions to execute when this alarm transitions to the
     #   `INSUFFICIENT_DATA` state from any other state. Each action is

data/lib/aws-sdk-cloudwatch/types.rb

@@ -945,13 +945,13 @@ module Aws::CloudWatch
     #       }
     #
     # @!attribute [rw] name
-    #   The name of the dimension. Dimension names cannot contain blank
-    #   spaces or non-ASCII characters.
+    #   The name of the dimension. Dimension names must contain only ASCII
+    #   characters and must include at least one non-whitespace character.
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   The value of the dimension. Dimension values cannot contain blank
-    #   spaces or non-ASCII characters.
+    #   The value of the dimension. Dimension values must contain only ASCII
+    #   characters and must include at least one non-whitespace character.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension AWS API Documentation
@@ -1313,6 +1313,7 @@ module Aws::CloudWatch
     #             label: "MetricLabel",
     #             return_data: false,
     #             period: 1,
+    #             account_id: "AccountId",
     #           },
     #         ],
     #         start_time: Time.now, # required
@@ -1756,10 +1757,10 @@ module Aws::CloudWatch
     #   `</GetMetricWidgetImageResponse>`
     #
     #   The `image/png` setting is intended only for custom HTTP requests.
-    #   For most use cases, and all actions using an AWS 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.
+    #   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.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImageInput AWS API Documentation
@@ -2316,6 +2317,11 @@ module Aws::CloudWatch
     # A message returned by the `GetMetricData`API, including a code and a
     # description.
     #
+    # If a cross-Region `GetMetricData` operation fails with a code of
+    # `Forbidden` and a value of `Authentication too complex to retrieve
+    # cross region data`, you can correct the problem by running the
+    # `GetMetricData` operation in the same Region where the metric data is.
+    #
     # @!attribute [rw] code
     #   The error code or status code associated with the message.
     #   @return [String]
@@ -2599,6 +2605,7 @@ module Aws::CloudWatch
     #         label: "MetricLabel",
     #         return_data: false,
     #         period: 1,
+    #         account_id: "AccountId",
     #       }
     #
     # @!attribute [rw] id
@@ -2674,6 +2681,14 @@ module Aws::CloudWatch
     #   second`.
     #   @return [Integer]
     #
+    # @!attribute [rw] account_id
+    #   The ID of the account where the metrics are located, if this is a
+    #   cross-account alarm.
+    #
+    #   Use this field only for `PutMetricAlarm` operations. It is not used
+    #   in `GetMetricData` operations.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery AWS API Documentation
     #
     class MetricDataQuery < Struct.new(
@@ -2682,7 +2697,8 @@ module Aws::CloudWatch
       :expression,
       :label,
       :return_data,
-      :period)
+      :period,
+      :account_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3441,6 +3457,7 @@ module Aws::CloudWatch
     #             label: "MetricLabel",
     #             return_data: false,
     #             period: 1,
+    #             account_id: "AccountId",
     #           },
     #         ],
     #         tags: [
@@ -3499,7 +3516,9 @@ module Aws::CloudWatch
     #   `arn:aws:automate:region:ec2:reboot` \|
     #   `arn:aws:sns:region:account-id:sns-topic-name ` \|
     #   `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
-    #   ` \| `arn:aws:ssm:region:account-id:opsitem:severity `
+    #   ` \| `arn:aws:ssm:region:account-id:opsitem:severity ` \|
+    #   `arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
+    #   `
     #
     #   Valid Values (for use with IAM roles):
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
@@ -3507,6 +3526,8 @@ module Aws::CloudWatch
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
     #   \|
     #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
+    #   \|
+    #   `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
     #   @return [Array<String>]
     #
     # @!attribute [rw] insufficient_data_actions
@@ -3803,8 +3824,8 @@ module Aws::CloudWatch
     # @!attribute [rw] namespace
     #   The namespace for the metric data.
     #
-    #   To avoid conflicts with AWS service namespaces, you should not
-    #   specify a namespace that begins with `AWS/`
+    #   To avoid conflicts with Amazon Web Services service namespaces, you
+    #   should not specify a namespace that begins with `AWS/`
     #   @return [String]
     #
     # @!attribute [rw] metric_data
@@ -3910,6 +3931,17 @@ module Aws::CloudWatch
     #   also use them to scope user permissions by granting a user
     #   permission to access or change only resources with certain tag
     #   values.
+    #
+    #   You can use this parameter only when you are creating a new metric
+    #   stream. If you are using this operation to update an existing metric
+    #   stream, any tags you specify in this parameter are ignored. To
+    #   change the tags of an existing metric stream, use [TagResource][1]
+    #   or [UntagResource][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
     #   @return [Array<Types::Tag>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStreamInput AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.51.0
+  version: 1.52.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -87,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - CloudWatch