URI HTTP methods Schemas Properties See also

Clusters clusterArn Notifications

URI

/v1/clusters/clusterArn/notifications

HTTP methods

GET

Operation ID: ListClusterHealthAlertsResources

Returns information about all health alerts in a cluster.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The paginated results marker. When the result of the operation is truncated, the call returns `NextToken` in the response. To get the next batch, provide this token in your next request.
`maxResults`	String	False	The maximum number of results to return in the response (default maximum 100 results per API call). If there are more results, the response includes a `NextToken` parameter.

Responses
Status code	Response model	Description
`200`	`ListClusterHealthAlertsResponse`	Successful response.
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

OPTIONS

Enable CORS by returning correct headers.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

Schemas

Response bodies


{
  "clusterAlertsInfoList": [
    {
      "clusterAlerts": {
        "category": enum,
        "clusterComponent": [
          "string"
        ],
        "createdDate": "string",
        "name": enum
      },
      "clusterArn": "string",
      "customerActionStatus": enum
    }
  ],
  "nextToken": "string"
}


{
  "invalidParameter": "string",
  "message": "string"
}

Properties

ClusterAlerts

Cluster alert details for the cluster.

Property	Type	Required	Description
`category`	EventCategory	False	The category of the cluster alert.
`clusterComponent`	Array of type string	False	A list of brokers that have cluster alerts.
`createdDate`	string	False	The time at which the alert was created.
`name`	EventType	False	Name of the alert type.

ClusterAlertsInfo

The info and list of alerts for a cluster.

Property	Type	Required	Description
`clusterAlerts`	ClusterAlerts	False	The cluster alerts details for the cluster.
`clusterArn`	string	False	The Amazon Resource Name (ARN) of the cluster.
`customerActionStatus`	CustomerActionStatus	False	The type of action required in response to a cluster alert.

CustomerActionStatus

A type of an action required from the customer.

CRITICAL_ACTION_REQUIRED
ACTION_RECOMMENDED
NONE

Error

Returns information about an error.

Property	Type	Required	Description
`invalidParameter`	string	False	The parameter that caused the error.
`message`	string	False	The description of the error.

EventCategory

The category of the cluster alert.

ISSUE
NOTIFICATION
SCHEDULED_CHANGE

EventType

Name of the alert type.

DATA_DISK_OVERFLOW
DATA_DISK_USAGE_80
DATA_DISK_USAGE_60

ListClusterHealthAlertsResponse

The response contains an array containing cluster alerts information and a next token if the response is truncated.

Property	Type	Required	Description
`clusterAlertsInfoList`	Array of type ClusterAlertsInfo	False	A detailed list of cluster alerts for a cluster.
`nextToken`	string	False	If the response of ListClusterHealthAlerts is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterHealthAlerts.