DescribeEksAnywhereSubscription - Amazon EKS


Returns descriptive information about a subscription.

Request Syntax

GET /eks-anywhere-subscriptions/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID of the subscription.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "subscription": { "arn": "string", "autoRenew": boolean, "createdAt": number, "effectiveDate": number, "expirationDate": number, "id": "string", "licenseArns": [ "string" ], "licenseQuantity": number, "licenseType": "string", "status": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "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.


The full description of the subscription.

Type: EksAnywhereSubscription object


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


These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400


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


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

HTTP Status Code: 500


The service is unavailable. Back off and retry the operation.

HTTP Status Code: 503

See Also

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