aws-sdk-cloudwatch 1.0.0.rc6 → 1.0.0.rc7

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

@@ -22,11 +22,26 @@ module Aws::CloudWatch
     AlarmNames = Shapes::ListShape.new(name: 'AlarmNames')
     AwsQueryErrorMessage = Shapes::StringShape.new(name: 'AwsQueryErrorMessage')
     ComparisonOperator = Shapes::StringShape.new(name: 'ComparisonOperator')
+    DashboardArn = Shapes::StringShape.new(name: 'DashboardArn')
+    DashboardBody = Shapes::StringShape.new(name: 'DashboardBody')
+    DashboardEntries = Shapes::ListShape.new(name: 'DashboardEntries')
+    DashboardEntry = Shapes::StructureShape.new(name: 'DashboardEntry')
+    DashboardErrorMessage = Shapes::StringShape.new(name: 'DashboardErrorMessage')
+    DashboardInvalidInputError = Shapes::StructureShape.new(name: 'DashboardInvalidInputError')
+    DashboardName = Shapes::StringShape.new(name: 'DashboardName')
+    DashboardNamePrefix = Shapes::StringShape.new(name: 'DashboardNamePrefix')
+    DashboardNames = Shapes::ListShape.new(name: 'DashboardNames')
+    DashboardNotFoundError = Shapes::StructureShape.new(name: 'DashboardNotFoundError')
+    DashboardValidationMessage = Shapes::StructureShape.new(name: 'DashboardValidationMessage')
+    DashboardValidationMessages = Shapes::ListShape.new(name: 'DashboardValidationMessages')
+    DataPath = Shapes::StringShape.new(name: 'DataPath')
     Datapoint = Shapes::StructureShape.new(name: 'Datapoint')
     DatapointValue = Shapes::FloatShape.new(name: 'DatapointValue')
     DatapointValueMap = Shapes::MapShape.new(name: 'DatapointValueMap')
     Datapoints = Shapes::ListShape.new(name: 'Datapoints')
     DeleteAlarmsInput = Shapes::StructureShape.new(name: 'DeleteAlarmsInput')
+    DeleteDashboardsInput = Shapes::StructureShape.new(name: 'DeleteDashboardsInput')
+    DeleteDashboardsOutput = Shapes::StructureShape.new(name: 'DeleteDashboardsOutput')
     DescribeAlarmHistoryInput = Shapes::StructureShape.new(name: 'DescribeAlarmHistoryInput')
     DescribeAlarmHistoryOutput = Shapes::StructureShape.new(name: 'DescribeAlarmHistoryOutput')
     DescribeAlarmsForMetricInput = Shapes::StructureShape.new(name: 'DescribeAlarmsForMetricInput')
@@ -47,6 +62,8 @@ module Aws::CloudWatch
     ExtendedStatistic = Shapes::StringShape.new(name: 'ExtendedStatistic')
     ExtendedStatistics = Shapes::ListShape.new(name: 'ExtendedStatistics')
     FaultDescription = Shapes::StringShape.new(name: 'FaultDescription')
+    GetDashboardInput = Shapes::StructureShape.new(name: 'GetDashboardInput')
+    GetDashboardOutput = Shapes::StructureShape.new(name: 'GetDashboardOutput')
     GetMetricStatisticsInput = Shapes::StructureShape.new(name: 'GetMetricStatisticsInput')
     GetMetricStatisticsOutput = Shapes::StructureShape.new(name: 'GetMetricStatisticsOutput')
     HistoryData = Shapes::StringShape.new(name: 'HistoryData')
@@ -57,10 +74,14 @@ module Aws::CloudWatch
     InvalidNextToken = Shapes::StructureShape.new(name: 'InvalidNextToken')
     InvalidParameterCombinationException = Shapes::StructureShape.new(name: 'InvalidParameterCombinationException')
     InvalidParameterValueException = Shapes::StructureShape.new(name: 'InvalidParameterValueException')
+    LastModified = Shapes::TimestampShape.new(name: 'LastModified')
     LimitExceededFault = Shapes::StructureShape.new(name: 'LimitExceededFault')
+    ListDashboardsInput = Shapes::StructureShape.new(name: 'ListDashboardsInput')
+    ListDashboardsOutput = Shapes::StructureShape.new(name: 'ListDashboardsOutput')
     ListMetricsInput = Shapes::StructureShape.new(name: 'ListMetricsInput')
     ListMetricsOutput = Shapes::StructureShape.new(name: 'ListMetricsOutput')
     MaxRecords = Shapes::IntegerShape.new(name: 'MaxRecords')
+    Message = Shapes::StringShape.new(name: 'Message')
     Metric = Shapes::StructureShape.new(name: 'Metric')
     MetricAlarm = Shapes::StructureShape.new(name: 'MetricAlarm')
     MetricAlarms = Shapes::ListShape.new(name: 'MetricAlarms')
@@ -73,12 +94,15 @@ module Aws::CloudWatch
     Namespace = Shapes::StringShape.new(name: 'Namespace')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     Period = Shapes::IntegerShape.new(name: 'Period')
+    PutDashboardInput = Shapes::StructureShape.new(name: 'PutDashboardInput')
+    PutDashboardOutput = Shapes::StructureShape.new(name: 'PutDashboardOutput')
     PutMetricAlarmInput = Shapes::StructureShape.new(name: 'PutMetricAlarmInput')
     PutMetricDataInput = Shapes::StructureShape.new(name: 'PutMetricDataInput')
     ResourceList = Shapes::ListShape.new(name: 'ResourceList')
     ResourceName = Shapes::StringShape.new(name: 'ResourceName')
     ResourceNotFound = Shapes::StructureShape.new(name: 'ResourceNotFound')
     SetAlarmStateInput = Shapes::StructureShape.new(name: 'SetAlarmStateInput')
+    Size = Shapes::IntegerShape.new(name: 'Size')
     StandardUnit = Shapes::StringShape.new(name: 'StandardUnit')
     StateReason = Shapes::StringShape.new(name: 'StateReason')
     StateReasonData = Shapes::StringShape.new(name: 'StateReasonData')
@@ -86,6 +110,7 @@ module Aws::CloudWatch
     Statistic = Shapes::StringShape.new(name: 'Statistic')
     StatisticSet = Shapes::StructureShape.new(name: 'StatisticSet')
     Statistics = Shapes::ListShape.new(name: 'Statistics')
+    StorageResolution = Shapes::IntegerShape.new(name: 'StorageResolution')
     Threshold = Shapes::FloatShape.new(name: 'Threshold')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     TreatMissingData = Shapes::StringShape.new(name: 'TreatMissingData')
@@ -101,6 +126,22 @@ module Aws::CloudWatch
 
     AlarmNames.member = Shapes::ShapeRef.new(shape: AlarmName)
 
+    DashboardEntries.member = Shapes::ShapeRef.new(shape: DashboardEntry)
+
+    DashboardEntry.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, location_name: "DashboardName"))
+    DashboardEntry.add_member(:dashboard_arn, Shapes::ShapeRef.new(shape: DashboardArn, location_name: "DashboardArn"))
+    DashboardEntry.add_member(:last_modified, Shapes::ShapeRef.new(shape: LastModified, location_name: "LastModified"))
+    DashboardEntry.add_member(:size, Shapes::ShapeRef.new(shape: Size, location_name: "Size"))
+    DashboardEntry.struct_class = Types::DashboardEntry
+
+    DashboardNames.member = Shapes::ShapeRef.new(shape: DashboardName)
+
+    DashboardValidationMessage.add_member(:data_path, Shapes::ShapeRef.new(shape: DataPath, location_name: "DataPath"))
+    DashboardValidationMessage.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
+    DashboardValidationMessage.struct_class = Types::DashboardValidationMessage
+
+    DashboardValidationMessages.member = Shapes::ShapeRef.new(shape: DashboardValidationMessage)
+
     Datapoint.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
     Datapoint.add_member(:sample_count, Shapes::ShapeRef.new(shape: DatapointValue, location_name: "SampleCount"))
     Datapoint.add_member(:average, Shapes::ShapeRef.new(shape: DatapointValue, location_name: "Average"))
@@ -119,6 +160,11 @@ module Aws::CloudWatch
     DeleteAlarmsInput.add_member(:alarm_names, Shapes::ShapeRef.new(shape: AlarmNames, required: true, location_name: "AlarmNames"))
     DeleteAlarmsInput.struct_class = Types::DeleteAlarmsInput
 
+    DeleteDashboardsInput.add_member(:dashboard_names, Shapes::ShapeRef.new(shape: DashboardNames, location_name: "DashboardNames"))
+    DeleteDashboardsInput.struct_class = Types::DeleteDashboardsInput
+
+    DeleteDashboardsOutput.struct_class = Types::DeleteDashboardsOutput
+
     DescribeAlarmHistoryInput.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "AlarmName"))
     DescribeAlarmHistoryInput.add_member(:history_item_type, Shapes::ShapeRef.new(shape: HistoryItemType, location_name: "HistoryItemType"))
     DescribeAlarmHistoryInput.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartDate"))
@@ -175,6 +221,14 @@ module Aws::CloudWatch
 
     ExtendedStatistics.member = Shapes::ShapeRef.new(shape: ExtendedStatistic)
 
+    GetDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, location_name: "DashboardName"))
+    GetDashboardInput.struct_class = Types::GetDashboardInput
+
+    GetDashboardOutput.add_member(:dashboard_arn, Shapes::ShapeRef.new(shape: DashboardArn, location_name: "DashboardArn"))
+    GetDashboardOutput.add_member(:dashboard_body, Shapes::ShapeRef.new(shape: DashboardBody, location_name: "DashboardBody"))
+    GetDashboardOutput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, location_name: "DashboardName"))
+    GetDashboardOutput.struct_class = Types::GetDashboardOutput
+
     GetMetricStatisticsInput.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location_name: "Namespace"))
     GetMetricStatisticsInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
     GetMetricStatisticsInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
@@ -190,6 +244,14 @@ module Aws::CloudWatch
     GetMetricStatisticsOutput.add_member(:datapoints, Shapes::ShapeRef.new(shape: Datapoints, location_name: "Datapoints"))
     GetMetricStatisticsOutput.struct_class = Types::GetMetricStatisticsOutput
 
+    ListDashboardsInput.add_member(:dashboard_name_prefix, Shapes::ShapeRef.new(shape: DashboardNamePrefix, location_name: "DashboardNamePrefix"))
+    ListDashboardsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListDashboardsInput.struct_class = Types::ListDashboardsInput
+
+    ListDashboardsOutput.add_member(:dashboard_entries, Shapes::ShapeRef.new(shape: DashboardEntries, location_name: "DashboardEntries"))
+    ListDashboardsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListDashboardsOutput.struct_class = Types::ListDashboardsOutput
+
     ListMetricsInput.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "Namespace"))
     ListMetricsInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName"))
     ListMetricsInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionFilters, location_name: "Dimensions"))
@@ -241,10 +303,18 @@ module Aws::CloudWatch
     MetricDatum.add_member(:value, Shapes::ShapeRef.new(shape: DatapointValue, location_name: "Value"))
     MetricDatum.add_member(:statistic_values, Shapes::ShapeRef.new(shape: StatisticSet, location_name: "StatisticValues"))
     MetricDatum.add_member(:unit, Shapes::ShapeRef.new(shape: StandardUnit, location_name: "Unit"))
+    MetricDatum.add_member(:storage_resolution, Shapes::ShapeRef.new(shape: StorageResolution, location_name: "StorageResolution"))
     MetricDatum.struct_class = Types::MetricDatum
 
     Metrics.member = Shapes::ShapeRef.new(shape: Metric)
 
+    PutDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, location_name: "DashboardName"))
+    PutDashboardInput.add_member(:dashboard_body, Shapes::ShapeRef.new(shape: DashboardBody, location_name: "DashboardBody"))
+    PutDashboardInput.struct_class = Types::PutDashboardInput
+
+    PutDashboardOutput.add_member(:dashboard_validation_messages, Shapes::ShapeRef.new(shape: DashboardValidationMessages, location_name: "DashboardValidationMessages"))
+    PutDashboardOutput.struct_class = Types::PutDashboardOutput
+
     PutMetricAlarmInput.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, required: true, location_name: "AlarmName"))
     PutMetricAlarmInput.add_member(:alarm_description, Shapes::ShapeRef.new(shape: AlarmDescription, location_name: "AlarmDescription"))
     PutMetricAlarmInput.add_member(:actions_enabled, Shapes::ShapeRef.new(shape: ActionsEnabled, location_name: "ActionsEnabled"))
@@ -308,6 +378,17 @@ module Aws::CloudWatch
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFound)
       end)
 
+      api.add_operation(:delete_dashboards, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteDashboards"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DeleteDashboardsInput)
+        o.output = Shapes::ShapeRef.new(shape: DeleteDashboardsOutput)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
+        o.errors << Shapes::ShapeRef.new(shape: DashboardNotFoundError)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
+      end)
+
       api.add_operation(:describe_alarm_history, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeAlarmHistory"
         o.http_method = "POST"
@@ -362,6 +443,17 @@ module Aws::CloudWatch
         o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
       end)
 
+      api.add_operation(:get_dashboard, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetDashboard"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetDashboardInput)
+        o.output = Shapes::ShapeRef.new(shape: GetDashboardOutput)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
+        o.errors << Shapes::ShapeRef.new(shape: DashboardNotFoundError)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
+      end)
+
       api.add_operation(:get_metric_statistics, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetMetricStatistics"
         o.http_method = "POST"
@@ -374,6 +466,16 @@ module Aws::CloudWatch
         o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
       end)
 
+      api.add_operation(:list_dashboards, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListDashboards"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListDashboardsInput)
+        o.output = Shapes::ShapeRef.new(shape: ListDashboardsOutput)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
+      end)
+
       api.add_operation(:list_metrics, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListMetrics"
         o.http_method = "POST"
@@ -389,6 +491,16 @@ module Aws::CloudWatch
         )
       end)
 
+      api.add_operation(:put_dashboard, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "PutDashboard"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: PutDashboardInput)
+        o.output = Shapes::ShapeRef.new(shape: PutDashboardOutput)
+        o.errors << Shapes::ShapeRef.new(shape: DashboardInvalidInputError)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceFault)
+      end)
+
       api.add_operation(:put_metric_alarm, Seahorse::Model::Operation.new.tap do |o|
         o.name = "PutMetricAlarm"
         o.http_method = "POST"

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

@@ -105,22 +105,22 @@ module Aws::CloudWatch
     # @option options [Array<Types::Dimension>] :dimensions
     #   The dimensions. If the metric contains multiple dimensions, you must
     #   include a value for each dimension. CloudWatch treats each unique
-    #   combination of dimensions as a separate metric. You can't retrieve
-    #   statistics using combinations of dimensions that were not specially
-    #   published. You must specify the same dimensions that were used when
-    #   the metrics were created. For an example, see [Dimension
+    #   combination of dimensions as a separate metric. If a specific
+    #   combination of dimensions was not published, you can't retrieve
+    #   statistics for it. You must specify the same dimensions that were used
+    #   when the metrics were created. For an example, see [Dimension
     #   Combinations][1] in the *Amazon CloudWatch User Guide*. For more
-    #   information on specifying dimensions, see [Publishing Metrics][2] in
-    #   the *Amazon CloudWatch User Guide*.
+    #   information about specifying dimensions, see [Publishing Metrics][2]
+    #   in the *Amazon CloudWatch User Guide*.
     #
     #
     #
     #   [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations
     #   [2]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html
     # @option options [required, Time,DateTime,Date,Integer,String] :start_time
-    #   The time stamp that determines the first data point to return. Note
-    #   that start times are evaluated relative to the time that CloudWatch
-    #   receives the request.
+    #   The time stamp that determines the first data point to return. Start
+    #   times are evaluated relative to the time that CloudWatch receives the
+    #   request.
     #
     #   The value specified is inclusive; results include data points with the
     #   specified time stamp. The time stamp must be in ISO 8601 UTC format
@@ -141,13 +141,12 @@ module Aws::CloudWatch
     # @option options [required, Time,DateTime,Date,Integer,String] :end_time
     #   The time stamp that determines the last data point to return.
     #
-    #   The value specified is exclusive; results will include data points up
-    #   to the specified time stamp. The time stamp must be in ISO 8601 UTC
+    #   The value specified is exclusive; results include data points up to
+    #   the specified time stamp. The time stamp must be in ISO 8601 UTC
     #   format (for example, 2016-10-10T23:00:00Z).
     # @option options [required, Integer] :period
     #   The granularity, in seconds, of the returned data points. A period can
     #   be as short as one minute (60 seconds) and must be a multiple of 60.
-    #   The default value is 60.
     #
     #   If the `StartTime` parameter specifies a time stamp that is greater
     #   than 15 days ago, you must specify the period as follows or no data
@@ -160,9 +159,13 @@ module Aws::CloudWatch
     #     (1 hour).
     # @option options [Array<String>] :statistics
     #   The metric statistics, other than percentile. For percentile
-    #   statistics, use `ExtendedStatistic`.
+    #   statistics, use `ExtendedStatistics`. When calling
+    #   `GetMetricStatistics`, you must specify either `Statistics` or
+    #   `ExtendedStatistics`, but not both.
     # @option options [Array<String>] :extended_statistics
-    #   The percentile statistics. Specify values between p0.0 and p100.
+    #   The percentile statistics. Specify values between p0.0 and p100. When
+    #   calling `GetMetricStatistics`, you must specify either `Statistics` or
+    #   `ExtendedStatistics`, but not both.
     # @option options [String] :unit
     #   The unit for a given metric. Metrics may be reported in multiple
     #   units. Not supplying a unit results in all units being returned. If
@@ -267,6 +270,9 @@ module Aws::CloudWatch
     #   The dimensions for the metric associated with the alarm.
     # @option options [required, Integer] :period
     #   The period, in seconds, over which the specified statistic is applied.
+    #   An alarm's total current evaluation period can be no longer than one
+    #   day, so this number multiplied by `EvaluationPeriods` must be 86,400
+    #   or less.
     # @option options [String] :unit
     #   The unit of measure for the statistic. For example, the units for the
     #   Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the
@@ -276,11 +282,13 @@ module Aws::CloudWatch
     #   specify a unit of measure, such as Percent, are aggregated separately.
     #
     #   If you specify a unit, you must use a unit that is appropriate for the
-    #   metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the
+    #   metric. Otherwise, the CloudWatch alarm can get stuck in the
     #   `INSUFFICIENT DATA` state.
     # @option options [required, Integer] :evaluation_periods
     #   The number of periods over which data is compared to the specified
-    #   threshold.
+    #   threshold. An alarm's total current evaluation period can be no
+    #   longer than one day, so this number multiplied by `Period` must be
+    #   86,400 or less.
     # @option options [required, Float] :threshold
     #   The value against which the specified statistic is compared.
     # @option options [required, String] :comparison_operator
@@ -300,10 +308,10 @@ module Aws::CloudWatch
     #   [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
     # @option options [String] :evaluate_low_sample_count_percentile
     #   Used only for alarms based on percentiles. If you specify `ignore`,
-    #   the alarm state will not change during periods with too few data
+    #   the alarm state does not change during periods with too few data
     #   points to be statistically significant. If you specify `evaluate` or
-    #   omit this parameter, the alarm will always be evaluated and possibly
-    #   change state no matter how many data points are available. For more
+    #   omit this parameter, the alarm is always evaluated and possibly
+    #   changes state no matter how many data points are available. For more
     #   information, see [Percentile-Based CloudWatch Alarms and Low Data
     #   Samples][1].
     #
@@ -346,6 +354,7 @@ module Aws::CloudWatch
     #           maximum: 1.0, # required
     #         },
     #         unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #         storage_resolution: 1,
     #       },
     #     ],
     #   })

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

@@ -42,8 +42,8 @@ module Aws::CloudWatch
     # @option options [Array<String>] :alarm_names
     #   The names of the alarms.
     # @option options [String] :alarm_name_prefix
-    #   The alarm name prefix. You cannot specify `AlarmNames` if this
-    #   parameter is specified.
+    #   The alarm name prefix. If this parameter is specified, you cannot
+    #   specify `AlarmNames`.
     # @option options [String] :state_value
     #   The state value to be used in matching alarms.
     # @option options [String] :action_prefix

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

@@ -41,8 +41,56 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
-    # Encapsulates the statistical data that Amazon CloudWatch computes from
-    # metric data.
+    # Represents a specific dashboard.
+    #
+    # @!attribute [rw] dashboard_name
+    #   The name of the dashboard.
+    #   @return [String]
+    #
+    # @!attribute [rw] dashboard_arn
+    #   The Amazon Resource Name (ARN) of the dashboard.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_modified
+    #   The time stamp of when the dashboard was last modified, either by an
+    #   API call or through the console. This number is expressed as the
+    #   number of milliseconds since Jan 1, 1970 00:00:00 UTC.
+    #   @return [Time]
+    #
+    # @!attribute [rw] size
+    #   The size of the dashboard, in bytes.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DashboardEntry AWS API Documentation
+    #
+    class DashboardEntry < Struct.new(
+      :dashboard_name,
+      :dashboard_arn,
+      :last_modified,
+      :size)
+      include Aws::Structure
+    end
+
+    # An error or warning for the operation.
+    #
+    # @!attribute [rw] data_path
+    #   The data path related to the message.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   A message describing the error or warning.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DashboardValidationMessage AWS API Documentation
+    #
+    class DashboardValidationMessage < Struct.new(
+      :data_path,
+      :message)
+      include Aws::Structure
+    end
+
+    # Encapsulates the statistical data that CloudWatch computes from metric
+    # data.
     #
     # @!attribute [rw] timestamp
     #   The time stamp used for the data point.
@@ -109,6 +157,28 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteDashboardsInput
+    #   data as a hash:
+    #
+    #       {
+    #         dashboard_names: ["DashboardName"],
+    #       }
+    #
+    # @!attribute [rw] dashboard_names
+    #   The dashboards to be deleted.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboardsInput AWS API Documentation
+    #
+    class DeleteDashboardsInput < Struct.new(
+      :dashboard_names)
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboardsOutput AWS API Documentation
+    #
+    class DeleteDashboardsOutput < Aws::EmptyStructure; end
+
     # @note When making an API call, you may pass DescribeAlarmHistoryInput
     #   data as a hash:
     #
@@ -266,8 +336,8 @@ module Aws::CloudWatch
     #   @return [Array<String>]
     #
     # @!attribute [rw] alarm_name_prefix
-    #   The alarm name prefix. You cannot specify `AlarmNames` if this
-    #   parameter is specified.
+    #   The alarm name prefix. If this parameter is specified, you cannot
+    #   specify `AlarmNames`.
     #   @return [String]
     #
     # @!attribute [rw] state_value
@@ -404,6 +474,48 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetDashboardInput
+    #   data as a hash:
+    #
+    #       {
+    #         dashboard_name: "DashboardName",
+    #       }
+    #
+    # @!attribute [rw] dashboard_name
+    #   The name of the dashboard to be described.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboardInput AWS API Documentation
+    #
+    class GetDashboardInput < Struct.new(
+      :dashboard_name)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dashboard_arn
+    #   The Amazon Resource Name (ARN) of the dashboard.
+    #   @return [String]
+    #
+    # @!attribute [rw] dashboard_body
+    #   The detailed information about the dashboard, including what widgets
+    #   are included and their location on the dashboard. For more
+    #   information about the `DashboardBody` syntax, see
+    #   CloudWatch-Dashboard-Body-Structure.
+    #   @return [String]
+    #
+    # @!attribute [rw] dashboard_name
+    #   The name of the dashboard.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboardOutput AWS API Documentation
+    #
+    class GetDashboardOutput < Struct.new(
+      :dashboard_arn,
+      :dashboard_body,
+      :dashboard_name)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetMetricStatisticsInput
     #   data as a hash:
     #
@@ -435,13 +547,13 @@ module Aws::CloudWatch
     # @!attribute [rw] dimensions
     #   The dimensions. If the metric contains multiple dimensions, you must
     #   include a value for each dimension. CloudWatch treats each unique
-    #   combination of dimensions as a separate metric. You can't retrieve
-    #   statistics using combinations of dimensions that were not specially
-    #   published. You must specify the same dimensions that were used when
-    #   the metrics were created. For an example, see [Dimension
+    #   combination of dimensions as a separate metric. If a specific
+    #   combination of dimensions was not published, you can't retrieve
+    #   statistics for it. You must specify the same dimensions that were
+    #   used when the metrics were created. For an example, see [Dimension
     #   Combinations][1] in the *Amazon CloudWatch User Guide*. For more
-    #   information on specifying dimensions, see [Publishing Metrics][2] in
-    #   the *Amazon CloudWatch User Guide*.
+    #   information about specifying dimensions, see [Publishing Metrics][2]
+    #   in the *Amazon CloudWatch User Guide*.
     #
     #
     #
@@ -450,9 +562,9 @@ module Aws::CloudWatch
     #   @return [Array<Types::Dimension>]
     #
     # @!attribute [rw] start_time
-    #   The time stamp that determines the first data point to return. Note
-    #   that start times are evaluated relative to the time that CloudWatch
-    #   receives the request.
+    #   The time stamp that determines the first data point to return. Start
+    #   times are evaluated relative to the time that CloudWatch receives
+    #   the request.
     #
     #   The value specified is inclusive; results include data points with
     #   the specified time stamp. The time stamp must be in ISO 8601 UTC
@@ -475,15 +587,15 @@ module Aws::CloudWatch
     # @!attribute [rw] end_time
     #   The time stamp that determines the last data point to return.
     #
-    #   The value specified is exclusive; results will include data points
-    #   up to the specified time stamp. The time stamp must be in ISO 8601
-    #   UTC format (for example, 2016-10-10T23:00:00Z).
+    #   The value specified is exclusive; results include data points up to
+    #   the specified time stamp. The time stamp must be in ISO 8601 UTC
+    #   format (for example, 2016-10-10T23:00:00Z).
     #   @return [Time]
     #
     # @!attribute [rw] period
     #   The granularity, in seconds, of the returned data points. A period
     #   can be as short as one minute (60 seconds) and must be a multiple of
-    #   60. The default value is 60.
+    #   60.
     #
     #   If the `StartTime` parameter specifies a time stamp that is greater
     #   than 15 days ago, you must specify the period as follows or no data
@@ -498,11 +610,15 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] statistics
     #   The metric statistics, other than percentile. For percentile
-    #   statistics, use `ExtendedStatistic`.
+    #   statistics, use `ExtendedStatistics`. When calling
+    #   `GetMetricStatistics`, you must specify either `Statistics` or
+    #   `ExtendedStatistics`, but not both.
     #   @return [Array<String>]
     #
     # @!attribute [rw] extended_statistics
     #   The percentile statistics. Specify values between p0.0 and p100.
+    #   When calling `GetMetricStatistics`, you must specify either
+    #   `Statistics` or `ExtendedStatistics`, but not both.
     #   @return [Array<String>]
     #
     # @!attribute [rw] unit
@@ -543,6 +659,51 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListDashboardsInput
+    #   data as a hash:
+    #
+    #       {
+    #         dashboard_name_prefix: "DashboardNamePrefix",
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] dashboard_name_prefix
+    #   If you specify this parameter, only the dashboards with names
+    #   starting with the specified string are listed. The maximum length is
+    #   255, and valid characters are A-Z, a-z, 0-9, ".", "-", and
+    #   "\_".
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   The token returned by a previous call to indicate that there is more
+    #   data available.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboardsInput AWS API Documentation
+    #
+    class ListDashboardsInput < Struct.new(
+      :dashboard_name_prefix,
+      :next_token)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dashboard_entries
+    #   The list of matching dashboards.
+    #   @return [Array<Types::DashboardEntry>]
+    #
+    # @!attribute [rw] next_token
+    #   The token that marks the start of the next batch of returned
+    #   results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboardsOutput AWS API Documentation
+    #
+    class ListDashboardsOutput < Struct.new(
+      :dashboard_entries,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListMetricsInput
     #   data as a hash:
     #
@@ -728,9 +889,16 @@ module Aws::CloudWatch
     #   @return [String]
     #
     # @!attribute [rw] treat_missing_data
+    #   Sets how this alarm is to handle missing data points. If this
+    #   parameter is omitted, the default behavior of `missing` is used.
     #   @return [String]
     #
     # @!attribute [rw] evaluate_low_sample_count_percentile
+    #   Used only for alarms based on percentiles. If `ignore`, the alarm
+    #   state does not change during periods with too few data points to be
+    #   statistically significant. If `evaluate` or this parameter is not
+    #   used, the alarm will always be evaluated and possibly change state
+    #   no matter how many data points are available.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm AWS API Documentation
@@ -786,6 +954,7 @@ module Aws::CloudWatch
     #           maximum: 1.0, # required
     #         },
     #         unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #         storage_resolution: 1,
     #       }
     #
     # @!attribute [rw] metric_name
@@ -804,11 +973,11 @@ module Aws::CloudWatch
     # @!attribute [rw] value
     #   The value for the metric.
     #
-    #   Although the parameter accepts numbers of type Double, Amazon
-    #   CloudWatch rejects values that are either too small or too large.
-    #   Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base
-    #   10) or 2e-360 to 2e360 (Base 2). In addition, special values (for
-    #   example, NaN, +Infinity, -Infinity) are not supported.
+    #   Although the parameter accepts numbers of type Double, CloudWatch
+    #   rejects values that are either too small or too large. Values must
+    #   be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or
+    #   2e-360 to 2e360 (Base 2). In addition, special values (for example,
+    #   NaN, +Infinity, -Infinity) are not supported.
     #   @return [Float]
     #
     # @!attribute [rw] statistic_values
@@ -819,6 +988,9 @@ module Aws::CloudWatch
     #   The unit of the metric.
     #   @return [String]
     #
+    # @!attribute [rw] storage_resolution
+    #   @return [Integer]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDatum AWS API Documentation
     #
     class MetricDatum < Struct.new(
@@ -827,7 +999,60 @@ module Aws::CloudWatch
       :timestamp,
       :value,
       :statistic_values,
-      :unit)
+      :unit,
+      :storage_resolution)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass PutDashboardInput
+    #   data as a hash:
+    #
+    #       {
+    #         dashboard_name: "DashboardName",
+    #         dashboard_body: "DashboardBody",
+    #       }
+    #
+    # @!attribute [rw] dashboard_name
+    #   The name of the dashboard. If a dashboard with this name already
+    #   exists, this call modifies that dashboard, replacing its current
+    #   contents. Otherwise, a new dashboard is created. The maximum length
+    #   is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and
+    #   "\_".
+    #   @return [String]
+    #
+    # @!attribute [rw] dashboard_body
+    #   The detailed information about the dashboard in JSON format,
+    #   including the widgets to include and their location on the
+    #   dashboard.
+    #
+    #   For more information about the syntax, see
+    #   CloudWatch-Dashboard-Body-Structure.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboardInput AWS API Documentation
+    #
+    class PutDashboardInput < Struct.new(
+      :dashboard_name,
+      :dashboard_body)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dashboard_validation_messages
+    #   If the input for `PutDashboard` was correct and the dashboard was
+    #   successfully created or modified, this result is empty.
+    #
+    #   If this result includes only warning messages, then the input was
+    #   valid enough for the dashboard to be created or modified, but some
+    #   elements of the dashboard may not render.
+    #
+    #   If this result includes error messages, the input was not valid and
+    #   the operation failed.
+    #   @return [Array<Types::DashboardValidationMessage>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboardOutput AWS API Documentation
+    #
+    class PutDashboardOutput < Struct.new(
+      :dashboard_validation_messages)
       include Aws::Structure
     end
 
@@ -949,7 +1174,9 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] period
     #   The period, in seconds, over which the specified statistic is
-    #   applied.
+    #   applied. An alarm's total current evaluation period can be no
+    #   longer than one day, so this number multiplied by
+    #   `EvaluationPeriods` must be 86,400 or less.
     #   @return [Integer]
     #
     # @!attribute [rw] unit
@@ -962,13 +1189,15 @@ module Aws::CloudWatch
     #   aggregated separately.
     #
     #   If you specify a unit, you must use a unit that is appropriate for
-    #   the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in
-    #   the `INSUFFICIENT DATA` state.
+    #   the metric. Otherwise, the CloudWatch alarm can get stuck in the
+    #   `INSUFFICIENT DATA` state.
     #   @return [String]
     #
     # @!attribute [rw] evaluation_periods
     #   The number of periods over which data is compared to the specified
-    #   threshold.
+    #   threshold. An alarm's total current evaluation period can be no
+    #   longer than one day, so this number multiplied by `Period` must be
+    #   86,400 or less.
     #   @return [Integer]
     #
     # @!attribute [rw] threshold
@@ -996,10 +1225,10 @@ module Aws::CloudWatch
     #
     # @!attribute [rw] evaluate_low_sample_count_percentile
     #   Used only for alarms based on percentiles. If you specify `ignore`,
-    #   the alarm state will not change during periods with too few data
+    #   the alarm state does not change during periods with too few data
     #   points to be statistically significant. If you specify `evaluate` or
-    #   omit this parameter, the alarm will always be evaluated and possibly
-    #   change state no matter how many data points are available. For more
+    #   omit this parameter, the alarm is always evaluated and possibly
+    #   changes state no matter how many data points are available. For more
     #   information, see [Percentile-Based CloudWatch Alarms and Low Data
     #   Samples][1].
     #
@@ -1057,6 +1286,7 @@ module Aws::CloudWatch
     #               maximum: 1.0, # required
     #             },
     #             unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
+    #             storage_resolution: 1,
     #           },
     #         ],
     #       }