DescribeInsight
Returns details about an insight that you specify using its ID.
Request Syntax
GET /clusters/name
/insights/id
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"insight": {
"additionalInfo": {
"string" : "string"
},
"category": "string",
"categorySpecificSummary": {
"addonCompatibilityDetails": [
{
"compatibleVersions": [ "string" ],
"name": "string"
}
],
"deprecationDetails": [
{
"clientStats": [
{
"lastRequestTime": number,
"numberOfRequestsLast30Days": number,
"userAgent": "string"
}
],
"replacedWith": "string",
"startServingReplacementVersion": "string",
"stopServingVersion": "string",
"usage": "string"
}
]
},
"description": "string",
"id": "string",
"insightStatus": {
"reason": "string",
"status": "string"
},
"kubernetesVersion": "string",
"lastRefreshTime": number,
"lastTransitionTime": number,
"name": "string",
"recommendation": "string",
"resources": [
{
"arn": "string",
"insightStatus": {
"reason": "string",
"status": "string"
},
"kubernetesResourceUri": "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.
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 withListNodegroups
. 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: