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

UpdateEksAnywhereSubscription

Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.

Request Syntax


POST /eks-anywhere-subscriptions/id HTTP/1.1
Content-type: application/json

{
   "autoRenew": boolean,
   "clientRequestToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the subscription.

Required: Yes

Request Body

The request accepts the following data in JSON format.

autoRenew

A boolean indicating whether or not to automatically renew the subscription.

Type: Boolean

Required: Yes

clientRequestToken

Unique, case-sensitive identifier to ensure the idempotency of the request.

Type: String

Required: No

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.

subscription

The full description of the updated subscription.

Type: EksAnywhereSubscription object

Errors

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

ClientException

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

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