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

StartInsightsRefresh

Initiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

name

The name of the cluster for the refresh insights operation.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "message": "string",
   "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.

message

The message associated with the insights refresh operation.

Type: String

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.

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.

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.

HTTP Status Code: 404

ServerException

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

HTTP Status Code: 500

Examples

Example

The following example starts the cluster insights generation process.

Sample Request


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

Sample Response


HTTP/1.1 200
Content-type: application/json

{
    "message": "Initiated cluster insights refresh.",
    "status": "IN_PROGRESS"
}