Class: Aws::CloudWatch::Types::ListMetricsInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatch/types.rb

Overview

Note:

When making an API call, you may pass ListMetricsInput data as a hash:

{
  namespace: "Namespace",
  metric_name: "MetricName",
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue",
    },
  ],
  next_token: "NextToken",
  recently_active: "PT3H", # accepts PT3H
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsArray<Types::DimensionFilter>

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Returns:


2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'lib/aws-sdk-cloudwatch/types.rb', line 2242

class ListMetricsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :next_token,
  :recently_active)
  SENSITIVE = []
  include Aws::Structure
end

#metric_nameString

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Returns:

  • (String)

2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'lib/aws-sdk-cloudwatch/types.rb', line 2242

class ListMetricsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :next_token,
  :recently_active)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Returns:

  • (String)

2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'lib/aws-sdk-cloudwatch/types.rb', line 2242

class ListMetricsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :next_token,
  :recently_active)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token returned by a previous call to indicate that there is more data available.

Returns:

  • (String)

2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'lib/aws-sdk-cloudwatch/types.rb', line 2242

class ListMetricsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :next_token,
  :recently_active)
  SENSITIVE = []
  include Aws::Structure
end

#recently_activeString

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of `PT3H`. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you 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.

Returns:

  • (String)

2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'lib/aws-sdk-cloudwatch/types.rb', line 2242

class ListMetricsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :next_token,
  :recently_active)
  SENSITIVE = []
  include Aws::Structure
end