EKS / Client / create_eks_anywhere_subscription

create_eks_anywhere_subscription

EKS.Client.create_eks_anywhere_subscription(**kwargs)

Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.

See also: AWS API Documentation

Request Syntax

response = client.create_eks_anywhere_subscription(
    name='string',
    term={
        'duration': 123,
        'unit': 'MONTHS'
    },
    licenseQuantity=123,
    licenseType='Cluster',
    autoRenew=True|False,
    clientRequestToken='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  The unique name for your subscription. It must be unique in your Amazon Web Services account in the Amazon Web Services Region you’re creating the subscription in. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic character and can’t be longer than 100 characters.

• term (dict) –

  [REQUIRED]

  An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This value cannot be changed after creating the subscription.

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

• licenseQuantity (integer) – The number of licenses to purchase with the subscription. Valid values are between 1 and 100. This value can’t be changed after creating the subscription.

• licenseType (string) – The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

• autoRenew (boolean) – A boolean indicating whether the subscription auto renews at the end of the term.

• clientRequestToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• 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 don’t 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).

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',
        ],
        '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) –

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

• EKS.Client.exceptions.InvalidParameterException

• EKS.Client.exceptions.ClientException

• EKS.Client.exceptions.ServerException

• EKS.Client.exceptions.ServiceUnavailableException