Amazon Elastic Kubernetes Service
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on
Amazon Web Services without needing to setup or maintain your own Kubernetes control plane. Kubernetes is an
open-source system for automating the deployment, scaling, and management of
containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all
the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS
are fully compatible with applications running on any standard Kubernetes environment,
whether running in on-premises data centers or public clouds. This means that you can
easily migrate any standard Kubernetes application to Amazon EKS without any code modification
required.
Endpoints 70
- POSTActivate certificate authority
/clusters/:clusterName/certificate-authorities/:certificateAuthorityId/activateActivates a successor certificate authority (CA) as the signing certificate authority for your cluster, completing a CA rotation. When you activate a… - GETList associated access policies
/clusters/:clusterName/access-entries/:principalArn/access-policies?maxResults=0&nextToken=stringLists the access policies associated with an access entry. - POSTAssociate access policy
/clusters/:clusterName/access-entries/:principalArn/access-policiesAssociates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating… - POSTAssociate encryption config
/clusters/:clusterName/encryption-config/associateAssociates an encryption configuration to an existing cluster. Use this API to enable encryption on existing clusters that don't already have encryption… - POSTAssociate identity provider config
/clusters/:clusterName/identity-provider-configs/associateAssociates an identity provider configuration to a cluster. If you want to authenticate identities using an identity provider, you can create an identity… - POSTCancel update
/clusters/:name/updates/:updateId/cancel-updateCancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this… - GETList access entries
/clusters/:clusterName/access-entries?associatedPolicyArn=string&maxResults=0&nextToken=stringLists the access entries for your cluster. - POSTCreate access entry
/clusters/:clusterName/access-entriesCreates an access entry. An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the… - GETList addons
/clusters/:clusterName/addons?maxResults=0&nextToken=stringLists the installed add-ons. - POSTCreate addon
/clusters/:clusterName/addonsCreates an Amazon EKS add-on. Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS… - GETList capabilities
/clusters/:clusterName/capabilities?nextToken=string&maxResults=0Lists all managed capabilities in your Amazon EKS cluster. You can use this operation to get an overview of all capabilities and their current status. - POSTCreate capability
/clusters/:clusterName/capabilitiesCreates a managed capability resource for an Amazon EKS cluster. Capabilities provide fully managed capabilities to build and scale with Kubernetes. When you… - GETList certificate authorities
/clusters/:clusterName/certificate-authorities?maxResults=0&nextToken=stringLists the certificate authorities (CAs) for your cluster. A cluster has at most two certificate authorities: the outgoing CA that's currently signing and,… - POSTCreate certificate authority
/clusters/:clusterName/certificate-authoritiesAppends a successor certificate authority (CA) to your cluster, beginning the CA rotation process. A cluster certificate authority is the root of trust for… - GETList clusters
/clusters?maxResults=0&nextToken=string&include=Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region. - POSTCreate cluster
/clustersCreates an Amazon EKS control plane. The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the… - GETList eks anywhere subscriptions
/eks-anywhere-subscriptions?maxResults=0&nextToken=string&includeStatus=Displays the full description of the subscription. - POSTCreate eks anywhere subscription
/eks-anywhere-subscriptionsCreates 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… - GETList fargate profiles
/clusters/:clusterName/fargate-profiles?maxResults=0&nextToken=stringLists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. - POSTCreate fargate profile
/clusters/:clusterName/fargate-profilesCreates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate. The Fargate… - GETList nodegroups
/clusters/:clusterName/node-groups?maxResults=0&nextToken=stringLists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.… - POSTCreate nodegroup
/clusters/:clusterName/node-groupsCreates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for… - GETList pod identity associations
/clusters/:clusterName/pod-identity-associations?namespace=string&serviceAccount=string&maxResults=0&nextToken=stringList the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the… - POSTCreate pod identity association
/clusters/:clusterName/pod-identity-associationsCreates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity . Use EKS Pod Identity to… - GETDescribe access entry
/clusters/:clusterName/access-entries/:principalArnDescribes an access entry. - POSTUpdate access entry
/clusters/:clusterName/access-entries/:principalArnUpdates an access entry. - DELETEDelete access entry
/clusters/:clusterName/access-entries/:principalArnDeletes an access entry. Deleting an access entry of a type other than Standard can cause your cluster to function improperly. If you delete an access entry… - GETDescribe addon
/clusters/:clusterName/addons/:addonNameDescribes an Amazon EKS add-on. - DELETEDelete addon
/clusters/:clusterName/addons/:addonName?preserve=trueDeletes an Amazon EKS add-on. When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the… - GETDescribe capability
/clusters/:clusterName/capabilities/:capabilityNameReturns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information,… - POSTUpdate capability
/clusters/:clusterName/capabilities/:capabilityNameUpdates the configuration of a managed capability in your Amazon EKS cluster. You can update the IAM role, configuration settings, and delete propagation… - DELETEDelete capability
/clusters/:clusterName/capabilities/:capabilityNameDeletes a managed capability from your Amazon EKS cluster. When you delete a capability, Amazon EKS removes the capability infrastructure but retains all… - GETDescribe certificate authority
/clusters/:clusterName/certificate-authorities/:certificateAuthorityIdReturns detailed information about a certificate authority (CA) in your cluster, including its validity period, signing and distribution status, provenance,… - DELETEDelete certificate authority
/clusters/:clusterName/certificate-authorities/:certificateAuthorityId?clientRequestToken=stringDeletes a certificate authority (CA) from your cluster. Deleting a certificate authority removes its public certificate from the cluster's trust bundle. You… - GETDescribe cluster
/clusters/:nameDescribes an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to… - DELETEDelete cluster
/clusters/:nameDeletes an Amazon EKS cluster control plane. If you have active services and ingress resources in your cluster that are associated with a load balancer, you… - GETDescribe eks anywhere subscription
/eks-anywhere-subscriptions/:idReturns descriptive information about a subscription. - POSTUpdate eks anywhere subscription
/eks-anywhere-subscriptions/:idUpdate an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation. - DELETEDelete eks anywhere subscription
/eks-anywhere-subscriptions/:idDeletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from… - GETDescribe fargate profile
/clusters/:clusterName/fargate-profiles/:fargateProfileNameDescribes an Fargate profile. - DELETEDelete fargate profile
/clusters/:clusterName/fargate-profiles/:fargateProfileNameDeletes an Fargate profile. When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is deleted. If the Pod matches… - GETDescribe nodegroup
/clusters/:clusterName/node-groups/:nodegroupNameDescribes a managed node group. - DELETEDelete nodegroup
/clusters/:clusterName/node-groups/:nodegroupNameDeletes a managed node group. - GETDescribe pod identity association
/clusters/:clusterName/pod-identity-associations/:associationIdReturns descriptive information about an EKS Pod Identity association. This action requires the ID of the association. You can get the ID from the response to… - POSTUpdate pod identity association
/clusters/:clusterName/pod-identity-associations/:associationIdUpdates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags . You must change at least one… - DELETEDelete pod identity association
/clusters/:clusterName/pod-identity-associations/:associationIdDeletes a EKS Pod Identity association. The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the… - DELETEDeregister cluster
/cluster-registrations/:nameDeregisters a connected cluster to remove it from the Amazon EKS control plane. A connected cluster is a Kubernetes cluster that you've connected to your… - GETDescribe addon configuration
/addons/configuration-schemas?addonName=string&addonVersion=stringReturns configuration options. - GETDescribe addon versions
/addons/supported-versions?kubernetesVersion=string&maxResults=0&nextToken=string&addonName=string&types=&publishers=&owners=Describes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner , publisher , and the type of… - GETDescribe cluster versions
/cluster-versions?clusterType=string&maxResults=0&nextToken=string&defaultOnly=true&includeAll=true&clusterVersions=&status=string&versionStatus=stringLists available Kubernetes versions for Amazon EKS clusters. - POSTDescribe identity provider config
/clusters/:clusterName/identity-provider-configs/describeDescribes an identity provider configuration. - GETDescribe insight
/clusters/:clusterName/insights/:idReturns details about an insight that you specify using its ID. - GETDescribe insights refresh
/clusters/:clusterName/insights-refreshReturns the status of the latest on-demand cluster insights refresh operation. - POSTStart insights refresh
/clusters/:clusterName/insights-refreshInitiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule. - GETDescribe update
/clusters/:name/updates/:updateId?nodegroupName=string&addonName=string&capabilityName=stringDescribes 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… - DELETEDisassociate access policy
/clusters/:clusterName/access-entries/:principalArn/access-policies/:policyArnDisassociates an access policy from an access entry. - POSTDisassociate identity provider config
/clusters/:clusterName/identity-provider-configs/disassociateDisassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider… - GETList access policies
/access-policies?maxResults=0&nextToken=stringLists the available access policies. - GETList identity provider configs
/clusters/:clusterName/identity-provider-configs?maxResults=0&nextToken=stringLists the identity provider configurations for your cluster. - POSTList insights
/clusters/:clusterName/insightsReturns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes… - GETList tags for resource
/tags/:resourceArnList the tags for an Amazon EKS resource. - POSTTag resource
/tags/:resourceArnAssociates the specified tags to an Amazon EKS resource with the specified resourceArn . If existing tags on a resource are not specified in the request… - DELETEUntag resource
/tags/:resourceArn?tagKeys=Deletes specified tags from an Amazon EKS resource. - GETList updates
/clusters/:name/updates?nodegroupName=string&addonName=string&capabilityName=string&nextToken=string&maxResults=0Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region. - POSTUpdate cluster version
/clusters/:name/updatesUpdates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an… - POSTRegister cluster
/cluster-registrationsConnects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current… - POSTUpdate addon
/clusters/:clusterName/addons/:addonName/updateUpdates an Amazon EKS add-on. - POSTUpdate cluster config
/clusters/:name/update-configUpdates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use… - POSTUpdate nodegroup config
/clusters/:clusterName/node-groups/:nodegroupName/update-configUpdates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID… - POSTUpdate nodegroup version
/clusters/:clusterName/node-groups/:nodegroupName/update-versionUpdates the Kubernetes version or AMI version of an Amazon EKS managed node group. You can update a node group using a launch template only if the node group…
API details
- Base URL
https://eks.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 70 operations on 43 pathsGET 29POST 29DELETE 12
- Description format
- AWS Smithy model, API version
2017-11-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Elastic Kubernetes Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Elastic Kubernetes Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Activate certificate authority” (POST /clusters/:clusterName/certificate-authorities/:certificateAuthorityId/activate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Elastic Kubernetes Service?
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services without needing to… It is listed under Developer tools and has 70 endpoints.
Who publishes the Amazon Elastic Kubernetes Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Elastic Kubernetes Service?
Requests go to https://eks.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Elastic Kubernetes Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Elastic Kubernetes Service have?
70 operations on 43 paths (29 GET, 29 POST, 12 DELETE).
Is forking the Amazon Elastic Kubernetes Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.