Amazon EKS Eks Eks Anywhere Subscriptions API

openapi: 3.1.0
info:
  title: Amazon Elastic Kubernetes Service Eks Anywhere Subscriptions API
  version: '2017-11-01'
  description: Generated from AWS's published Smithy model for Amazon Elastic Kubernetes Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://eks.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /eks-anywhere-subscriptions:
    post:
      operationId: CreateEksAnywhereSubscription
      summary: Create Eks Anywhere Subscription
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEksAnywhereSubscriptionResponse'
        '400':
          description: ClientException; InvalidParameterException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEksAnywhereSubscriptionRequest'
      tags:
      - Eks Anywhere Subscriptions
    get:
      operationId: ListEksAnywhereSubscriptions
      summary: List Eks Anywhere Subscriptions
      description: Displays the full description of the subscription.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEksAnywhereSubscriptionsResponse'
        '400':
          description: ClientException; InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEksAnywhereSubscriptionsRequest'
      tags:
      - Eks Anywhere Subscriptions
  /eks-anywhere-subscriptions/{id}:
    delete:
      operationId: DeleteEksAnywhereSubscription
      summary: Delete Eks Anywhere Subscription
      description: Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon
        Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within
        7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEksAnywhereSubscriptionResponse'
        '400':
          description: ClientException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEksAnywhereSubscriptionRequest'
      tags:
      - Eks Anywhere Subscriptions
    get:
      operationId: DescribeEksAnywhereSubscription
      summary: Describe Eks Anywhere Subscription
      description: Returns descriptive information about a subscription.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeEksAnywhereSubscriptionResponse'
        '400':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeEksAnywhereSubscriptionRequest'
      tags:
      - Eks Anywhere Subscriptions
    post:
      operationId: UpdateEksAnywhereSubscription
      summary: Update Eks Anywhere Subscription
      description: Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEksAnywhereSubscriptionResponse'
        '400':
          description: ClientException; InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEksAnywhereSubscriptionRequest'
      tags:
      - Eks Anywhere Subscriptions
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: eks
  schemas:
    ClientException:
      type: object
      properties:
        clusterName:
          type: string
          description: The Amazon EKS cluster associated with the exception.
        nodegroupName:
          type: string
          description: The Amazon EKS managed node group associated with the exception.
        addonName:
          type: string
          description: The Amazon EKS add-on name associated with the exception.
        subscriptionId:
          type: string
          description: The Amazon EKS subscription ID with the exception.
        message:
          type: string
          description: 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.
    CreateEksAnywhereSubscriptionRequest:
      type: object
      properties:
        name:
          type: string
          description: 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:
          $ref: '#/components/schemas/EksAnywhereSubscriptionTerm'
        licenseQuantity:
          type: integer
          description: 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:
          type: string
          enum:
          - Cluster
          description: 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:
          type: boolean
          description: A boolean indicating whether the subscription auto renews at the end of the term.
        clientRequestToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
      required:
      - name
      - term
    CreateEksAnywhereSubscriptionResponse:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/EksAnywhereSubscription'
    DeleteEksAnywhereSubscriptionRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the subscription.
      required:
      - id
    DeleteEksAnywhereSubscriptionResponse:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/EksAnywhereSubscription'
    DescribeEksAnywhereSubscriptionRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the subscription.
      required:
      - id
    DescribeEksAnywhereSubscriptionResponse:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/EksAnywhereSubscription'
    EksAnywhereSubscription:
      type: object
      properties:
        id:
          type: string
          description: UUID identifying a subscription.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) for the subscription.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp in seconds for when the subscription was created.
        effectiveDate:
          type: string
          format: date-time
          description: The Unix timestamp in seconds for when the subscription is effective.
        expirationDate:
          type: string
          format: date-time
          description: 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:
          type: integer
          description: The number of licenses included in a subscription. Valid values are between 1 and 100.
        licenseType:
          type: string
          enum:
          - Cluster
          description: 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:
          $ref: '#/components/schemas/EksAnywhereSubscriptionTerm'
        status:
          type: string
          description: The status of a subscription.
        autoRenew:
          type: boolean
          description: A boolean indicating whether or not a subscription will auto renew when it expires.
        licenseArns:
          type: array
          items:
            type: string
          description: Amazon Web Services License Manager ARN associated with the subscription.
        licenses:
          type: array
          items:
            $ref: '#/components/schemas/License'
          description: Includes all of the claims in the license token necessary to validate the license for extended support.
        tags:
          type: object
          additionalProperties:
            type: string
          description: 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.
    EksAnywhereSubscriptionTerm:
      type: object
      properties:
        duration:
          type: integer
          description: The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month
            subscription.
        unit:
          type: string
          enum:
          - MONTHS
          description: The term unit of the subscription. Valid value is MONTHS.
    License:
      type: object
      properties:
        id:
          type: string
          description: An id associated with an EKS Anywhere subscription license.
        token:
          type: string
          description: An optional license token that can be used for extended support verification.
    ListEksAnywhereSubscriptionsRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: 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:
          type: string
          description: 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.
        includeStatus:
          type: array
          items:
            type: string
            enum:
            - CREATING
            - ACTIVE
            - UPDATING
            - EXPIRING
            - EXPIRED
            - DELETING
          description: An array of subscription statuses to filter on.
    ListEksAnywhereSubscriptionsResponse:
      type: object
      properties:
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/EksAnywhereSubscription'
          description: A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken
            and maxResults.
        nextToken:
          type: string
          description: 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.
    ResourceNotFoundException:
      type: object
      properties:
        clusterName:
          type: string
          description: The Amazon EKS cluster associated with the exception.
        nodegroupName:
          type: string
          description: The Amazon EKS managed node group associated with the exception.
        fargateProfileName:
          type: string
          description: The Fargate profile associated with the exception.
        addonName:
          type: string
          description: The Amazon EKS add-on name associated with the exception.
        subscriptionId:
          type: string
          description: The Amazon EKS subscription ID with the exception.
        message:
          type: string
          description: The Amazon EKS message associated with the exception.
    ServerException:
      type: object
      properties:
        clusterName:
          type: string
          description: The Amazon EKS cluster associated with the exception.
        nodegroupName:
          type: string
          description: The Amazon EKS managed node group associated with the exception.
        addonName:
          type: string
          description: The Amazon EKS add-on name associated with the exception.
        subscriptionId:
          type: string
          description: The Amazon EKS subscription ID with the exception.
        message:
          type: string
          description: These errors are usually caused by a server-side issue.
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
          description: The request has failed due to a temporary failure of the server.
    UpdateEksAnywhereSubscriptionRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the subscription.
        autoRenew:
          type: boolean
          description: A boolean indicating whether or not to automatically renew the subscription.
        clientRequestToken:
          type: string
          description: Unique, case-sensitive identifier to ensure the idempotency of the request.
      required:
      - id
      - autoRenew
    UpdateEksAnywhereSubscriptionResponse:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/EksAnywhereSubscription'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/eks/service/2017-11-01/eks-2017-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)