Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeInsightsRefresh

Returns the status of the latest on-demand cluster insights refresh operation.

Request Syntax


GET /clusters/name/insights-refresh HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the cluster associated with the insights refresh operation.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "endedAt": number,
   "message": "string",
   "startedAt": number,
   "status": "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.

endedAt

The date and time when the insights refresh operation ended.

Type: Timestamp

message

The message associated with the insights refresh operation.

Type: String

startedAt

The date and time when the insights refresh operation started.

Type: Timestamp

status

The current status of the insights refresh operation.

Type: String

Valid Values: IN_PROGRESS | FAILED | COMPLETED

Errors

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

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

addonName: The specified parameter for the add-on name is invalid. Review the available parameters for the API request
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The specified parameter is invalid. Review the available parameters for the API request.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

addonName: The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations.
clusterName: The Amazon EKS cluster associated with the exception.
message: The Amazon EKS add-on name associated with the exception.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are AWS Region specific.

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The Amazon EKS message associated with the exception.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 404

ServerException

These errors are usually caused by a server-side issue.

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
message: These errors are usually caused by a server-side issue.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 500

Examples

Example of refresh in progress

The following example shows when the cluster insights refresh workflow is in progress.

Sample Request


GET /clusters/name/insights-refresh HTTP/1.1

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "message": "Cluster insights refresh is in progress.",
    "status": "IN_PROGRESS",
    "startedAt": "2025-08-19T13:45:11-07:00"
}

Example of refresh completion

The following example shows when the cluster insights refresh workflow completed successfully.

Sample Request


GET /clusters/name/insights-refresh HTTP/1.1

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "message": "Cluster insights refresh has completed successfully.",
    "status": "COMPLETED",
    "startedAt": "2025-08-19T13:45:11-07:00",
    "endedAt": "2025-08-19T13:45:50-07:00"
}

Example of refresh error

The following example shows when the cluster insights refresh workflow encountered an error.

Sample Request


GET /clusters/name/insights-refresh HTTP/1.1

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "message": "The latest cluster insights refresh encountered an error. Try StartInsightsRefresh again.",
    "status": "FAILED",
    "startedAt": "2025-08-19T13:45:11-07:00",
    "endedAt": "2025-08-19T13:45:50-07:00"
}