EKS / Client / list_eks_anywhere_subscriptions
list_eks_anywhere_subscriptions#
- EKS.Client.list_eks_anywhere_subscriptions(**kwargs)#
Displays the full description of the subscription.
See also: AWS API Documentation
Request Syntax
response = client.list_eks_anywhere_subscriptions( maxResults=123, nextToken='string', includeStatus=[ 'CREATING'|'ACTIVE'|'UPDATING'|'EXPIRING'|'EXPIRED'|'DELETING', ] )
- Parameters:
maxResults (integer) – 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.
nextToken (string) – The
nextToken
value returned from a previous paginatedListEksAnywhereSubscriptions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.includeStatus (list) –
An array of subscription statuses to filter on.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'subscriptions': [ { 'id': 'string', 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'effectiveDate': datetime(2015, 1, 1), 'expirationDate': datetime(2015, 1, 1), 'licenseQuantity': 123, 'licenseType': 'Cluster', 'term': { 'duration': 123, 'unit': 'MONTHS' }, 'status': 'string', 'autoRenew': True|False, 'licenseArns': [ 'string', ], 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' }
Response Structure
(dict) –
subscriptions (list) –
A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults.
(dict) –
An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages.
id (string) –
UUID identifying a subscription.
arn (string) –
The Amazon Resource Name (ARN) for the subscription.
createdAt (datetime) –
The Unix timestamp in seconds for when the subscription was created.
effectiveDate (datetime) –
The Unix timestamp in seconds for when the subscription is effective.
expirationDate (datetime) –
The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.
licenseQuantity (integer) –
The number of licenses included in a subscription. Valid values are between 1 and 100.
licenseType (string) –
The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.
term (dict) –
An EksAnywhereSubscriptionTerm object.
duration (integer) –
The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.
unit (string) –
The term unit of the subscription. Valid value is
MONTHS
.
status (string) –
The status of a subscription.
autoRenew (boolean) –
A boolean indicating whether or not a subscription will auto renew when it expires.
licenseArns (list) –
Amazon Web Services License Manager ARN associated with the subscription.
(string) –
tags (dict) –
The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription.
(string) –
One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.(string) –
The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).
nextToken (string) –
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.
Exceptions