ListSinks - Amazon CloudWatch Observability Access Manager

ListSinks

Use this operation in a monitoring account to return the list of sinks created in that account.

Request Syntax

POST /ListSinks HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

Limits the number of returned links to the specified number.

Type: Integer

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

Required: No

NextToken

The token for the next set of items to return. You received this token from a previous call.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Items": [ { "Arn": "string", "Id": "string", "Name": "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.

Items

An array of structures that contain the information about the returned sinks.

Type: Array of ListSinksItem objects

NextToken

The token to use when requesting the next set of sinks.

Type: String

Errors

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

InternalServiceFault

Unexpected error while processing the request. Retry the request.

HTTP Status Code: 500

InvalidParameterException

A parameter is specified incorrectly.

HTTP Status Code: 400

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

See Also

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