AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::CloudWatch::Types::DescribeAnomalyDetectorsInput

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

Overview

Note:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsArray<Types::Dimension>

Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.

Returns:



860
861
862
863
864
865
866
867
868
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 860

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

#max_resultsInteger

The maximum number of results to return in one operation. The maximum value that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

  • (Integer)


860
861
862
863
864
865
866
867
868
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 860

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

#metric_nameString

Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.

Returns:

  • (String)


860
861
862
863
864
865
866
867
868
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 860

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

#namespaceString

Limits the results to only the anomaly detection models that are associated with the specified namespace.

Returns:

  • (String)


860
861
862
863
864
865
866
867
868
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 860

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

#next_tokenString

Use the token returned by the previous operation to request the next page of results.

Returns:

  • (String)


860
861
862
863
864
865
866
867
868
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 860

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