View a markdown version of this page

ListIntegrations - Amazon CloudWatch Omni

ListIntegrations

Lists the integrations in the account, optionally filtered by type, status, or name. Results are paginated.

Request Parameters

integrationType

Returns only integrations of this provider type.

Type: String

Valid Values: AWS_CONFIG_SLREC | SLACK | EXTERNAL_AGENT | AWS_INTEGRATION

Required: No

maxResults

Maximum number of integrations to return in one page.

Type: Integer

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

Required: No

name

Returns only the integration with this exact name.

Type: String

Required: No

nextToken

Pagination token from a previous response; omit for the first page.

Type: String

Required: No

status

Returns only integrations in this status.

Type: String

Valid Values: ACTIVE | DELETED | PENDING | PENDING_OAUTH | ERROR | FAILED

Required: No

Response Elements

The following elements are returned by the service.

items

The page of integrations.

Type: Array of Integration objects

nextToken

Pagination token for the next page; absent when there are no more results.

Type: String

Errors

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

AccessDeniedException

The caller is not authorized to perform this action.

HTTP Status Code: 403

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 integrations of a type

The following example lists up to 20 AWS_INTEGRATION integrations in the account. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "integrationType": "AWS_INTEGRATION", "maxResults": 20 }

Sample Response

{ "items": [ { "createdAt": "2026-09-16T00:03:00Z", "integrationArn": "arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d", "integrationId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d", "integrationType": "AWS_INTEGRATION", "name": "my-aws-integration", "status": "ACTIVE", "updatedAt": "2026-09-16T00:03:00Z" } ], "nextToken": "eyJvZmZzZXQiOjIwfQ==" }

See Also

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