View a markdown version of this page

ListViews - Amazon CloudWatch Omni

ListViews

Lists the views in the caller's account and region.

Returns a summary for each view, optionally filtered by view type. View definitions are not included — use GetView to retrieve them.

Request Parameters

maxResults

The maximum number of views to return per page.

Type: Integer

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

Required: No

nextToken

A token to retrieve the next page of results.

Type: String

Required: No

type

Return only views of this ownership category.

Type: String

Valid Values: USER | MANAGED

Required: No

Response Elements

The following elements are returned by the service.

items

The list of view summaries.

Type: Array of ViewSummary objects

nextToken

A token to retrieve the next page of results, or null if there are no more results.

Type: String

Errors

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

InternalServerException

An unexpected error occurred while processing the request.

errorCode

The error code associated with the internal error.

HTTP Status Code: 500

ThrottlingException

The request was throttled due to exceeding the allowed request rate.

retryAfterSeconds

The number of seconds to wait before retrying the request. Not always present.

HTTP Status Code: 429

ValidationException

A parameter is specified incorrectly.

errorCode

The error code associated with the validation failure.

HTTP Status Code: 400

Examples

List the views in an account and Region

The following example returns a page of view summaries, filtered to user-created views. Definitions are not included — call GetView to retrieve them. A nextToken is returned when more results are available. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "maxResults": 10, "type": "USER" }

Sample Response

{ "items": [ { "createdAt": "2026-09-16T14:22:31Z", "description": "Error counts by service", "name": "view.service_errors", "type": "USER", "updatedAt": "2026-09-16T14:22:31Z" } ], "nextToken": "eyJvZmZzZXQiOjEwfQ==" }

See Also

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