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

ListEksAnywhereSubscriptions

Displays the full description of the subscription.

Request Syntax


GET /eks-anywhere-subscriptions?includeStatus=includeStatus&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

includeStatus

An array of subscription statuses to filter on.

maxResults

The maximum number of cluster results returned by ListEksAnywhereSubscriptions in paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListEksAnywhereSubscriptions request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The nextToken value returned from a previous paginated ListEksAnywhereSubscriptions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "subscriptions": [ 
      { 
         "arn": "string",
         "autoRenew": boolean,
         "createdAt": number,
         "effectiveDate": number,
         "expirationDate": number,
         "id": "string",
         "licenseArns": [ "string" ],
         "licenseQuantity": number,
         "licenses": [ 
            { 
               "id": "string",
               "token": "string"
            }
         ],
         "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.

nextToken

The nextToken value to include in a future ListEksAnywhereSubscriptions request. When the results of a ListEksAnywhereSubscriptions request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

subscriptions

A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults.

Type: Array of EksAnywhereSubscription objects

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.

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 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.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

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

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

ServiceUnavailableException

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

message: The request has failed due to a temporary failure of the server.

HTTP Status Code: 503