aws-sdk-cloudwatch 1.68.0 → 1.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b718501f10f05a67dc0bf8071280afd3167e681e12f1bb0729a4fc85d25d9b1
-  data.tar.gz: 1b3b3042a63873bdccd7600dae9d1aee9a484fba08bbb54b93ae4cc811f79c48
+  metadata.gz: f87924964c2cfaf2682c68eaee5b97e974cac3c6ed450071ba31e5513a636a28
+  data.tar.gz: 0cf2c4d9f1287382c7bff3f63e63e523abeb5c9beeb3074e46463ecbe3b0da4f
 SHA512:
-  metadata.gz: 78f97ba774f9a70be7def6b906ce46ffe8bd896902230334fe89ce100faef406b1a7947648c55bf60bde2844cf555f65fc49185588ac417e90e94ebe5e712f4c
-  data.tar.gz: 2ced8d8861fb4fbe6d2fbc1ad2b88346786ba08a71315cdff96328adaf690c929ee5268e3fb92bb9f26cd985489779f30fcab79d7543c439c7788e3caa20388b
+  metadata.gz: a33ba6949fea82d1387a8a4ac41e1c0eda31119fb7cc72be5cb12c8bacc8b834a92c3be40c91e8a1e06f47fa7428f988eaaecf43950e7da7f5c2d20eddf77cdc
+  data.tar.gz: ad59c5669328545e20fcfd1a666a98085a0666ef4ff48146045f42b13b3e226e944b0a0e3c24222465b672bb219b4b4e69fab1e5093b3ca964d1ac5d480d9468

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.69.0 (2022-11-28)
+------------------
+
+* Feature - Adds cross-account support to the GetMetricData API. Adds cross-account support to the ListMetrics API through the usage of the IncludeLinkedAccounts flag and the new OwningAccounts field.
+
 1.68.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.68.0
+1.69.0

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

@@ -387,7 +387,7 @@ module Aws::CloudWatch
     # the rule of one of the composite alarms in the cycle to remove a
     # dependency that creates the cycle. The simplest change to make to
     # break a cycle is to change the `AlarmRule` of one of the alarms to
-    # `False`.
+    # `false`.
     #
     #  Additionally, the evaluation of composite alarms stops if CloudWatch
     # detects a cycle in the evaluation path.
@@ -1680,7 +1680,7 @@ module Aws::CloudWatch
     #   resp.metric_data_results[0].timestamps[0] #=> Time
     #   resp.metric_data_results[0].values #=> Array
     #   resp.metric_data_results[0].values[0] #=> Float
-    #   resp.metric_data_results[0].status_code #=> String, one of "Complete", "InternalError", "PartialData"
+    #   resp.metric_data_results[0].status_code #=> String, one of "Complete", "InternalError", "PartialData", "Forbidden"
     #   resp.metric_data_results[0].messages #=> Array
     #   resp.metric_data_results[0].messages[0].code #=> String
     #   resp.metric_data_results[0].messages[0].value #=> String
@@ -2204,15 +2204,20 @@ module Aws::CloudWatch
     end
 
     # List the specified metrics. You can use the returned metrics with
-    # [GetMetricData][1] or [GetMetricStatistics][2] to obtain statistical
+    # [GetMetricData][1] or [GetMetricStatistics][2] to get statistical
     # data.
     #
     # Up to 500 results are returned for any one call. To retrieve
     # additional results, use the returned token with subsequent calls.
     #
-    # After you create a metric, allow up to 15 minutes before the metric
-    # appears. You can see statistics about the metric sooner by using
-    # [GetMetricData][1] or [GetMetricStatistics][2].
+    # After you create a metric, allow up to 15 minutes for the metric to
+    # appear. To see metric statistics sooner, use [GetMetricData][1] or
+    # [GetMetricStatistics][2].
+    #
+    # If you are using CloudWatch cross-account observability, you can use
+    # this operation in a monitoring account and view metrics from the
+    # linked source accounts. For more information, see [CloudWatch
+    # cross-account observability][3].
     #
     # `ListMetrics` doesn't return information about metrics if those
     # metrics haven't reported data in the past two weeks. To retrieve
@@ -2222,6 +2227,7 @@ module Aws::CloudWatch
     #
     # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html
     # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html
+    # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
     #
     # @option params [String] :namespace
     #   The metric namespace to filter against. Only the namespace that
@@ -2249,10 +2255,23 @@ module Aws::CloudWatch
     #   metrics with last published data as much as 40 minutes more than the
     #   specified time interval.
     #
+    # @option params [Boolean] :include_linked_accounts
+    #   If you are using this operation in a monitoring account, specify
+    #   `true` to include metrics from source accounts in the returned data.
+    #
+    #   The default is `false`.
+    #
+    # @option params [String] :owning_account
+    #   When you use this operation in a monitoring account, use this field to
+    #   return metrics only from one source account. To do so, specify that
+    #   source account ID in this field, and also specify `true` for
+    #   `IncludeLinkedAccounts`.
+    #
     # @return [Types::ListMetricsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListMetricsOutput#metrics #metrics} => Array<Types::Metric>
     #   * {Types::ListMetricsOutput#next_token #next_token} => String
+    #   * {Types::ListMetricsOutput#owning_accounts #owning_accounts} => Array<String>
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
@@ -2269,6 +2288,8 @@ module Aws::CloudWatch
     #     ],
     #     next_token: "NextToken",
     #     recently_active: "PT3H", # accepts PT3H
+    #     include_linked_accounts: false,
+    #     owning_account: "AccountId",
     #   })
     #
     # @example Response structure
@@ -2280,6 +2301,8 @@ module Aws::CloudWatch
     #   resp.metrics[0].dimensions[0].name #=> String
     #   resp.metrics[0].dimensions[0].value #=> String
     #   resp.next_token #=> String
+    #   resp.owning_accounts #=> Array
+    #   resp.owning_accounts[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics AWS API Documentation
     #
@@ -2508,7 +2531,7 @@ module Aws::CloudWatch
     # the rule of one of the composite alarms in the cycle to remove a
     # dependency that creates the cycle. The simplest change to make to
     # break a cycle is to change the `AlarmRule` of one of the alarms to
-    # `False`.
+    # `false`.
     #
     #  Additionally, the evaluation of composite alarms stops if CloudWatch
     # detects a cycle in the evaluation path.
@@ -3383,12 +3406,12 @@ module Aws::CloudWatch
     end
 
     # Creates or updates a metric stream. Metric streams can automatically
-    # stream CloudWatch metrics to Amazon Web Services 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].
     #
-    # To create a metric stream, you must be logged on to an account that
+    # To create a metric stream, you must be signed in to an account that
     # has the `iam:PassRole` permission and either the
     # `CloudWatchFullAccess` policy or the `cloudwatch:PutMetricStream`
     # permission.
@@ -3407,7 +3430,7 @@ module Aws::CloudWatch
     # By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
     # `SAMPLECOUNT` statistics for each metric that is streamed. You can use
     # the `StatisticsConfigurations` parameter to have the metric stream
-    # also send additional statistics in the stream. Streaming additional
+    # send additional statistics in the stream. Streaming additional
     # statistics incurs additional costs. For more information, see [Amazon
     # CloudWatch Pricing][2].
     #
@@ -3445,15 +3468,16 @@ module Aws::CloudWatch
     #   operation.
     #
     # @option params [required, String] :firehose_arn
-    #   The ARN of the Amazon Kinesis Firehose delivery stream to use for this
-    #   metric stream. This Amazon Kinesis Firehose delivery stream must
-    #   already exist and must be in the same account as the metric stream.
+    #   The ARN of the Amazon Kinesis Data Firehose delivery stream to use for
+    #   this metric stream. This Amazon Kinesis Data Firehose delivery stream
+    #   must already exist and must be in the same account as the metric
+    #   stream.
     #
     # @option params [required, String] :role_arn
     #   The ARN of an IAM role that this metric stream will use to access
-    #   Amazon Kinesis Firehose resources. This IAM role must already exist
-    #   and must be in the same account as the metric stream. This IAM role
-    #   must include the following permissions:
+    #   Amazon Kinesis Data Firehose resources. This IAM role must already
+    #   exist and must be in the same account as the metric stream. This IAM
+    #   role must include the following permissions:
     #
     #   * firehose:PutRecord
     #
@@ -3500,7 +3524,7 @@ module Aws::CloudWatch
     #   additional statistic that is supported by CloudWatch, listed in [
     #   CloudWatch statistics definitions][1]. If the `OutputFormat` is
     #   `opentelemetry0.7`, you can stream percentile statistics such as p95,
-    #   p99.9 and so on.
+    #   p99.9, and so on.
     #
     #
     #
@@ -3789,7 +3813,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.68.0'
+      context[:gem_version] = '1.69.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -122,6 +122,7 @@ module Aws::CloudWatch
     HistoryData = Shapes::StringShape.new(name: 'HistoryData')
     HistoryItemType = Shapes::StringShape.new(name: 'HistoryItemType')
     HistorySummary = Shapes::StringShape.new(name: 'HistorySummary')
+    IncludeLinkedAccounts = Shapes::BooleanShape.new(name: 'IncludeLinkedAccounts')
     InsightRule = Shapes::StructureShape.new(name: 'InsightRule')
     InsightRuleAggregationStatistic = Shapes::StringShape.new(name: 'InsightRuleAggregationStatistic')
     InsightRuleContributor = Shapes::StructureShape.new(name: 'InsightRuleContributor')
@@ -216,6 +217,7 @@ module Aws::CloudWatch
     Namespace = Shapes::StringShape.new(name: 'Namespace')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     OutputFormat = Shapes::StringShape.new(name: 'OutputFormat')
+    OwningAccounts = Shapes::ListShape.new(name: 'OwningAccounts')
     PartialFailure = Shapes::StructureShape.new(name: 'PartialFailure')
     Period = Shapes::IntegerShape.new(name: 'Period')
     PutAnomalyDetectorInput = Shapes::StructureShape.new(name: 'PutAnomalyDetectorInput')
@@ -673,10 +675,13 @@ module Aws::CloudWatch
     ListMetricsInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionFilters, location_name: "Dimensions"))
     ListMetricsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListMetricsInput.add_member(:recently_active, Shapes::ShapeRef.new(shape: RecentlyActive, location_name: "RecentlyActive"))
+    ListMetricsInput.add_member(:include_linked_accounts, Shapes::ShapeRef.new(shape: IncludeLinkedAccounts, location_name: "IncludeLinkedAccounts"))
+    ListMetricsInput.add_member(:owning_account, Shapes::ShapeRef.new(shape: AccountId, location_name: "OwningAccount"))
     ListMetricsInput.struct_class = Types::ListMetricsInput
 
     ListMetricsOutput.add_member(:metrics, Shapes::ShapeRef.new(shape: Metrics, location_name: "Metrics"))
     ListMetricsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListMetricsOutput.add_member(:owning_accounts, Shapes::ShapeRef.new(shape: OwningAccounts, location_name: "OwningAccounts"))
     ListMetricsOutput.struct_class = Types::ListMetricsOutput
 
     ListTagsForResourceInput.add_member(:resource_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "ResourceARN"))
@@ -825,6 +830,8 @@ module Aws::CloudWatch
     MissingRequiredParameterException.add_member(:message, Shapes::ShapeRef.new(shape: AwsQueryErrorMessage, location_name: "message"))
     MissingRequiredParameterException.struct_class = Types::MissingRequiredParameterException
 
+    OwningAccounts.member = Shapes::ShapeRef.new(shape: AccountId)
+
     PartialFailure.add_member(:failure_resource, Shapes::ShapeRef.new(shape: FailureResource, location_name: "FailureResource"))
     PartialFailure.add_member(:exception_type, Shapes::ShapeRef.new(shape: ExceptionType, location_name: "ExceptionType"))
     PartialFailure.add_member(:failure_code, Shapes::ShapeRef.new(shape: FailureCode, location_name: "FailureCode"))

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

@@ -254,6 +254,8 @@ module Aws::CloudWatch
     #       },
     #     ],
     #     recently_active: "PT3H", # accepts PT3H
+    #     include_linked_accounts: false,
+    #     owning_account: "AccountId",
     #   })
     # @param [Hash] options ({})
     # @option options [String] :namespace
@@ -274,6 +276,16 @@ module Aws::CloudWatch
     #   specify. There is a low probability that the returned results include
     #   metrics with last published data as much as 40 minutes more than the
     #   specified time interval.
+    # @option options [Boolean] :include_linked_accounts
+    #   If you are using this operation in a monitoring account, specify
+    #   `true` to include metrics from source accounts in the returned data.
+    #
+    #   The default is `false`.
+    # @option options [String] :owning_account
+    #   When you use this operation in a monitoring account, use this field to
+    #   return metrics only from one source account. To do so, specify that
+    #   source account ID in this field, and also specify `true` for
+    #   `IncludeLinkedAccounts`.
     # @return [Metric::Collection]
     def metrics(options = {})
       batches = Enumerator.new do |y|

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

@@ -1818,8 +1818,8 @@ module Aws::CloudWatch
     #   @return [Array<Types::MetricStreamFilter>]
     #
     # @!attribute [rw] firehose_arn
-    #   The ARN of the Amazon Kinesis Firehose delivery stream that is used
-    #   by this metric stream.
+    #   The ARN of the Amazon Kinesis Data Firehose delivery stream that is
+    #   used by this metric stream.
     #   @return [String]
     #
     # @!attribute [rw] role_arn
@@ -2445,6 +2445,8 @@ module Aws::CloudWatch
     #         ],
     #         next_token: "NextToken",
     #         recently_active: "PT3H", # accepts PT3H
+    #         include_linked_accounts: false,
+    #         owning_account: "AccountId",
     #       }
     #
     # @!attribute [rw] namespace
@@ -2478,6 +2480,20 @@ module Aws::CloudWatch
     #   than the specified time interval.
     #   @return [String]
     #
+    # @!attribute [rw] include_linked_accounts
+    #   If you are using this operation in a monitoring account, specify
+    #   `true` to include metrics from source accounts in the returned data.
+    #
+    #   The default is `false`.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] owning_account
+    #   When you use this operation in a monitoring account, use this field
+    #   to return metrics only from one source account. To do so, specify
+    #   that source account ID in this field, and also specify `true` for
+    #   `IncludeLinkedAccounts`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput AWS API Documentation
     #
     class ListMetricsInput < Struct.new(
@@ -2485,7 +2501,9 @@ module Aws::CloudWatch
       :metric_name,
       :dimensions,
       :next_token,
-      :recently_active)
+      :recently_active,
+      :include_linked_accounts,
+      :owning_account)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2499,11 +2517,21 @@ module Aws::CloudWatch
     #   results.
     #   @return [String]
     #
+    # @!attribute [rw] owning_accounts
+    #   If you are using this operation in a monitoring account, this array
+    #   contains the account IDs of the source accounts where the metrics in
+    #   the returned data are from.
+    #
+    #   This field is a 1:1 mapping between each metric that is returned and
+    #   the ID of the owning account.
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsOutput AWS API Documentation
     #
     class ListMetricsOutput < Struct.new(
       :metrics,
-      :next_token)
+      :next_token,
+      :owning_accounts)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2914,7 +2942,7 @@ module Aws::CloudWatch
     # structures can include as many as 10 structures that contain a
     # `MetricStat` parameter to retrieve a metric, and as many as 10
     # structures that contain the `Expression` parameter to perform a math
-    # expression. Of those `Expression` structures, one must have `True` as
+    # expression. Of those `Expression` structures, one must have `true` as
     # the value for `ReturnData`. The result of this expression is the value
     # the alarm watches.
     #
@@ -3017,10 +3045,10 @@ module Aws::CloudWatch
     #   When used in `GetMetricData`, this option indicates whether to
     #   return the timestamps and raw data values of this metric. If you are
     #   performing this call just to do math expressions and do not also
-    #   need the raw data returned, you can specify `False`. If you omit
-    #   this, the default of `True` is used.
+    #   need the raw data returned, you can specify `false`. If you omit
+    #   this, the default of `true` is used.
     #
-    #   When used in `PutMetricAlarm`, specify `True` for the one expression
+    #   When used in `PutMetricAlarm`, specify `true` for the one expression
     #   result to use as the alarm. For all other metrics and expressions in
     #   the same `PutMetricAlarm` operation, specify `ReturnData` as False.
     #   @return [Boolean]
@@ -3037,11 +3065,15 @@ module Aws::CloudWatch
     #   @return [Integer]
     #
     # @!attribute [rw] account_id
-    #   The ID of the account where the metrics are located, if this is a
-    #   cross-account alarm.
+    #   The ID of the account where the metrics are located.
+    #
+    #   If you are performing a `GetMetricData` operation in a monitoring
+    #   account, use this to specify which account to retrieve this metric
+    #   from.
     #
-    #   Use this field only for `PutMetricAlarm` operations. It is not used
-    #   in `GetMetricData` operations.
+    #   If you are performing a `PutMetricAlarm` operation, use this to
+    #   specify which account contains the metric that the alarm is
+    #   watching.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery AWS API Documentation
@@ -3272,9 +3304,9 @@ module Aws::CloudWatch
     #   Each item in `MetricDataQueries` gets a metric or performs a math
     #   expression. One item in `MetricDataQueries` is the expression that
     #   provides the time series that the anomaly detector uses as input.
-    #   Designate the expression by setting `ReturnData` to `True` for this
+    #   Designate the expression by setting `ReturnData` to `true` for this
     #   object in the array. For all other expressions and metrics, set
-    #   `ReturnData` to `False`. The designated expression must return a
+    #   `ReturnData` to `false`. The designated expression must return a
     #   single time series.
     #   @return [Array<Types::MetricDataQuery>]
     #
@@ -4567,17 +4599,17 @@ module Aws::CloudWatch
     #   @return [Array<Types::MetricStreamFilter>]
     #
     # @!attribute [rw] firehose_arn
-    #   The ARN of the Amazon Kinesis Firehose delivery stream to use for
-    #   this metric stream. This Amazon Kinesis Firehose delivery stream
-    #   must already exist and must be in the same account as the metric
-    #   stream.
+    #   The ARN of the Amazon Kinesis Data Firehose delivery stream to use
+    #   for this metric stream. This Amazon Kinesis Data Firehose delivery
+    #   stream must already exist and must be in the same account as the
+    #   metric stream.
     #   @return [String]
     #
     # @!attribute [rw] role_arn
     #   The ARN of an IAM role that this metric stream will use to access
-    #   Amazon Kinesis Firehose resources. This IAM role must already exist
-    #   and must be in the same account as the metric stream. This IAM role
-    #   must include the following permissions:
+    #   Amazon Kinesis Data Firehose resources. This IAM role must already
+    #   exist and must be in the same account as the metric stream. This IAM
+    #   role must include the following permissions:
     #
     #   * firehose:PutRecord
     #
@@ -4629,7 +4661,7 @@ module Aws::CloudWatch
     #   additional statistic that is supported by CloudWatch, listed in [
     #   CloudWatch statistics definitions][1]. If the `OutputFormat` is
     #   `opentelemetry0.7`, you can stream percentile statistics such as
-    #   p95, p99.9 and so on.
+    #   p95, p99.9, and so on.
     #
     #
     #

data/lib/aws-sdk-cloudwatch.rb

@@ -56,6 +56,6 @@ require_relative 'aws-sdk-cloudwatch/customizations'
 # @!group service
 module Aws::CloudWatch
 
-  GEM_VERSION = '1.68.0'
+  GEM_VERSION = '1.69.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.68.0
+  version: 1.69.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core