Amazon EKS Eks Updates API

openapi: 3.1.0
info:
  title: Amazon Elastic Kubernetes Service Updates API
  version: '2017-11-01'
  description: Generated from AWS's published Smithy model for Amazon Elastic Kubernetes Service. 4 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:
  /clusters/{name}/updates/{updateId}:
    get:
      operationId: DescribeUpdate
      summary: Describe Update
      description: Describes an update to an Amazon EKS resource. When the status of the update is Successful, the update
        is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeUpdateResponse'
        '400':
          description: ClientException; InvalidParameterException
          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/DescribeUpdateRequest'
      tags:
      - Updates
  /clusters/{name}/updates:
    get:
      operationId: ListUpdates
      summary: List Updates
      description: Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified
        Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUpdatesResponse'
        '400':
          description: ClientException; InvalidParameterException
          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/ListUpdatesRequest'
      tags:
      - Updates
    post:
      operationId: UpdateClusterVersion
      summary: Update Cluster Version
      description: Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during
        the update. The response output includes an update ID that you can use to track the status of your cluster update
        with the DescribeUpdate API operation. Cluster updates are asynchronous, and they should finish within a few minutes.
        During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the
        update is complete (either Failed or Successful), the cluster status moves to Active. If your cluster has managed
        node groups attached to it, all of your node groups' Kubernetes versions must match the cluster's Kubernetes version
        in order to update the cluster to a new Kubernetes version.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateClusterVersionResponse'
        '400':
          description: ClientException; InvalidParameterException; InvalidRequestException; InvalidStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '409':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterVersionRequest'
      tags:
      - Updates
  /clusters/{clusterName}/addons/{addonName}/update:
    post:
      operationId: UpdateAddon
      summary: Update Addon
      description: Updates an Amazon EKS add-on.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAddonResponse'
        '400':
          description: ClientException; InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '409':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '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/UpdateAddonRequest'
      tags:
      - Updates
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:
    AddonPodIdentityAssociations:
      type: object
      properties:
        serviceAccount:
          type: string
          description: The name of a Kubernetes Service Account.
        roleArn:
          type: string
          description: The ARN of an IAM Role.
      required:
      - serviceAccount
      - roleArn
    Cancellation:
      type: object
      properties:
        status:
          type: string
          enum:
          - InProgress
          - Failed
          - Successful
          description: The current status of the cancellation. Valid values are InProgress, Failed, and Successful.
        reason:
          type: string
          description: A message providing additional details about the cancellation, such as the reason for the cancellation
            or failure details.
    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.
    DescribeUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Amazon EKS cluster associated with the update.
        updateId:
          type: string
          description: The ID of the update to describe.
        nodegroupName:
          type: string
          description: The name of the Amazon EKS node group associated with the update. This parameter is required if the
            update is a node group update.
        addonName:
          type: string
          description: The name of the add-on. The name must match one of the names returned by ListAddons . This parameter
            is required if the update is an add-on update.
        capabilityName:
          type: string
          description: The name of the capability for which you want to describe updates.
      required:
      - name
      - updateId
    DescribeUpdateResponse:
      type: object
      properties:
        update:
          $ref: '#/components/schemas/Update'
    ErrorDetail:
      type: object
      properties:
        errorCode:
          type: string
          enum:
          - SubnetNotFound
          - SecurityGroupNotFound
          - EniLimitReached
          - IpNotAvailable
          - AccessDenied
          - OperationNotPermitted
          - VpcIdNotFound
          - Unknown
          - NodeCreationFailure
          - PodEvictionFailure
          - InsufficientFreeAddresses
          - ClusterUnreachable
          - InsufficientNumberOfReplicas
          - ConfigurationConflict
          - AdmissionRequestDenied
          - UnsupportedAddonModification
          - K8sResourceNotFound
          description: 'A brief description of the error. SubnetNotFound: We couldn''t find one of the subnets associated
            with the cluster. SecurityGroupNotFound: We couldn''t find one of the security groups associated with the cluster.
            EniLimitReached: You have reached the elastic network interface limit for your account. IpNotAvailable: A subnet
            associated with the cluster doesn''t have any available IP addresses. AccessDenied: You don''t have permissions
            to perform the specified operation. OperationNotPermitted: The service role associated with the cluster doesn''t
            have the required access permissions for Amazon EKS. V'
        errorMessage:
          type: string
          description: A more complete description of the error.
        resourceIds:
          type: array
          items:
            type: string
          description: An optional field that contains the resource IDs associated with the error.
    ListUpdatesRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Amazon EKS cluster to list updates for.
        nodegroupName:
          type: string
          description: The name of the Amazon EKS managed node group to list updates for.
        addonName:
          type: string
          description: The names of the installed add-ons that have available updates.
        capabilityName:
          type: string
          description: The name of the capability for which you want to list updates.
        nextToken:
          type: string
          description: The nextToken value returned from a previous paginated 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. This value is null when there are no more results to return. This token should be treated
            as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic
            purposes.
        maxResults:
          type: integer
          description: The maximum number of results, returned in paginated output. You receive maxResults in a single page,
            along with a nextToken response element. You can see the remaining results of the initial request by sending another
            request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter,
            100 results and a nextToken value, if applicable, are returned.
      required:
      - name
    ListUpdatesResponse:
      type: object
      properties:
        updateIds:
          type: array
          items:
            type: string
          description: A list of all the updates for the specified cluster and Region.
        nextToken:
          type: string
          description: The nextToken value returned from a previous paginated 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. This value is null when there are no more results to return. This token should be treated
            as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic
            purposes.
    ResourceInUseException:
      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 specified add-on name is in use.
        message:
          type: string
          description: The Amazon EKS message associated with the exception.
    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.
    RollbackConfig:
      type: object
      properties:
        timeoutMinutes:
          type: integer
          description: 'The length of time in minutes to wait before cancelling the update. Timeout is a minimum-bound property,
            meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. This value can
            be between 120 (2 hours) and 10080 (7 days). Default: 720 (12 hours) if not specified.'
    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.
    ThrottlingException:
      type: object
      properties:
        clusterName:
          type: string
          description: The Amazon EKS cluster associated with the exception.
        message:
          type: string
    Update:
      type: object
      properties:
        id:
          type: string
          description: A UUID that is used to track the update.
        status:
          type: string
          enum:
          - InProgress
          - Failed
          - Cancelled
          - Successful
          description: The current status of the update.
        type:
          type: string
          enum:
          - VersionUpdate
          - EndpointAccessUpdate
          - LoggingUpdate
          - ConfigUpdate
          - AssociateIdentityProviderConfig
          - DisassociateIdentityProviderConfig
          - AssociateEncryptionConfig
          - AddonUpdate
          - VpcConfigUpdate
          - AccessConfigUpdate
          - UpgradePolicyUpdate
          - ZonalShiftConfigUpdate
          - AutoModeUpdate
          - RemoteNetworkConfigUpdate
          - DeletionProtectionUpdate
          - CapabilityUpdate
          - ControlPlaneScalingConfigUpdate
          - VendedLogsUpdate
          - ControlPlaneEgressUpdate
          - VersionRollback
          - ControlPlaneComponentConfigUpdate
          - CertificateAuthorityUpdate
          description: The type of the update.
        params:
          type: array
          items:
            $ref: '#/components/schemas/UpdateParam'
          description: A key-value map that contains the parameters associated with the update.
        createdAt:
          type: string
          format: date-time
          description: The Unix epoch timestamp at object creation.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
          description: Any errors associated with a Failed update.
        cancellation:
          $ref: '#/components/schemas/Cancellation'
    UpdateAddonRequest:
      type: object
      properties:
        clusterName:
          type: string
          description: The name of your cluster.
        addonName:
          type: string
          description: The name of the add-on. The name must match one of the names returned by ListAddons .
        addonVersion:
          type: string
          description: The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions
            .
        serviceAccountRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The
            role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then
            the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role
            in the Amazon EKS User Guide. To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider
            created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in
            the Amazon EKS User Guide.
        resolveConflicts:
          type: string
          enum:
          - OVERWRITE
          - NONE
          - PRESERVE
          description: 'How to resolve field value conflicts for an Amazon EKS add-on if you''ve changed a value from the
            Amazon EKS default value. Conflicts are handled based on the option you choose: None – Amazon EKS doesn''t change
            the value. The update might fail. Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default
            value. Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field
            and value changes on a non-production cluster before updating the add-on on your production cluster.'
        clientRequestToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        configurationValues:
          type: string
          description: The set of configuration values for the add-on that's created. The values that you provide are validated
            against the schema returned by DescribeAddonConfiguration.
        podIdentityAssociations:
          type: array
          items:
            $ref: '#/components/schemas/AddonPodIdentityAssociations'
          description: An array of EKS Pod Identity associations to be updated. Each association maps a Kubernetes service
            account to an IAM role. If this value is left blank, no change. If an empty array is provided, existing associations
            owned by the add-on are deleted. For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS
            Pod Identity in the Amazon EKS User Guide.
      required:
      - clusterName
      - addonName
    UpdateAddonResponse:
      type: object
      properties:
        update:
          $ref: '#/components/schemas/Update'
    UpdateClusterVersionRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Amazon EKS cluster to update.
        version:
          type: string
          description: The desired Kubernetes version following a successful update.
        clientRequestToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        force:
          type: boolean
          description: Set this value to true to override upgrade-blocking or rollback-blocking readiness checks when updating
            a cluster.
        rollbackConfig:
          $ref: '#/components/schemas/RollbackConfig'
      required:
      - name
      - version
    UpdateClusterVersionResponse:
      type: object
      properties:
        update:
          $ref: '#/components/schemas/Update'
    UpdateParam:
      type: object
      properties:
        type:
          type: string
          enum:
          - Version
          - PlatformVersion
          - EndpointPrivateAccess
          - EndpointPublicAccess
          - ClusterLogging
          - DesiredSize
          - LabelsToAdd
          - LabelsToRemove
          - TaintsToAdd
          - TaintsToRemove
          - MaxSize
          - MinSize
          - ReleaseVersion
          - PublicAccessCidrs
          - LaunchTemplateName
          - LaunchTemplateVersion
          - IdentityProviderConfig
          - EncryptionConfig
          - AddonVersion
          - ServiceAccountRoleArn
          - ResolveConflicts
          - MaxUnavailable
          - MaxUnavailablePercentage
          - NodeRepairEnabled
          - UpdateStrategy
          - ConfigurationValues
          - SecurityGroups
          - Subnets
          - AuthenticationMode
          - PodIdentityAssociations
          - UpgradePolicy
          - ZonalShiftConfig
          - ComputeConfig
          - StorageConfig
          - KubernetesNetworkConfig
          - RemoteNetworkConfig
          - DeletionProtection
          - NodeRepairConfig
          - RoleArn
          - RoleMappingsToAddOrUpdate
          - RoleMappingsToRemove
          - NetworkAccess
          - VendedLogs
          - UpdatedTier
          - PreviousTier
          - EnableCrossNamespace
          - DisabledServices
          - WarmPoolEnabled
          - WarmPoolMaxGroupPreparedCapacity
          - WarmPoolMinSize
          - WarmPoolState
          - WarmPoolReuseOnScaleIn
          - ControlPlaneEgressMode
          - KubeApiServerConfig
          - KubeSchedulerConfig
          - KubeControllerManagerConfig
          - ActiveCertificateAuthority
          - TrustedCertificateAuthorities
          - CertificateAuthorityId
          - SigningStatus
          description: The keys associated with an update request.
        value:
          type: string
          description: The value of the keys submitted as part of an update request.
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)