Packagecom.amazonaws.services.cloudwatch.model
Classpublic class ListMetricsRequest
InheritanceListMetricsRequest Inheritance AmazonWebServiceRequest Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : July 12. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

Container for the parameters to the com.amazonaws.services.cloudwatch.AmazonCloudWatchClient.listMetrics operation.

Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.

NOTE: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.

NOTE: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action.

See also

com.amazonaws.services.cloudwatch.AmazonCloudWatchClient.listMetrics()


Public Methods
 MethodDefined By
  
Default C'tor.
ListMetricsRequest
  
A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.
ListMetricsRequest
  
getMetricName():String
The name of the metric to filter against.
ListMetricsRequest
  
getNamespace():String
The namespace to filter against.
ListMetricsRequest
  
getNextToken():String
The token returned by a previous call to indicate that there is more data available.
ListMetricsRequest
  
setDimensions(dimensions:Array):void
A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.
ListMetricsRequest
  
setMetricName(metricName:String):void
The name of the metric to filter against.
ListMetricsRequest
  
setNamespace(namespace:String):void
The namespace to filter against.
ListMetricsRequest
  
setNextToken(nextToken:String):void
The token returned by a previous call to indicate that there is more data available.
ListMetricsRequest
  
toString():String
Returns a string representation of this object; useful for testing and debugging.
ListMetricsRequest
  
A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.
ListMetricsRequest
  
The name of the metric to filter against.
ListMetricsRequest
  
The namespace to filter against.
ListMetricsRequest
  
The token returned by a previous call to indicate that there is more data available.
ListMetricsRequest
Constructor Detail
ListMetricsRequest()Constructor
public function ListMetricsRequest()

Default C'tor.

Method Detail
getDimensions()method
public function getDimensions():Array

A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.

Length: 0 - 10

Returns
Array — A list of dimensions to filter against.

See also

getMetricName()method 
public function getMetricName():String

The name of the metric to filter against.

Length: 1 - 255

Returns
String — The name of the metric to filter against.
getNamespace()method 
public function getNamespace():String

The namespace to filter against.

Length: 1 - 255 Pattern: [^:].

Returns
String — The namespace to filter against.
getNextToken()method 
public function getNextToken():String

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

Returns
String — The token returned by a previous call to indicate that there is more data available.
setDimensions()method 
public function setDimensions(dimensions:Array):void

A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.

Length: 0 - 10

Parameters

dimensions:Array — A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.

See also

setMetricName()method 
public function setMetricName(metricName:String):void

The name of the metric to filter against.

Length: 1 - 255

Parameters

metricName:String — The name of the metric to filter against.

setNamespace()method 
public function setNamespace(namespace:String):void

The namespace to filter against.

Length: 1 - 255 Pattern: [^:].

Parameters

namespace:String — The namespace to filter against.

setNextToken()method 
public function setNextToken(nextToken:String):void

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

Parameters

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

toString()method 
public function toString():String

Returns a string representation of this object; useful for testing and debugging.

Returns
String — A string representation of this object.
withDimensions()method 
public function withDimensions(dimensions:Array):ListMetricsRequest

A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against. Returns a reference to this object so that method calls can be chained together.

Length: 0 - 10

Parameters

dimensions:Array — A list of dimensions (com.amazonaws.services.cloudwatch.model.DimensionFilter instances) to filter against.

Returns
ListMetricsRequest — A reference to this updated object so that method calls can be chained together.

See also

withMetricName()method 
public function withMetricName(metricName:String):ListMetricsRequest

The name of the metric to filter against. Returns a reference to this object so that method calls can be chained together.

Length: 1 - 255

Parameters

metricName:String — The name of the metric to filter against.

Returns
ListMetricsRequest — A reference to this updated object so that method calls can be chained together.
withNamespace()method 
public function withNamespace(namespace:String):ListMetricsRequest

The namespace to filter against. Returns a reference to this object so that method calls can be chained together.

Length: 1 - 255 Pattern: [^:].

Parameters

namespace:String — The namespace to filter against.

Returns
ListMetricsRequest — A reference to this updated object so that method calls can be chained together.
withNextToken()method 
public function withNextToken(nextToken:String):ListMetricsRequest

The token returned by a previous call to indicate that there is more data available. Returns a reference to this object so that method calls can be chained together.

Parameters

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

Returns
ListMetricsRequest — A reference to this updated object so that method calls can be chained together.