EKS / Client / describe_eks_anywhere_subscription

describe_eks_anywhere_subscription

EKS.Client.describe_eks_anywhere_subscription(**kwargs)

Returns descriptive information about a subscription.

See also: AWS API Documentation

Request Syntax

response = client.describe_eks_anywhere_subscription(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The ID of the subscription.

Return type:

dict

Returns:

Response Syntax

{
    'subscription': {
        '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',
        ],
        'licenses': [
            {
                'id': 'string',
                'token': 'string'
            },
        ],
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • subscription (dict) –

    The full description of the subscription.

    • 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) –

    • licenses (list) –

      Includes all of the claims in the license token necessary to validate the license for extended support.

      • (dict) –

        An EKS Anywhere license associated with a subscription.

        • id (string) –

          An id associated with an EKS Anywhere subscription license.

        • token (string) –

          An optional license token that can be used for extended support verification.

    • 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).

Exceptions

• EKS.Client.exceptions.ResourceNotFoundException

• EKS.Client.exceptions.ClientException

• EKS.Client.exceptions.ServerException

• EKS.Client.exceptions.ServiceUnavailableException