View a markdown version of this page

ListMetricStreams - Amazon CloudWatch

ListMetricStreams

Returns a list of metric streams in this account.

Request Syntax

{ "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return in one operation.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Include this value, if it was returned by the previous call, to get the next set of metric streams.

Type: String

Required: No

Response Syntax

{ "Entries": [ { "Arn": "string", "CreationDate": number, "FirehoseArn": "string", "LastUpdateDate": number, "Name": "string", "OutputFormat": "string", "State": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entries

The array of metric stream information.

Type: Array of MetricStreamEntry objects

NextToken

The token that marks the start of the next batch of returned results. You can use this token in a subsequent operation to get the next batch of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServiceError

Request processing has failed due to some unknown error, exception, or failure.

Message

HTTP Status Code: 500

InvalidNextToken

The next token specified is invalid.

message

HTTP Status Code: 400

InvalidParameterValue

The value of an input parameter is bad or out-of-range.

message

HTTP Status Code: 400

MissingParameter

An input parameter that is required is missing.

message

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: