# Actions The following actions are supported by Amazon Elastic Kubernetes Service: + [AssociateAccessPolicy](API_AssociateAccessPolicy.md) + [AssociateEncryptionConfig](API_AssociateEncryptionConfig.md) + [AssociateIdentityProviderConfig](API_AssociateIdentityProviderConfig.md) + [CreateAccessEntry](API_CreateAccessEntry.md) + [CreateAddon](API_CreateAddon.md) + [CreateCapability](API_CreateCapability.md) + [CreateCluster](API_CreateCluster.md) + [CreateEksAnywhereSubscription](API_CreateEksAnywhereSubscription.md) + [CreateFargateProfile](API_CreateFargateProfile.md) + [CreateNodegroup](API_CreateNodegroup.md) + [CreatePodIdentityAssociation](API_CreatePodIdentityAssociation.md) + [DeleteAccessEntry](API_DeleteAccessEntry.md) + [DeleteAddon](API_DeleteAddon.md) + [DeleteCapability](API_DeleteCapability.md) + [DeleteCluster](API_DeleteCluster.md) + [DeleteEksAnywhereSubscription](API_DeleteEksAnywhereSubscription.md) + [DeleteFargateProfile](API_DeleteFargateProfile.md) + [DeleteNodegroup](API_DeleteNodegroup.md) + [DeletePodIdentityAssociation](API_DeletePodIdentityAssociation.md) + [DeregisterCluster](API_DeregisterCluster.md) + [DescribeAccessEntry](API_DescribeAccessEntry.md) + [DescribeAddon](API_DescribeAddon.md) + [DescribeAddonConfiguration](API_DescribeAddonConfiguration.md) + [DescribeAddonVersions](API_DescribeAddonVersions.md) + [DescribeCapability](API_DescribeCapability.md) + [DescribeCluster](API_DescribeCluster.md) + [DescribeClusterVersions](API_DescribeClusterVersions.md) + [DescribeEksAnywhereSubscription](API_DescribeEksAnywhereSubscription.md) + [DescribeFargateProfile](API_DescribeFargateProfile.md) + [DescribeIdentityProviderConfig](API_DescribeIdentityProviderConfig.md) + [DescribeInsight](API_DescribeInsight.md) + [DescribeInsightsRefresh](API_DescribeInsightsRefresh.md) + [DescribeNodegroup](API_DescribeNodegroup.md) + [DescribePodIdentityAssociation](API_DescribePodIdentityAssociation.md) + [DescribeUpdate](API_DescribeUpdate.md) + [DisassociateAccessPolicy](API_DisassociateAccessPolicy.md) + [DisassociateIdentityProviderConfig](API_DisassociateIdentityProviderConfig.md) + [ListAccessEntries](API_ListAccessEntries.md) + [ListAccessPolicies](API_ListAccessPolicies.md) + [ListAddons](API_ListAddons.md) + [ListAssociatedAccessPolicies](API_ListAssociatedAccessPolicies.md) + [ListCapabilities](API_ListCapabilities.md) + [ListClusters](API_ListClusters.md) + [ListEksAnywhereSubscriptions](API_ListEksAnywhereSubscriptions.md) + [ListFargateProfiles](API_ListFargateProfiles.md) + [ListIdentityProviderConfigs](API_ListIdentityProviderConfigs.md) + [ListInsights](API_ListInsights.md) + [ListNodegroups](API_ListNodegroups.md) + [ListPodIdentityAssociations](API_ListPodIdentityAssociations.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListUpdates](API_ListUpdates.md) + [RegisterCluster](API_RegisterCluster.md) + [StartInsightsRefresh](API_StartInsightsRefresh.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAccessEntry](API_UpdateAccessEntry.md) + [UpdateAddon](API_UpdateAddon.md) + [UpdateCapability](API_UpdateCapability.md) + [UpdateClusterConfig](API_UpdateClusterConfig.md) + [UpdateClusterVersion](API_UpdateClusterVersion.md) + [UpdateEksAnywhereSubscription](API_UpdateEksAnywhereSubscription.md) + [UpdateNodegroupConfig](API_UpdateNodegroupConfig.md) + [UpdateNodegroupVersion](API_UpdateNodegroupVersion.md) + [UpdatePodIdentityAssociation](API_UpdatePodIdentityAssociation.md) The following actions are supported by Amazon EKS Auth: + [AssumeRoleForPodIdentity](API_auth_AssumeRoleForPodIdentity.md) # Amazon Elastic Kubernetes Service The following actions are supported by Amazon Elastic Kubernetes Service: + [AssociateAccessPolicy](API_AssociateAccessPolicy.md) + [AssociateEncryptionConfig](API_AssociateEncryptionConfig.md) + [AssociateIdentityProviderConfig](API_AssociateIdentityProviderConfig.md) + [CreateAccessEntry](API_CreateAccessEntry.md) + [CreateAddon](API_CreateAddon.md) + [CreateCapability](API_CreateCapability.md) + [CreateCluster](API_CreateCluster.md) + [CreateEksAnywhereSubscription](API_CreateEksAnywhereSubscription.md) + [CreateFargateProfile](API_CreateFargateProfile.md) + [CreateNodegroup](API_CreateNodegroup.md) + [CreatePodIdentityAssociation](API_CreatePodIdentityAssociation.md) + [DeleteAccessEntry](API_DeleteAccessEntry.md) + [DeleteAddon](API_DeleteAddon.md) + [DeleteCapability](API_DeleteCapability.md) + [DeleteCluster](API_DeleteCluster.md) + [DeleteEksAnywhereSubscription](API_DeleteEksAnywhereSubscription.md) + [DeleteFargateProfile](API_DeleteFargateProfile.md) + [DeleteNodegroup](API_DeleteNodegroup.md) + [DeletePodIdentityAssociation](API_DeletePodIdentityAssociation.md) + [DeregisterCluster](API_DeregisterCluster.md) + [DescribeAccessEntry](API_DescribeAccessEntry.md) + [DescribeAddon](API_DescribeAddon.md) + [DescribeAddonConfiguration](API_DescribeAddonConfiguration.md) + [DescribeAddonVersions](API_DescribeAddonVersions.md) + [DescribeCapability](API_DescribeCapability.md) + [DescribeCluster](API_DescribeCluster.md) + [DescribeClusterVersions](API_DescribeClusterVersions.md) + [DescribeEksAnywhereSubscription](API_DescribeEksAnywhereSubscription.md) + [DescribeFargateProfile](API_DescribeFargateProfile.md) + [DescribeIdentityProviderConfig](API_DescribeIdentityProviderConfig.md) + [DescribeInsight](API_DescribeInsight.md) + [DescribeInsightsRefresh](API_DescribeInsightsRefresh.md) + [DescribeNodegroup](API_DescribeNodegroup.md) + [DescribePodIdentityAssociation](API_DescribePodIdentityAssociation.md) + [DescribeUpdate](API_DescribeUpdate.md) + [DisassociateAccessPolicy](API_DisassociateAccessPolicy.md) + [DisassociateIdentityProviderConfig](API_DisassociateIdentityProviderConfig.md) + [ListAccessEntries](API_ListAccessEntries.md) + [ListAccessPolicies](API_ListAccessPolicies.md) + [ListAddons](API_ListAddons.md) + [ListAssociatedAccessPolicies](API_ListAssociatedAccessPolicies.md) + [ListCapabilities](API_ListCapabilities.md) + [ListClusters](API_ListClusters.md) + [ListEksAnywhereSubscriptions](API_ListEksAnywhereSubscriptions.md) + [ListFargateProfiles](API_ListFargateProfiles.md) + [ListIdentityProviderConfigs](API_ListIdentityProviderConfigs.md) + [ListInsights](API_ListInsights.md) + [ListNodegroups](API_ListNodegroups.md) + [ListPodIdentityAssociations](API_ListPodIdentityAssociations.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListUpdates](API_ListUpdates.md) + [RegisterCluster](API_RegisterCluster.md) + [StartInsightsRefresh](API_StartInsightsRefresh.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAccessEntry](API_UpdateAccessEntry.md) + [UpdateAddon](API_UpdateAddon.md) + [UpdateCapability](API_UpdateCapability.md) + [UpdateClusterConfig](API_UpdateClusterConfig.md) + [UpdateClusterVersion](API_UpdateClusterVersion.md) + [UpdateEksAnywhereSubscription](API_UpdateEksAnywhereSubscription.md) + [UpdateNodegroupConfig](API_UpdateNodegroupConfig.md) + [UpdateNodegroupVersion](API_UpdateNodegroupVersion.md) + [UpdatePodIdentityAssociation](API_UpdatePodIdentityAssociation.md) # AssociateAccessPolicy Associates an access policy and its scope to an access entry. For more information about associating access policies, see [Associating and disassociating access policies to and from access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html) in the *Amazon EKS User Guide*. ## Request Syntax ``` POST /clusters/name/access-entries/principalArn/access-policies HTTP/1.1 Content-type: application/json { "accessScope": { "namespaces": [ "string" ], "type": "string" }, "policyArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_AssociateAccessPolicy_RequestSyntax) ** The name of your cluster. Required: Yes ** [principalArn](#API_AssociateAccessPolicy_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM user or role for the `AccessEntry` that you're associating the access policy to. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [accessScope](#API_AssociateAccessPolicy_RequestSyntax) ** The scope for the `AccessPolicy`. You can scope access policies to an entire cluster or to specific Kubernetes namespaces. Type: [AccessScope](API_AccessScope.md) object Required: Yes ** [policyArn](#API_AssociateAccessPolicy_RequestSyntax) ** The ARN of the `AccessPolicy` that you're associating. For a list of ARNs, use `ListAccessPolicies`. Type: String Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "associatedAccessPolicy": { "accessScope": { "namespaces": [ "string" ], "type": "string" }, "associatedAt": number, "modifiedAt": number, "policyArn": "string" }, "clusterName": "string", "principalArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [associatedAccessPolicy](#API_AssociateAccessPolicy_ResponseSyntax) ** The `AccessPolicy` and scope associated to the `AccessEntry`. Type: [AssociatedAccessPolicy](API_AssociatedAccessPolicy.md) object ** [clusterName](#API_AssociateAccessPolicy_ResponseSyntax) ** The name of your cluster. Type: String ** [principalArn](#API_AssociateAccessPolicy_ResponseSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example associates the `AmazonEKSAdminPolicy` access policy to an access entry with the IAM role named `my-role`. The IAM role has the permissions in this policy across all namespaces on the cluster. #### Sample Request ``` POST /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role/access-policies HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.associate-access-policy X-Amz-Date: 20230531T134532Z Authorization: AUTHPARAMS Content-Length: 112 { "policyArn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminPolicy", "accessScope": { "type": "cluster" } } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 31 May 2023 13:45:47 GMT Content-Type: application/json Content-Length: 285 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: FylbjHLcPHcFaiA= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "clusterName": "my-cluster ", "principalArn": "arn:aws:iam::012345678910:role/my-role", "associatedAccessPolicy": { "policyArn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminPolicy", "accessScope": { "type": "cluster", "namespaces": [] }, "associatedAt": 1685540747.281, "modifiedAt": 1685540747.281 } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/AssociateAccessPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/AssociateAccessPolicy) # AssociateEncryptionConfig Associates an encryption configuration to an existing cluster. Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters. ## Request Syntax ``` POST /clusters/name/encryption-config/associate HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_AssociateEncryptionConfig_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_AssociateEncryptionConfig_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [encryptionConfig](#API_AssociateEncryptionConfig_RequestSyntax) ** The configuration you are using for encryption. Type: Array of [EncryptionConfig](API_EncryptionConfig.md) objects Array Members: Maximum number of 1 item. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_AssociateEncryptionConfig_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ThrottlingException ** The request or operation couldn't be performed because a service is throttling requests. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/AssociateEncryptionConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/AssociateEncryptionConfig) # AssociateIdentityProviderConfig Associates an identity provider configuration to a cluster. If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes `Role` and `ClusterRole` objects, assign permissions to them, and then bind them to the identities using Kubernetes `RoleBinding` and `ClusterRoleBinding` objects. For more information see [Using RBAC Authorization](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) in the Kubernetes documentation. ## Request Syntax ``` POST /clusters/name/identity-provider-configs/associate HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "oidc": { "clientId": "string", "groupsClaim": "string", "groupsPrefix": "string", "identityProviderConfigName": "string", "issuerUrl": "string", "requiredClaims": { "string" : "string" }, "usernameClaim": "string", "usernamePrefix": "string" }, "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_AssociateIdentityProviderConfig_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_AssociateIdentityProviderConfig_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [oidc](#API_AssociateIdentityProviderConfig_RequestSyntax) ** An object representing an OpenID Connect (OIDC) identity provider configuration. Type: [OidcIdentityProviderConfigRequest](API_OidcIdentityProviderConfigRequest.md) object Required: Yes ** [tags](#API_AssociateIdentityProviderConfig_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" }, "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_AssociateIdentityProviderConfig_ResponseSyntax) ** The tags for the resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. ** [update](#API_AssociateIdentityProviderConfig_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ThrottlingException ** The request or operation couldn't be performed because a service is throttling requests. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/AssociateIdentityProviderConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/AssociateIdentityProviderConfig) # CreateAccessEntry Creates 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 `aws-auth` `ConfigMap` for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes `Role`, `ClusterRole`, `RoleBinding`, and `ClusterRoleBinding` objects, in addition to managing access entries. If you use Amazon EKS authorization exclusively, you don't need to create and manage Kubernetes `Role`, `ClusterRole`, `RoleBinding`, and `ClusterRoleBinding` objects. For more information about access entries, see [Access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) in the *Amazon EKS User Guide*. ## Request Syntax ``` POST /clusters/name/access-entries HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "kubernetesGroups": [ "string" ], "principalArn": "string", "tags": { "string" : "string" }, "type": "string", "username": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_CreateAccessEntry_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateAccessEntry_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [kubernetesGroups](#API_CreateAccessEntry_RequestSyntax) ** The value for `name` that you've specified for `kind: Group` as a `subject` in a Kubernetes `RoleBinding` or `ClusterRoleBinding` object. Amazon EKS doesn't confirm that the value for `name` exists in any bindings on your cluster. You can specify one or more names. Kubernetes authorizes the `principalArn` of the access entry to access any cluster objects that you've specified in a Kubernetes `Role` or `ClusterRole` object that is also specified in a binding's `roleRef`. For more information about creating Kubernetes `RoleBinding`, `ClusterRoleBinding`, `Role`, or `ClusterRole` objects, see [Using RBAC Authorization in the Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/rbac/). If you want Amazon EKS to authorize the `principalArn` (instead of, or in addition to Kubernetes authorizing the `principalArn`), you can associate one or more access policies to the access entry using `AssociateAccessPolicy`. If you associate any access policies, the `principalARN` has all permissions assigned in the associated access policies and all permissions in any Kubernetes `Role` or `ClusterRole` objects that the group names are bound to. Type: Array of strings Required: No ** [principalArn](#API_CreateAccessEntry_RequestSyntax) ** The ARN of the IAM principal for the `AccessEntry`. You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation. The valid principals differ depending on the type of the access entry in the `type` field. For `STANDARD` access entries, you can use every IAM principal type. For nodes (`EC2` (for EKS Auto Mode), `EC2_LINUX`, `EC2_WINDOWS`, `FARGATE_LINUX`, and `HYBRID_LINUX`), the only valid ARN is IAM roles. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions. [IAM best practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp) recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials. Type: String Required: Yes ** [tags](#API_CreateAccessEntry_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ** [type](#API_CreateAccessEntry_RequestSyntax) ** The type of the new access entry. Valid values are `STANDARD`, `FARGATE_LINUX`, `EC2_LINUX`, `EC2_WINDOWS`, `EC2` (for EKS Auto Mode), `HYBRID_LINUX`, and `HYPERPOD_LINUX`. If the `principalArn` is for an IAM role that's used for self-managed Amazon EC2 nodes, specify `EC2_LINUX` or `EC2_WINDOWS`. Amazon EKS grants the necessary permissions to the node for you. If the `principalArn` is for any other purpose, specify `STANDARD`. If you don't specify a value, Amazon EKS sets the value to `STANDARD`. If you have the access mode of the cluster set to `API_AND_CONFIG_MAP`, it's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the `aws-auth` `ConfigMap` for the roles. You can't change this value once you've created the access entry. If you set the value to `EC2_LINUX` or `EC2_WINDOWS`, you can't specify values for `kubernetesGroups`, or associate an `AccessPolicy` to the access entry. Type: String Required: No ** [username](#API_CreateAccessEntry_RequestSyntax) ** The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see [Creating access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries) in the *Amazon EKS User Guide*. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "accessEntry": { "accessEntryArn": "string", "clusterName": "string", "createdAt": number, "kubernetesGroups": [ "string" ], "modifiedAt": number, "principalArn": "string", "tags": { "string" : "string" }, "type": "string", "username": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [accessEntry](#API_CreateAccessEntry_ResponseSyntax) ** An access entry allows an IAM principal (user or role) to access your cluster. Access entries can replace the need to maintain the `aws-auth` `ConfigMap` for authentication. For more information about access entries, see [Access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) in the *Amazon EKS User Guide*. Type: [AccessEntry](API_AccessEntry.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example creates an access entry for an IAM role with the name `my-role`. Since a `type` isn't specified, it's created as type `Standard`. Since a `username` isn't specified, Amazon EKS sets the value for `username`. #### Sample Request ``` POST /clusters/my-cluster/access-entries HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.create-access-entry X-Amz-Date: 20230530T193227Z Authorization: AUTHPARAMS Content-Length: 120 { "principalArn": "arn:aws:iam::012345678910:role/my-role", "clientRequestToken": "5a8578bd-b6c1-4624-9e65-d0b70f857835" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 30 May 2023 19:32:43 GMT Content-Type: application/json Content-Length: 485 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: FwFUDEhlPHcF4WQ= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "accessEntry": { "clusterName": "my-cluster", "principalArn": "arn:aws:iam::012345678910:role/my-role", "kubernetesGroups": [], "accessEntryArn": "arn:aws:eks:us-west-2:012345678910:accessEntry/my-cluster/role/012345678910/my-role/xxx11111-xx1x-xx9115-1x11-xxx111x111x1", "createdAt": 1.685475163532E9, "modifiedAt": 1.685475163532E9, "tags": {}, "username": "arn:aws:sts::012345678910:assumed-role/my-role/{{SessionName}}", "type": "STANDARD" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateAccessEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateAccessEntry) # CreateAddon Creates an Amazon EKS add-on. Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*. ## Request Syntax ``` POST /clusters/name/addons HTTP/1.1 Content-type: application/json { "addonName": "string", "addonVersion": "string", "clientRequestToken": "string", "configurationValues": "string", "namespaceConfig": { "namespace": "string" }, "podIdentityAssociations": [ { "roleArn": "string", "serviceAccount": "string" } ], "resolveConflicts": "string", "serviceAccountRoleArn": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_CreateAddon_RequestSyntax) ** The name of your cluster. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [addonName](#API_CreateAddon_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by `DescribeAddonVersions`. Type: String Required: Yes ** [addonVersion](#API_CreateAddon_RequestSyntax) ** The version of the add-on. The version must match one of the versions returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). Type: String Required: No ** [clientRequestToken](#API_CreateAddon_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [configurationValues](#API_CreateAddon_RequestSyntax) ** 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`. Type: String Required: No ** [namespaceConfig](#API_CreateAddon_RequestSyntax) ** The namespace configuration for the addon. If specified, this will override the default namespace for the addon. Type: [AddonNamespaceConfigRequest](API_AddonNamespaceConfigRequest.md) object Required: No ** [podIdentityAssociations](#API_CreateAddon_RequestSyntax) ** An array of EKS Pod Identity associations to be created. Each association maps a Kubernetes service account to an IAM role. For more information, see [Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity](https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html) in the *Amazon EKS User Guide*. Type: Array of [AddonPodIdentityAssociations](API_AddonPodIdentityAssociations.md) objects Required: No ** [resolveConflicts](#API_CreateAddon_RequestSyntax) ** How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose: + **None** – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail. + **Overwrite** – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value. + **Preserve** – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see [https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html). If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify. Type: String Valid Values: `OVERWRITE | NONE | PRESERVE` Required: No ** [serviceAccountRoleArn](#API_CreateAddon_RequestSyntax) ** 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](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) 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](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the *Amazon EKS User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [tags](#API_CreateAddon_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "addon": { "addonArn": "string", "addonName": "string", "addonVersion": "string", "clusterName": "string", "configurationValues": "string", "createdAt": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "marketplaceInformation": { "productId": "string", "productUrl": "string" }, "modifiedAt": number, "namespaceConfig": { "namespace": "string" }, "owner": "string", "podIdentityAssociations": [ "string" ], "publisher": "string", "serviceAccountRoleArn": "string", "status": "string", "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [addon](#API_CreateAddon_ResponseSyntax) ** An Amazon EKS add-on. For more information, see [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*. Type: [Addon](API_Addon.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example creates an add-on named `vpc-cni`. The add-on uses an existing IAM role named `AmazonEKSCNIRole`. If the add-on existed prior to creating the Amazon EKS add-on, its settings are overwritten with the Amazon EKS add-on's settings. #### Sample Request ``` POST /clusters/my-cluster/addons HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T143943Z Authorization: AUTHPARAMS Content-Length: 195 { "addonName": "vpc-cni", "serviceAccountRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "resolveConflicts": "overwrite", "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:39:44 GMT Content-Type: application/json Content-Length: 474 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkXriGcavHcFyqw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "addon" : { "addonName" : "vpc-cni", "clusterName" : "1-18", "status" : "CREATING", "addonVersion" : "v1.7.5-eksbuild.1", "health" : { "issues" : [ ] }, "addonArn" : "arn:aws:eks:us-west-2:012345678910:addon/my-cluster/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "createdAt" : 1.606315184255E9, "modifiedAt" : 1.606315184274E9, "serviceAccountRoleArn" : "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "tags" : { } } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateAddon) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateAddon) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateAddon) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateAddon) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateAddon) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateAddon) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateAddon) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateAddon) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateAddon) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateAddon) # CreateCapability Creates a managed capability resource for an Amazon EKS cluster. Capabilities provide fully managed capabilities to build and scale with Kubernetes. When you create a capability, Amazon EKSprovisions and manages the infrastructure required to run the capability outside of your cluster. This approach reduces operational overhead and preserves cluster resources. You can only create one Capability of each type on a given Amazon EKS cluster. Valid types are Argo CD for declarative GitOps deployment, AWS Controllers for Kubernetes (ACK) for resource management, and Kube Resource Orchestrator (KRO) for Kubernetes custom resource orchestration. For more information, see [EKS Capabilities](https://docs.aws.amazon.com/eks/latest/userguide/capabilities.html) in the *Amazon EKS User Guide*. ## Request Syntax ``` POST /clusters/name/capabilities HTTP/1.1 Content-type: application/json { "capabilityName": "string", "clientRequestToken": "string", "configuration": { "argoCd": { "awsIdc": { "idcInstanceArn": "string", "idcRegion": "string" }, "namespace": "string", "networkAccess": { "vpceIds": [ "string" ] }, "rbacRoleMappings": [ { "identities": [ { "id": "string", "type": "string" } ], "role": "string" } ] } }, "deletePropagationPolicy": "string", "roleArn": "string", "tags": { "string" : "string" }, "type": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_CreateCapability_RequestSyntax) ** The name of the Amazon EKS cluster where you want to create the capability. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [capabilityName](#API_CreateCapability_RequestSyntax) ** A unique name for the capability. The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores. Type: String Required: Yes ** [clientRequestToken](#API_CreateCapability_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. Type: String Required: No ** [configuration](#API_CreateCapability_RequestSyntax) ** The configuration settings for the capability. The structure of this object varies depending on the capability type. For Argo CD capabilities, you can configure IAM Identity CenterIAM; Identity Center integration, RBAC role mappings, and network access settings. Type: [CapabilityConfigurationRequest](API_CapabilityConfigurationRequest.md) object Required: No ** [deletePropagationPolicy](#API_CreateCapability_RequestSyntax) ** Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is `RETAIN` which retains all Kubernetes resources managed by the capability when the capability is deleted. Because resources are retained, all Kubernetes resources created by the capability should be deleted from the cluster before deleting the capability itself. After the capability is deleted, these resources become difficult to manage because the controller is no longer available. Type: String Valid Values: `RETAIN` Required: Yes ** [roleArn](#API_CreateCapability_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services. This role must have a trust policy that allows the EKS service principal to assume it, and it must have the necessary permissions for the capability type you're creating. For ACK capabilities, the role needs permissions to manage the resources you want to control through Kubernetes. For Argo CD capabilities, the role needs permissions to access Git repositories and Secrets Manager. For KRO capabilities, the role needs permissions based on the resources you'll be orchestrating. Type: String Required: Yes ** [tags](#API_CreateCapability_RequestSyntax) ** The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. The following basic restrictions apply to tags: + Maximum number of tags per resource – 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length – 128 Unicode characters in UTF-8 + Maximum value length – 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: \$1 - = . \$1 : / @. + Tag keys and values are case-sensitive. + Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ** [type](#API_CreateCapability_RequestSyntax) ** The type of capability to create. Valid values are: + `ACK` – AWS Controllers for Kubernetes (ACK), which lets you manage resources directly from Kubernetes. + `ARGOCD` – Argo CD for GitOps-based continuous delivery. + `KRO` – Kube Resource Orchestrator (KRO) for composing and managing custom Kubernetes resources. Type: String Valid Values: `ACK | KRO | ARGOCD` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "capability": { "arn": "string", "capabilityName": "string", "clusterName": "string", "configuration": { "argoCd": { "awsIdc": { "idcInstanceArn": "string", "idcManagedApplicationArn": "string", "idcRegion": "string" }, "namespace": "string", "networkAccess": { "vpceIds": [ "string" ] }, "rbacRoleMappings": [ { "identities": [ { "id": "string", "type": "string" } ], "role": "string" } ], "serverUrl": "string" } }, "createdAt": number, "deletePropagationPolicy": "string", "health": { "issues": [ { "code": "string", "message": "string" } ] }, "modifiedAt": number, "roleArn": "string", "status": "string", "tags": { "string" : "string" }, "type": "string", "version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [capability](#API_CreateCapability_ResponseSyntax) ** An object containing information about the newly created capability, including its name, ARN, status, and configuration. Type: [Capability](API_Capability.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. ** message ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ThrottlingException ** The request or operation couldn't be performed because a service is throttling requests. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateCapability) # CreateCluster Creates 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 API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances. The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support `kubectl exec`, `logs`, and `proxy` data flows). Amazon EKS nodes run in your AWS account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster. You can use the `endpointPublicAccess` and `endpointPrivateAccess` parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. The endpoint domain name and IP address family depends on the value of the `ipFamily` for the cluster. For more information, see [Amazon EKS Cluster Endpoint Access Control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the * *Amazon EKS User Guide* *. You can use the `logging` parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see [Amazon EKS Cluster Control Plane Logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the * *Amazon EKS User Guide* *. **Note** CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/). In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see [Allowing users to access your cluster](https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html) and [Launching Amazon EKS nodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the *Amazon EKS User Guide*. ## Request Syntax ``` POST /clusters HTTP/1.1 Content-type: application/json { "accessConfig": { "authenticationMode": "string", "bootstrapClusterCreatorAdminPermissions": boolean }, "bootstrapSelfManagedAddons": boolean, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "deletionProtection": boolean, "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ], "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "name": "string", "outpostConfig": { "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string" }, "outpostArns": [ "string" ] }, "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] }, "roleArn": "string", "storageConfig": { "blockStorage": { "enabled": boolean } }, "tags": { "string" : "string" }, "upgradePolicy": { "supportType": "string" }, "version": "string", "zonalShiftConfig": { "enabled": boolean } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [accessConfig](#API_CreateCluster_RequestSyntax) ** The access configuration for the cluster. Type: [CreateAccessConfigRequest](API_CreateAccessConfigRequest.md) object Required: No ** [bootstrapSelfManagedAddons](#API_CreateCluster_RequestSyntax) ** If you set this value to `False` when creating a cluster, the default networking add-ons will not be installed. The default networking add-ons include `vpc-cni`, `coredns`, and `kube-proxy`. Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons. Type: Boolean Required: No ** [clientRequestToken](#API_CreateCluster_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [computeConfig](#API_CreateCluster_RequestSyntax) ** Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account Type: [ComputeConfigRequest](API_ComputeConfigRequest.md) object Required: No ** [controlPlaneScalingConfig](#API_CreateCluster_RequestSyntax) ** The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. Type: [ControlPlaneScalingConfig](API_ControlPlaneScalingConfig.md) object Required: No ** [deletionProtection](#API_CreateCluster_RequestSyntax) ** Indicates whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. This helps prevent accidental cluster deletion. Default value is `false`. Type: Boolean Required: No ** [encryptionConfig](#API_CreateCluster_RequestSyntax) ** The encryption configuration for the cluster. Type: Array of [EncryptionConfig](API_EncryptionConfig.md) objects Array Members: Maximum number of 1 item. Required: No ** [kubernetesNetworkConfig](#API_CreateCluster_RequestSyntax) ** The Kubernetes network configuration for the cluster. Type: [KubernetesNetworkConfigRequest](API_KubernetesNetworkConfigRequest.md) object Required: No ** [logging](#API_CreateCluster_RequestSyntax) ** Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren't exported to CloudWatch Logs . For more information, see [Amazon EKS Cluster control plane logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the * *Amazon EKS User Guide* *. CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/). Type: [Logging](API_Logging.md) object Required: No ** [name](#API_CreateCluster_RequestSyntax) ** The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the AWS Region and AWS account that you're creating the cluster in. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ** [outpostConfig](#API_CreateCluster_RequestSyntax) ** An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. Before creating a local cluster on an Outpost, review [Local clusters for Amazon EKS on AWS Outposts](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html) in the *Amazon EKS User Guide*. This object isn't available for creating Amazon EKS clusters on the AWS cloud. Type: [OutpostConfigRequest](API_OutpostConfigRequest.md) object Required: No ** [remoteNetworkConfig](#API_CreateCluster_RequestSyntax) ** The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. Type: [RemoteNetworkConfigRequest](API_RemoteNetworkConfigRequest.md) object Required: No ** [resourcesVpcConfig](#API_CreateCluster_RequestSyntax) ** The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see [Cluster VPC Considerations](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the *Amazon EKS User Guide*. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane. Type: [VpcConfigRequest](API_VpcConfigRequest.md) object Required: Yes ** [roleArn](#API_CreateCluster_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. For more information, see [Amazon EKS Service IAM Role](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the * *Amazon EKS User Guide* *. Type: String Required: Yes ** [storageConfig](#API_CreateCluster_RequestSyntax) ** Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. Type: [StorageConfigRequest](API_StorageConfigRequest.md) object Required: No ** [tags](#API_CreateCluster_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ** [upgradePolicy](#API_CreateCluster_RequestSyntax) ** New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to `STANDARD`. Type: [UpgradePolicyRequest](API_UpgradePolicyRequest.md) object Required: No ** [version](#API_CreateCluster_RequestSyntax) ** The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used. The default version might not be the latest version available. Type: String Required: No ** [zonalShiftConfig](#API_CreateCluster_RequestSyntax) ** Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, AWS configures zonal autoshift for the cluster. Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary. You can start a zonal shift for an Amazon EKS cluster, or you can allow AWS to do it for you by enabling *zonal autoshift*. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html) in the * *Amazon EKS User Guide* *. Type: [ZonalShiftConfigRequest](API_ZonalShiftConfigRequest.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "accessConfig": { "authenticationMode": "string", "bootstrapClusterCreatorAdminPermissions": boolean }, "arn": "string", "certificateAuthority": { "data": "string" }, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "connectorConfig": { "activationCode": "string", "activationExpiry": number, "activationId": "string", "provider": "string", "roleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "createdAt": number, "deletionProtection": boolean, "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ], "endpoint": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "id": "string", "identity": { "oidc": { "issuer": "string" } }, "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string", "serviceIpv6Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "name": "string", "outpostConfig": { "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string" }, "outpostArns": [ "string" ] }, "platformVersion": "string", "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "clusterSecurityGroupId": "string", "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" }, "roleArn": "string", "status": "string", "storageConfig": { "blockStorage": { "enabled": boolean } }, "tags": { "string" : "string" }, "upgradePolicy": { "supportType": "string" }, "version": "string", "zonalShiftConfig": { "enabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [cluster](#API_CreateCluster_ResponseSyntax) ** The full description of your new cluster. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ** UnsupportedAvailabilityZoneException ** At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** validZones ** The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster. HTTP Status Code: 400 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example creates an Amazon EKS cluster named `my-cluster` with endpoint public and private access enabled. #### Sample Request ``` POST /clusters HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.120 Python/3.7.0 Darwin/18.2.0 botocore/1.12.110 X-Amz-Date: 20190322T160158Z Authorization: AUTHPARAMS Content-Length: 368 { "name": "my-cluster", "roleArn": "arn:aws:iam::012345678910:role/eksClusterRole", "resourcesVpcConfig": { "subnetIds": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz" ], "securityGroupIds": [ "sg-xxxxxxxxxxxxxxxxx" ], "endpointPublicAccess": true, "endpointPrivateAccess": true }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Fri, 22 Mar 2019 16:01:58 GMT Content-Type: application/json Content-Length: 682 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: W84GUEIbPHcFW2Q= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "cluster": { "name": "my-cluster", "arn": "arn:aws:eks:us-west-2:012345678910:cluster/my-cluster", "createdAt": 1573484658.211, "version": "1.14", "roleArn": "arn:aws:iam::012345678910:role/eksClusterRole", "resourcesVpcConfig": { "subnetIds": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz" ], "securityGroupIds": [], "vpcId": "vpc-xxxxxxxxxxxxxxxxx", "endpointPublicAccess": true, "endpointPrivateAccess": false }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": false } ] }, "status": "CREATING", "certificateAuthority": {}, "platformVersion": "eks.3", "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateCluster) # CreateEksAnywhereSubscription 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 AWS License Manager and the caller account is granted access to EKS Anywhere Curated Packages. ## Request Syntax ``` POST /eks-anywhere-subscriptions HTTP/1.1 Content-type: application/json { "autoRenew": boolean, "clientRequestToken": "string", "licenseQuantity": number, "licenseType": "string", "name": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [autoRenew](#API_CreateEksAnywhereSubscription_RequestSyntax) ** A boolean indicating whether the subscription auto renews at the end of the term. Type: Boolean Required: No ** [clientRequestToken](#API_CreateEksAnywhereSubscription_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [licenseQuantity](#API_CreateEksAnywhereSubscription_RequestSyntax) ** 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. Type: Integer Required: No ** [licenseType](#API_CreateEksAnywhereSubscription_RequestSyntax) ** 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. Type: String Valid Values: `Cluster` Required: No ** [name](#API_CreateEksAnywhereSubscription_RequestSyntax) ** The unique name for your subscription. It must be unique in your AWS account in the AWS 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ** [tags](#API_CreateEksAnywhereSubscription_RequestSyntax) ** 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. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ** [term](#API_CreateEksAnywhereSubscription_RequestSyntax) ** 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. Type: [EksAnywhereSubscriptionTerm](API_EksAnywhereSubscriptionTerm.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "subscription": { "arn": "string", "autoRenew": boolean, "createdAt": number, "effectiveDate": number, "expirationDate": number, "id": "string", "licenseArns": [ "string" ], "licenseQuantity": number, "licenses": [ { "id": "string", "token": "string" } ], "licenseType": "string", "status": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [subscription](#API_CreateEksAnywhereSubscription_ResponseSyntax) ** The full description of the subscription. Type: [EksAnywhereSubscription](API_EksAnywhereSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateEksAnywhereSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateEksAnywhereSubscription) # CreateFargateProfile Creates an AWS 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 profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile's selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate. When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes [Role Based Access Control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC) for authorization so that the `kubelet` that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see [Pod Execution Role](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the *Amazon EKS User Guide*. Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating. If any Fargate profiles in a cluster are in the `DELETING` status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster. For more information, see [AWS Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the *Amazon EKS User Guide*. ## Request Syntax ``` POST /clusters/name/fargate-profiles HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "fargateProfileName": "string", "podExecutionRoleArn": "string", "selectors": [ { "labels": { "string" : "string" }, "namespace": "string" } ], "subnets": [ "string" ], "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_CreateFargateProfile_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateFargateProfile_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [fargateProfileName](#API_CreateFargateProfile_RequestSyntax) ** The name of the Fargate profile. Type: String Required: Yes ** [podExecutionRoleArn](#API_CreateFargateProfile_RequestSyntax) ** The Amazon Resource Name (ARN) of the `Pod` execution role to use for a `Pod` that matches the selectors in the Fargate profile. The `Pod` execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see [`Pod` execution role](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the *Amazon EKS User Guide*. Type: String Required: Yes ** [selectors](#API_CreateFargateProfile_RequestSyntax) ** The selectors to match for a `Pod` to use this Fargate profile. Each selector must have an associated Kubernetes `namespace`. Optionally, you can also specify `labels` for a `namespace`. You may specify up to five selectors in a Fargate profile. Type: Array of [FargateProfileSelector](API_FargateProfileSelector.md) objects Required: No ** [subnets](#API_CreateFargateProfile_RequestSyntax) ** The IDs of subnets to launch a `Pod` into. A `Pod` running on Fargate isn't assigned a public IP address, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter. Type: Array of strings Required: No ** [tags](#API_CreateFargateProfile_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "fargateProfile": { "clusterName": "string", "createdAt": number, "fargateProfileArn": "string", "fargateProfileName": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "podExecutionRoleArn": "string", "selectors": [ { "labels": { "string" : "string" }, "namespace": "string" } ], "status": "string", "subnets": [ "string" ], "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [fargateProfile](#API_CreateFargateProfile_ResponseSyntax) ** The full description of your new Fargate profile. Type: [FargateProfile](API_FargateProfile.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** UnsupportedAvailabilityZoneException ** At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** validZones ** The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster. HTTP Status Code: 400 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example creates a Fargate profile called `default-with-infrastructure-label` in the `fargate` cluster. Any `Pod` launched in the `default` `namespace` with the Kubernetes `label` `"infrastructure": "fargate"` is run on Fargate. #### Sample Request ``` POST /clusters/fargate/fargate-profiles HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.284 Python/3.7.5 Darwin/18.7.0 botocore/1.13.20 X-Amz-Date: 20191120T202529Z Authorization: AUTHPARAMS Content-Length: 355 { "fargateProfileName": "default-with-infrastructure-label", "podExecutionRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSPodExecutionRole", "subnets": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy" ], "selectors": [ { "namespace": "default", "labels": { "infrastructure": "fargate" } } ], "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 20 Nov 2019 20:37:30 GMT Content-Type: application/json Content-Length: 610 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DeaRjFWPvHcFcXw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "fargateProfile": { "fargateProfileName": "compute-label", "fargateProfileArn": "arn:aws:eks:us-west-2:012345678910:fargateprofile/fargate/compute-label/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clusterName": "fargate", "createdAt": 1574206849.791, "podExecutionRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSPodExecutionRole", "subnets": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy" ], "selectors": [ { "namespace": "kube-system", "labels": { "compute": "fargate" } } ], "status": "CREATING", "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateFargateProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateFargateProfile) # CreateNodegroup Creates 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 the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For later updates, you will only be able to update a node group using a launch template only if it was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. For more information about using launch templates, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html). An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. For more information, see [Managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in the *Amazon EKS User Guide*. **Note** Windows AMI types are only supported for commercial AWS Regions that support Windows on Amazon EKS. ## Request Syntax ``` POST /clusters/name/node-groups HTTP/1.1 Content-type: application/json { "amiType": "string", "capacityType": "string", "clientRequestToken": "string", "diskSize": number, "instanceTypes": [ "string" ], "labels": { "string" : "string" }, "launchTemplate": { "id": "string", "name": "string", "version": "string" }, "nodegroupName": "string", "nodeRepairConfig": { "enabled": boolean, "maxParallelNodesRepairedCount": number, "maxParallelNodesRepairedPercentage": number, "maxUnhealthyNodeThresholdCount": number, "maxUnhealthyNodeThresholdPercentage": number, "nodeRepairConfigOverrides": [ { "minRepairWaitTimeMins": number, "nodeMonitoringCondition": "string", "nodeUnhealthyReason": "string", "repairAction": "string" } ] }, "nodeRole": "string", "releaseVersion": "string", "remoteAccess": { "ec2SshKey": "string", "sourceSecurityGroups": [ "string" ] }, "scalingConfig": { "desiredSize": number, "maxSize": number, "minSize": number }, "subnets": [ "string" ], "tags": { "string" : "string" }, "taints": [ { "effect": "string", "key": "string", "value": "string" } ], "updateConfig": { "maxUnavailable": number, "maxUnavailablePercentage": number, "updateStrategy": "string" }, "version": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_CreateNodegroup_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [amiType](#API_CreateNodegroup_RequestSyntax) ** The AMI type for your node group. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add `eks:kube-proxy-windows` to your Windows nodes `rolearn` in the `aws-auth` `ConfigMap`. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: String Valid Values: `AL2_x86_64 | AL2_x86_64_GPU | AL2_ARM_64 | CUSTOM | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_x86_64 | BOTTLEROCKET_ARM_64_FIPS | BOTTLEROCKET_x86_64_FIPS | BOTTLEROCKET_ARM_64_NVIDIA | BOTTLEROCKET_x86_64_NVIDIA | BOTTLEROCKET_ARM_64_NVIDIA_FIPS | BOTTLEROCKET_x86_64_NVIDIA_FIPS | WINDOWS_CORE_2019_x86_64 | WINDOWS_FULL_2019_x86_64 | WINDOWS_CORE_2022_x86_64 | WINDOWS_FULL_2022_x86_64 | WINDOWS_CORE_2025_x86_64 | WINDOWS_FULL_2025_x86_64 | AL2023_x86_64_STANDARD | AL2023_ARM_64_STANDARD | AL2023_x86_64_NEURON | AL2023_x86_64_NVIDIA | AL2023_ARM_64_NVIDIA` Required: No ** [capacityType](#API_CreateNodegroup_RequestSyntax) ** The capacity type for your node group. Type: String Valid Values: `ON_DEMAND | SPOT | CAPACITY_BLOCK` Required: No ** [clientRequestToken](#API_CreateNodegroup_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [diskSize](#API_CreateNodegroup_RequestSyntax) ** The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: Integer Required: No ** [instanceTypes](#API_CreateNodegroup_RequestSyntax) ** Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the `amiType` parameter. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0-20 instance types for `instanceTypes`. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: Array of strings Required: No ** [labels](#API_CreateNodegroup_RequestSyntax) ** The Kubernetes `labels` to apply to the nodes in the node group when they are created. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 63. Value Length Constraints: Minimum length of 1. Maximum length of 63. Required: No ** [launchTemplate](#API_CreateNodegroup_RequestSyntax) ** An object representing a node group's launch template specification. When using this object, don't directly specify `instanceTypes`, `diskSize`, or `remoteAccess`. You cannot later specify a different launch template ID or name than what was used to create the node group. Make sure that the launch template meets the requirements in `launchTemplateSpecification`. Also refer to [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: [LaunchTemplateSpecification](API_LaunchTemplateSpecification.md) object Required: No ** [nodegroupName](#API_CreateNodegroup_RequestSyntax) ** The unique name to give your node group. Type: String Required: Yes ** [nodeRepairConfig](#API_CreateNodegroup_RequestSyntax) ** The node auto repair configuration for the node group. Type: [NodeRepairConfig](API_NodeRepairConfig.md) object Required: No ** [nodeRole](#API_CreateNodegroup_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node `kubelet` daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see [Amazon EKS node IAM role](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the * *Amazon EKS User Guide* *. If you specify `launchTemplate`, then don't specify ` [IamInstanceProfile](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) ` in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: String Required: Yes ** [releaseVersion](#API_CreateNodegroup_RequestSyntax) ** The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User Guide*. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see [Amazon EKS optimized Windows AMI versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) in the *Amazon EKS User Guide*. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `releaseVersion`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: String Required: No ** [remoteAccess](#API_CreateNodegroup_RequestSyntax) ** The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: [RemoteAccessConfig](API_RemoteAccessConfig.md) object Required: No ** [scalingConfig](#API_CreateNodegroup_RequestSyntax) ** The scaling configuration details for the Auto Scaling group that is created for your node group. Type: [NodegroupScalingConfig](API_NodegroupScalingConfig.md) object Required: No ** [subnets](#API_CreateNodegroup_RequestSyntax) ** The subnets to use for the Auto Scaling group that is created for your node group. If you specify `launchTemplate`, then don't specify ` [SubnetId](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) ` in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: Array of strings Required: Yes ** [tags](#API_CreateNodegroup_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ** [taints](#API_CreateNodegroup_RequestSyntax) ** The Kubernetes taints to be applied to the nodes in the node group. For more information, see [Node taints on managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). Type: Array of [Taint](API_Taint.md) objects Required: No ** [updateConfig](#API_CreateNodegroup_RequestSyntax) ** The node group update configuration. Type: [NodegroupUpdateConfig](API_NodegroupUpdateConfig.md) object Required: No ** [version](#API_CreateNodegroup_RequestSyntax) ** The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `version`, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nodegroup": { "amiType": "string", "capacityType": "string", "clusterName": "string", "createdAt": number, "diskSize": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "instanceTypes": [ "string" ], "labels": { "string" : "string" }, "launchTemplate": { "id": "string", "name": "string", "version": "string" }, "modifiedAt": number, "nodegroupArn": "string", "nodegroupName": "string", "nodeRepairConfig": { "enabled": boolean, "maxParallelNodesRepairedCount": number, "maxParallelNodesRepairedPercentage": number, "maxUnhealthyNodeThresholdCount": number, "maxUnhealthyNodeThresholdPercentage": number, "nodeRepairConfigOverrides": [ { "minRepairWaitTimeMins": number, "nodeMonitoringCondition": "string", "nodeUnhealthyReason": "string", "repairAction": "string" } ] }, "nodeRole": "string", "releaseVersion": "string", "remoteAccess": { "ec2SshKey": "string", "sourceSecurityGroups": [ "string" ] }, "resources": { "autoScalingGroups": [ { "name": "string" } ], "remoteAccessSecurityGroup": "string" }, "scalingConfig": { "desiredSize": number, "maxSize": number, "minSize": number }, "status": "string", "subnets": [ "string" ], "tags": { "string" : "string" }, "taints": [ { "effect": "string", "key": "string", "value": "string" } ], "updateConfig": { "maxUnavailable": number, "maxUnavailablePercentage": number, "updateStrategy": "string" }, "version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nodegroup](#API_CreateNodegroup_ResponseSyntax) ** The full description of your new node group. Type: [Nodegroup](API_Nodegroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example 1 This example creates a managed node group without a launch template that uses an Amazon EKS optimized AMI with GPU support on `p2.xlarge` instances. #### Sample Request ``` POST /clusters/my-cluster/node-groups HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20200812T151423Z Authorization: AUTHPARAMS Content-Length: 454 { "nodegroupName": "my-nodegroup-gpu", "scalingConfig": { "minSize": 2, "maxSize": 2, "desiredSize": 2 }, "subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"], "instanceTypes": ["p2.xlarge"], "amiType": "AL2_x86_64_GPU", "remoteAccess": { "ec2SshKey": "id_rsa" }, "nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole", "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 12 Aug 2020 15:14:24 GMT Content-Type: application/json Content-Length: 951 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAc5BGsWvHcF_bw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "nodegroup": { "nodegroupName": "my-nodegroup-gpu2", "nodegroupArn": "arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/my-nodegroup-gpu2/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clusterName": "lt-testing", "version": "1.17", "releaseVersion": "1.17.9-20200804", "createdAt": 1.597245264844E9, "modifiedAt": 1.597245264844E9, "status": "CREATING", "scalingConfig": { "minSize": 2, "maxSize": 2, "desiredSize": 2 }, "instanceTypes": ["p2.xlarge"], "subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"], "remoteAccess": { "ec2SshKey": "id_rsa", "sourceSecurityGroups": null }, "amiType": "AL2_x86_64_GPU", "nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole", "labels": null, "resources": null, "diskSize": 20, "health": { "issues": [] }, "launchTemplate": null, "tags": {} } } ``` ### Example 2 This example creates a managed node group with an Amazon EKS optimized AMI using version `2` of a launch template named `my-launch-template`. #### Sample Request ``` POST /clusters/lt-testing/node-groups HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20200812T135927Z Authorization: AUTHPARAMS Content-Length: 433 { "nodegroupName": "my-nodegroup", "scalingConfig": { "minSize": 2, "maxSize": 2, "desiredSize": 2 }, "subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"], "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole", "launchTemplate": { "name": "my-launch-template", "version": "2" }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 12 Aug 2020 13:59:32 GMT Content-Type: application/json Content-Length: 1028 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAc5BGsWvHcF_bw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "nodegroup": { "nodegroupName": "my-nodegroup", "nodegroupArn": "arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/my-nodegroup/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clusterName": "my-cluster", "version": "1.17", "releaseVersion": "1.17.9-20200804", "createdAt": 1.597240771904E9, "modifiedAt": 1.597240771904E9, "status": "CREATING", "scalingConfig": { "minSize": 2, "maxSize": 2, "desiredSize": 2 }, "instanceTypes": null, "subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"], "remoteAccess": null, "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole", "labels": null, "resources": null, "diskSize": null, "health": { "issues": [] }, "launchTemplate": { "name": "my-template", "version": "2", "id": "lt-xxxxxxxxxxxxxxxxx" }, "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreateNodegroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreateNodegroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreateNodegroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreateNodegroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreateNodegroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreateNodegroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreateNodegroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreateNodegroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreateNodegroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreateNodegroup) # CreatePodIdentityAssociation Creates 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 give temporary IAM credentials to Pods and the credentials are rotated automatically. Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances. If a Pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the Pod. The environment variables configure the AWS SDKs, including the AWS Command Line Interface, to use the EKS Pod Identity credentials. EKS Pod Identity is a simpler method than *IAM roles for service accounts*, as this method doesn't use OIDC identity providers. Additionally, you can configure a role for EKS Pod Identity once, and reuse it across clusters. Similar to AWS IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a *target IAM role* in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another AWS account. ## Request Syntax ``` POST /clusters/name/pod-identity-associations HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "disableSessionTags": boolean, "namespace": "string", "policy": "string", "roleArn": "string", "serviceAccount": "string", "tags": { "string" : "string" }, "targetRoleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_CreatePodIdentityAssociation_RequestSyntax) ** The name of the cluster to create the EKS Pod Identity association in. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreatePodIdentityAssociation_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [disableSessionTags](#API_CreatePodIdentityAssociation_RequestSyntax) ** Disable the automatic sessions tags that are appended by EKS Pod Identity. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to AWS resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see [List of session tags added by EKS Pod Identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags) in the *Amazon EKS User Guide*. AWS compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a `PackedPolicyTooLarge` error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity. Type: Boolean Required: No ** [namespace](#API_CreatePodIdentityAssociation_RequestSyntax) ** The name of the Kubernetes namespace inside the cluster to create the EKS Pod Identity association in. The service account and the Pods that use the service account must be in this namespace. Type: String Required: Yes ** [policy](#API_CreatePodIdentityAssociation_RequestSyntax) ** An optional IAM policy in JSON format (as an escaped string) that applies additional restrictions to this pod identity association beyond the IAM policies attached to the IAM role. This policy is applied as the intersection of the role's policies and this policy, allowing you to reduce the permissions that applications in the pods can use. Use this policy to enforce least privilege access while still leveraging a shared IAM role across multiple applications. **Important considerations** + **Session tags:** When using this policy, `disableSessionTags` must be set to `true`. + **Target role permissions:** If you specify both a `TargetRoleArn` and a policy, the policy restrictions apply only to the target role's permissions, not to the initial role used for assuming the target role. Type: String Required: No ** [roleArn](#API_CreatePodIdentityAssociation_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account. Type: String Required: Yes ** [serviceAccount](#API_CreatePodIdentityAssociation_RequestSyntax) ** The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. Type: String Required: Yes ** [tags](#API_CreatePodIdentityAssociation_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. The following basic restrictions apply to tags: + Maximum number of tags per resource – 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length – 128 Unicode characters in UTF-8 + Maximum value length – 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: \$1 - = . \$1 : / @. + Tag keys and values are case-sensitive. + Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ** [targetRoleArn](#API_CreatePodIdentityAssociation_RequestSyntax) ** The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. When you run applications on Amazon EKS, your application might need to access AWS resources from a different role that exists in the same or different AWS account. For example, your application running in “Account A” might need to access resources, such as Amazon S3 buckets in “Account B” or within “Account A” itself. You can create a association to access AWS resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the *IAM role* and *Target IAM role* fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "association": { "associationArn": "string", "associationId": "string", "clusterName": "string", "createdAt": number, "disableSessionTags": boolean, "externalId": "string", "modifiedAt": number, "namespace": "string", "ownerArn": "string", "policy": "string", "roleArn": "string", "serviceAccount": "string", "tags": { "string" : "string" }, "targetRoleArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [association](#API_CreatePodIdentityAssociation_ResponseSyntax) ** The full description of your new association. The description includes an ID for the association. Use the ID of the association in further actions to manage the association. Type: [PodIdentityAssociation](API_PodIdentityAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/CreatePodIdentityAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/CreatePodIdentityAssociation) # DeleteAccessEntry Deletes 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 in error, you can recreate it. ## Request Syntax ``` DELETE /clusters/name/access-entries/principalArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteAccessEntry_RequestSyntax) ** The name of your cluster. Required: Yes ** [principalArn](#API_DeleteAccessEntry_RequestSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example deletes an access entry. #### Sample Request ``` DELETE /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.delete-access-entry X-Amz-Date: 20230531T160655Z Authorization: AUTHPARAMS Content-Length: 0 ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 31 May 2023 16:06:56 GMT Content-Type: application/json Content-Length: 2 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: Fy6JBE3tvHcFvwA= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive {} ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteAccessEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteAccessEntry) # DeleteAddon Deletes 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 Kubernetes API. ## Request Syntax ``` DELETE /clusters/name/addons/addonName?preserve=preserve HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_DeleteAddon_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). Required: Yes ** [name](#API_DeleteAddon_RequestSyntax) ** The name of your cluster. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ** [preserve](#API_DeleteAddon_RequestSyntax) ** Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn't removed. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "addon": { "addonArn": "string", "addonName": "string", "addonVersion": "string", "clusterName": "string", "configurationValues": "string", "createdAt": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "marketplaceInformation": { "productId": "string", "productUrl": "string" }, "modifiedAt": number, "namespaceConfig": { "namespace": "string" }, "owner": "string", "podIdentityAssociations": [ "string" ], "publisher": "string", "serviceAccountRoleArn": "string", "status": "string", "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [addon](#API_DeleteAddon_ResponseSyntax) ** An Amazon EKS add-on. For more information, see [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*. Type: [Addon](API_Addon.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example deletes an add-on named `vpc-cni`. #### Sample Request ``` DELETE /clusters/1-18/addons/vpc-cni HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T145907Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:59:08 GMT Content-Type: application/json Content-Length: 474 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkahaEGlvHcF1zA= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "addon" : { "addonName" : "vpc-cni", "clusterName" : "1-18", "status" : "DELETING", "addonVersion" : "v1.7.5-eksbuild.1", "health" : { "issues" : [ ] }, "addonArn" : "arn:aws:eks:us-west-2:012345678910:addon/1-18/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "createdAt" : 1.606315184255E9, "modifiedAt" : 1.606316348223E9, "serviceAccountRoleArn" : "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "tags" : { } } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteAddon) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteAddon) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteAddon) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteAddon) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteAddon) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteAddon) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteAddon) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteAddon) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteAddon) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteAddon) # DeleteCapability Deletes a managed capability from your Amazon EKS cluster. When you delete a capability, Amazon EKS removes the capability infrastructure but retains all resources that were managed by the capability. Before deleting a capability, you should delete all Kubernetes resources that were created by the capability. After the capability is deleted, these resources become difficult to manage because the controller that managed them is no longer available. To delete resources before removing the capability, use `kubectl delete` or remove them through your GitOps workflow. ## Request Syntax ``` DELETE /clusters/name/capabilities/capabilityName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [capabilityName](#API_DeleteCapability_RequestSyntax) ** The name of the capability to delete. Required: Yes ** [name](#API_DeleteCapability_RequestSyntax) ** The name of the Amazon EKS cluster that contains the capability you want to delete. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "capability": { "arn": "string", "capabilityName": "string", "clusterName": "string", "configuration": { "argoCd": { "awsIdc": { "idcInstanceArn": "string", "idcManagedApplicationArn": "string", "idcRegion": "string" }, "namespace": "string", "networkAccess": { "vpceIds": [ "string" ] }, "rbacRoleMappings": [ { "identities": [ { "id": "string", "type": "string" } ], "role": "string" } ], "serverUrl": "string" } }, "createdAt": number, "deletePropagationPolicy": "string", "health": { "issues": [ { "code": "string", "message": "string" } ] }, "modifiedAt": number, "roleArn": "string", "status": "string", "tags": { "string" : "string" }, "type": "string", "version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [capability](#API_DeleteCapability_ResponseSyntax) ** An object containing information about the deleted capability, including its final status and configuration. Type: [Capability](API_Capability.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. ** message ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteCapability) # DeleteCluster Deletes 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 must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see [Deleting a cluster](https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html) in the *Amazon EKS User Guide*. If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see `DeleteNodgroup` and `DeleteFargateProfile`. ## Request Syntax ``` DELETE /clusters/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteCluster_RequestSyntax) ** The name of the cluster to delete. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "accessConfig": { "authenticationMode": "string", "bootstrapClusterCreatorAdminPermissions": boolean }, "arn": "string", "certificateAuthority": { "data": "string" }, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "connectorConfig": { "activationCode": "string", "activationExpiry": number, "activationId": "string", "provider": "string", "roleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "createdAt": number, "deletionProtection": boolean, "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ], "endpoint": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "id": "string", "identity": { "oidc": { "issuer": "string" } }, "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string", "serviceIpv6Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "name": "string", "outpostConfig": { "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string" }, "outpostArns": [ "string" ] }, "platformVersion": "string", "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "clusterSecurityGroupId": "string", "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" }, "roleArn": "string", "status": "string", "storageConfig": { "blockStorage": { "enabled": boolean } }, "tags": { "string" : "string" }, "upgradePolicy": { "supportType": "string" }, "version": "string", "zonalShiftConfig": { "enabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [cluster](#API_DeleteCluster_ResponseSyntax) ** The full description of the cluster to delete. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example deletes a cluster called `my-cluster`. #### Sample Request ``` DELETE /clusters/my-cluster HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.15.0 Python/3.6.5 Darwin/16.7.0 botocore/1.10.0 X-Amz-Date: 20180531T231840Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Thu, 31 May 2018 23:18:41 GMT Content-Type: application/json Content-Length: 1895 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: HxlgjH_rPHcF7ag= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "cluster": { "name": "dev", "arn": "arn:aws:eks:us-west-2:012345678910:cluster/my-cluster", "createdAt": 1573244832.203, "version": "1.14", "endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", "roleArn": "arn:aws:iam::012345678910:role/eksClusterRole", "resourcesVpcConfig": { "subnetIds": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz" ], "securityGroupIds": [ "sg-xxxxxxxxxxxxxxxxx" ], "clusterSecurityGroupId": "sg-yyyyyyyyyyyyyyyyy", "vpcId": "vpc-xxxxxxxxxxxxxxxxx", "endpointPublicAccess": true, "endpointPrivateAccess": false }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": false } ] }, "identity": { "oidc": { "issuer": "https://oidc.eks.us-west-2.amazonaws.com/id/XXXXXXXXXXXXX097E4AC3A07B6B79B9C" } }, "status": "DELETING", "certificateAuthority": { "data": "HERE_BE_SOME_CERT_DATA===" }, "platformVersion": "eks.3", "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteCluster) # DeleteEksAnywhereSubscription Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the AWS 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 AWS Support Center. ## Request Syntax ``` DELETE /eks-anywhere-subscriptions/id HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [id](#API_DeleteEksAnywhereSubscription_RequestSyntax) ** The ID of the subscription. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "subscription": { "arn": "string", "autoRenew": boolean, "createdAt": number, "effectiveDate": number, "expirationDate": number, "id": "string", "licenseArns": [ "string" ], "licenseQuantity": number, "licenses": [ { "id": "string", "token": "string" } ], "licenseType": "string", "status": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [subscription](#API_DeleteEksAnywhereSubscription_ResponseSyntax) ** The full description of the subscription to be deleted. Type: [EksAnywhereSubscription](API_EksAnywhereSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteEksAnywhereSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteEksAnywhereSubscription) # DeleteFargateProfile Deletes an AWS 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 another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and may remain in a pending state. Only one Fargate profile in a cluster can be in the `DELETING` status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster. ## Request Syntax ``` DELETE /clusters/name/fargate-profiles/fargateProfileName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteFargateProfile_RequestSyntax) ** The name of your cluster. Required: Yes ** [fargateProfileName](#API_DeleteFargateProfile_RequestSyntax) ** The name of the Fargate profile to delete. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "fargateProfile": { "clusterName": "string", "createdAt": number, "fargateProfileArn": "string", "fargateProfileName": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "podExecutionRoleArn": "string", "selectors": [ { "labels": { "string" : "string" }, "namespace": "string" } ], "status": "string", "subnets": [ "string" ], "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [fargateProfile](#API_DeleteFargateProfile_ResponseSyntax) ** The deleted Fargate profile. Type: [FargateProfile](API_FargateProfile.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example deletes a Fargate profile called `compute-label` in the `fargate` cluster. #### Sample Request ``` DELETE /clusters/fargate/fargate-profiles/compute-label HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.284 Python/3.7.5 Darwin/18.7.0 botocore/1.13.20 X-Amz-Date: 20191120T203729Z Authorization: AUTHPARAMS Content-Length: 0 ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 20 Nov 2019 20:37:30 GMT Content-Type: application/json Content-Length: 610 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DeaRjFWPvHcFcXw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "fargateProfile": { "fargateProfileName": "compute-label", "fargateProfileArn": "arn:aws:eks:us-west-2:012345678910:fargateprofile/fargate/compute-label/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clusterName": "fargate", "createdAt": 1574206849.791, "podExecutionRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSPodExecutionRole", "subnets": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy" ], "selectors": [ { "namespace": "kube-system", "labels": { "compute": "fargate" } } ], "status": "DELETING", "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteFargateProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteFargateProfile) # DeleteNodegroup Deletes a managed node group. ## Request Syntax ``` DELETE /clusters/name/node-groups/nodegroupName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeleteNodegroup_RequestSyntax) ** The name of your cluster. Required: Yes ** [nodegroupName](#API_DeleteNodegroup_RequestSyntax) ** The name of the node group to delete. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nodegroup": { "amiType": "string", "capacityType": "string", "clusterName": "string", "createdAt": number, "diskSize": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "instanceTypes": [ "string" ], "labels": { "string" : "string" }, "launchTemplate": { "id": "string", "name": "string", "version": "string" }, "modifiedAt": number, "nodegroupArn": "string", "nodegroupName": "string", "nodeRepairConfig": { "enabled": boolean, "maxParallelNodesRepairedCount": number, "maxParallelNodesRepairedPercentage": number, "maxUnhealthyNodeThresholdCount": number, "maxUnhealthyNodeThresholdPercentage": number, "nodeRepairConfigOverrides": [ { "minRepairWaitTimeMins": number, "nodeMonitoringCondition": "string", "nodeUnhealthyReason": "string", "repairAction": "string" } ] }, "nodeRole": "string", "releaseVersion": "string", "remoteAccess": { "ec2SshKey": "string", "sourceSecurityGroups": [ "string" ] }, "resources": { "autoScalingGroups": [ { "name": "string" } ], "remoteAccessSecurityGroup": "string" }, "scalingConfig": { "desiredSize": number, "maxSize": number, "minSize": number }, "status": "string", "subnets": [ "string" ], "tags": { "string" : "string" }, "taints": [ { "effect": "string", "key": "string", "value": "string" } ], "updateConfig": { "maxUnavailable": number, "maxUnavailablePercentage": number, "updateStrategy": "string" }, "version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nodegroup](#API_DeleteNodegroup_ResponseSyntax) ** The full description of your deleted node group. Type: [Nodegroup](API_Nodegroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example This example deletes a managed node group called `standard` in the `my-cluster` cluster. #### Sample Request ``` DELETE /clusters/my-cluster/node-groups/standard HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11 X-Amz-Date: 20191111T202821Z Authorization: AUTHPARAMS Content-Length: 0 ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Mon, 11 Nov 2019 20:28:22 GMT Content-Type: application/json Content-Length: 1121 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAuf9GbEPHcFxNw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "nodegroup" : { "nodegroupName" : "standard", "nodegroupArn" : "arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/standard/xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxxx", "clusterName" : "my-cluster", "version" : "1.14", "releaseVersion" : "1.14.7-20190927", "createdAt" : 1.573496875151E9, "modifiedAt" : 1.573504102097E9, "status" : "DELETING", "scalingConfig" : { "minSize" : 2, "maxSize" : 6, "desiredSize" : 4 }, "instanceTypes" : [ "t3.medium" ], "subnets" : [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz" ], "remoteAccess" : { "ec2SshKey" : "id_rsa", "sourceSecurityGroups" : null }, "amiType" : "AL2_x86_64", "nodeRole" : "arn:aws:iam::012345678910:role/managed-NodeInstanceRole-1V94UAUPQY7GS", "labels" : { }, "resources" : { "autoScalingGroups" : [ { "name" : "eks-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "remoteAccessSecurityGroup" : "sg-xxxxxxxxxxxxxxxxx" }, "diskSize" : 20, "health" : { "issues" : [ ] }, "tags" : { } } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeleteNodegroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeleteNodegroup) # DeletePodIdentityAssociation Deletes a EKS Pod Identity association. The temporary AWS credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console. ## Request Syntax ``` DELETE /clusters/name/pod-identity-associations/associationId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [associationId](#API_DeletePodIdentityAssociation_RequestSyntax) ** The ID of the association to be deleted. Required: Yes ** [name](#API_DeletePodIdentityAssociation_RequestSyntax) ** The cluster name that Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "association": { "associationArn": "string", "associationId": "string", "clusterName": "string", "createdAt": number, "disableSessionTags": boolean, "externalId": "string", "modifiedAt": number, "namespace": "string", "ownerArn": "string", "policy": "string", "roleArn": "string", "serviceAccount": "string", "tags": { "string" : "string" }, "targetRoleArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [association](#API_DeletePodIdentityAssociation_ResponseSyntax) ** The full description of the EKS Pod Identity association that was deleted. Type: [PodIdentityAssociation](API_PodIdentityAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeletePodIdentityAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeletePodIdentityAssociation) # DeregisterCluster Deregisters 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 control plane using the [Amazon EKS Connector](https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html). ## Request Syntax ``` DELETE /cluster-registrations/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DeregisterCluster_RequestSyntax) ** The name of the connected cluster to deregister. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "accessConfig": { "authenticationMode": "string", "bootstrapClusterCreatorAdminPermissions": boolean }, "arn": "string", "certificateAuthority": { "data": "string" }, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "connectorConfig": { "activationCode": "string", "activationExpiry": number, "activationId": "string", "provider": "string", "roleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "createdAt": number, "deletionProtection": boolean, "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ], "endpoint": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "id": "string", "identity": { "oidc": { "issuer": "string" } }, "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string", "serviceIpv6Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "name": "string", "outpostConfig": { "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string" }, "outpostArns": [ "string" ] }, "platformVersion": "string", "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "clusterSecurityGroupId": "string", "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" }, "roleArn": "string", "status": "string", "storageConfig": { "blockStorage": { "enabled": boolean } }, "tags": { "string" : "string" }, "upgradePolicy": { "supportType": "string" }, "version": "string", "zonalShiftConfig": { "enabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [cluster](#API_DeregisterCluster_ResponseSyntax) ** An object representing an Amazon EKS cluster. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. ** message ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DeregisterCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DeregisterCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DeregisterCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DeregisterCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DeregisterCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DeregisterCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DeregisterCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DeregisterCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DeregisterCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DeregisterCluster) # DescribeAccessEntry Describes an access entry. ## Request Syntax ``` GET /clusters/name/access-entries/principalArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeAccessEntry_RequestSyntax) ** The name of your cluster. Required: Yes ** [principalArn](#API_DescribeAccessEntry_RequestSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "accessEntry": { "accessEntryArn": "string", "clusterName": "string", "createdAt": number, "kubernetesGroups": [ "string" ], "modifiedAt": number, "principalArn": "string", "tags": { "string" : "string" }, "type": "string", "username": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [accessEntry](#API_DescribeAccessEntry_ResponseSyntax) ** Information about the access entry. Type: [AccessEntry](API_AccessEntry.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example describes an access entry for an IAM role with the name `my-role`. #### Sample Request ``` GET /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.describe-access-entry X-Amz-Date: 20230530T195959Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 30 May 2023 20:00:14 GMT Content-Type: application/json Content-Length: 485 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: FwJV-FPGvHcFzPg= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "accessEntry" : { "clusterName" : "my-cluster", "principalArn" : "arn:aws:iam::012345678910:role/my-role", "kubernetesGroups" : [ ], "accessEntryArn" : "arn:aws:eks:us-west-2:012345678910:accessEntry/my-cluster/role/012345678910/my-role/xxx11111-xx1x-xx11-1x11-xxx111x111x1", "createdAt" : 1.685475163532E9, "modifiedAt" : 1.685475163532E9, "tags" : { }, "username" : "arn:aws:sts::012345678910:assumed-role/my-role/{{SessionName}}", "type" : "STANDARD" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeAccessEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeAccessEntry) # DescribeAddon Describes an Amazon EKS add-on. ## Request Syntax ``` GET /clusters/name/addons/addonName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_DescribeAddon_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). Required: Yes ** [name](#API_DescribeAddon_RequestSyntax) ** The name of your cluster. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "addon": { "addonArn": "string", "addonName": "string", "addonVersion": "string", "clusterName": "string", "configurationValues": "string", "createdAt": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "marketplaceInformation": { "productId": "string", "productUrl": "string" }, "modifiedAt": number, "namespaceConfig": { "namespace": "string" }, "owner": "string", "podIdentityAssociations": [ "string" ], "publisher": "string", "serviceAccountRoleArn": "string", "status": "string", "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [addon](#API_DescribeAddon_ResponseSyntax) ** An Amazon EKS add-on. For more information, see [Amazon EKS add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) in the *Amazon EKS User Guide*. Type: [Addon](API_Addon.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example describes an add-on named `vpc-cni`. #### Sample Request ``` GET /clusters/1-18/addons/vpc-cni HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T144831Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:48:32 GMT Content-Type: application/json Content-Length: 472 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkY-BEEPPHcFwEg= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "addon" : { "addonName" : "vpc-cni", "clusterName" : "1-18", "status" : "ACTIVE", "addonVersion" : "v1.7.5-eksbuild.1", "health" : { "issues" : [ ] }, "addonArn" : "arn:aws:eks:us-west-2:012345678910:addon/my-cluster/vpc-cni/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "createdAt" : 1.606315184255E9, "modifiedAt" : 1.606315202754E9, "serviceAccountRoleArn" : "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "tags" : { } } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeAddon) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeAddon) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeAddon) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeAddon) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeAddon) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeAddon) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeAddon) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeAddon) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeAddon) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeAddon) # DescribeAddonConfiguration Returns configuration options. ## Request Syntax ``` GET /addons/configuration-schemas?addonName=addonName&addonVersion=addonVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_DescribeAddonConfiguration_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by `DescribeAddonVersions`. Required: Yes ** [addonVersion](#API_DescribeAddonConfiguration_RequestSyntax) ** The version of the add-on. The version must match one of the versions returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "addonName": "string", "addonVersion": "string", "configurationSchema": "string", "podIdentityConfiguration": [ { "recommendedManagedPolicies": [ "string" ], "serviceAccount": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [addonName](#API_DescribeAddonConfiguration_ResponseSyntax) ** The name of the add-on. Type: String ** [addonVersion](#API_DescribeAddonConfiguration_ResponseSyntax) ** The version of the add-on. The version must match one of the versions returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). Type: String ** [configurationSchema](#API_DescribeAddonConfiguration_ResponseSyntax) ** A JSON schema that's used to validate the configuration values you provide when an add-on is created or updated. Type: String ** [podIdentityConfiguration](#API_DescribeAddonConfiguration_ResponseSyntax) ** The Kubernetes service account name used by the add-on, and any suggested IAM policies. Use this information to create an IAM Role for the add-on. Type: Array of [AddonPodIdentityConfiguration](API_AddonPodIdentityConfiguration.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeAddonConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeAddonConfiguration) # DescribeAddonVersions 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 the add-on are returned. ## Request Syntax ``` GET /addons/supported-versions?addonName=addonName&kubernetesVersion=kubernetesVersion&maxResults=maxResults&nextToken=nextToken&owners=owners&publishers=publishers&types=types HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_DescribeAddonVersions_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). ** [kubernetesVersion](#API_DescribeAddonVersions_RequestSyntax) ** The Kubernetes versions that you can use the add-on with. ** [maxResults](#API_DescribeAddonVersions_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_DescribeAddonVersions_RequestSyntax) ** 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. ** [owners](#API_DescribeAddonVersions_RequestSyntax) ** The owner of the add-on. For valid `owners`, don't specify a value for this property. ** [publishers](#API_DescribeAddonVersions_RequestSyntax) ** The publisher of the add-on. For valid `publishers`, don't specify a value for this property. ** [types](#API_DescribeAddonVersions_RequestSyntax) ** The type of the add-on. For valid `types`, don't specify a value for this property. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "addons": [ { "addonName": "string", "addonVersions": [ { "addonVersion": "string", "architecture": [ "string" ], "compatibilities": [ { "clusterVersion": "string", "defaultVersion": boolean, "platformVersions": [ "string" ] } ], "computeTypes": [ "string" ], "requiresConfiguration": boolean, "requiresIamPermissions": boolean } ], "defaultNamespace": "string", "marketplaceInformation": { "productId": "string", "productUrl": "string" }, "owner": "string", "publisher": "string", "type": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [addons](#API_DescribeAddonVersions_ResponseSyntax) ** The list of available versions with Kubernetes version compatibility and other properties. Type: Array of [AddonInfo](API_AddonInfo.md) objects ** [nextToken](#API_DescribeAddonVersions_ResponseSyntax) ** The `nextToken` value to include in a future `DescribeAddonVersions` request. When the results of a `DescribeAddonVersions` 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. 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example describes the add-on versions available for an add-on named `vpc-cni`. #### Sample Request ``` GET /addons/supported-versions?addonName=vpc-cni HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T143627Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:36:27 GMT Content-Type: application/json Content-Length: 418 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkXM1FDXvHcFaHg= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "addons": [{ "addonName": "vpc-cni", "type": "networking", "addonVersions": [{ "addonVersion": "v1.7.5-eksbuild.1", "architecture": ["amd64", "arm64"], "compatibilities": [{ "clusterVersion": "1.18", "platformVersions": ["*"], "defaultVersion": true }] }, { "addonVersion": "v1.6.3-eksbuild.1", "architecture": ["amd64", "arm64"], "compatibilities": [{ "clusterVersion": "1.18", "platformVersions": ["*"], "defaultVersion": false }] }] }], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeAddonVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeAddonVersions) # DescribeCapability Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation. ## Request Syntax ``` GET /clusters/name/capabilities/capabilityName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [capabilityName](#API_DescribeCapability_RequestSyntax) ** The name of the capability to describe. Required: Yes ** [name](#API_DescribeCapability_RequestSyntax) ** The name of the Amazon EKS cluster that contains the capability you want to describe. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "capability": { "arn": "string", "capabilityName": "string", "clusterName": "string", "configuration": { "argoCd": { "awsIdc": { "idcInstanceArn": "string", "idcManagedApplicationArn": "string", "idcRegion": "string" }, "namespace": "string", "networkAccess": { "vpceIds": [ "string" ] }, "rbacRoleMappings": [ { "identities": [ { "id": "string", "type": "string" } ], "role": "string" } ], "serverUrl": "string" } }, "createdAt": number, "deletePropagationPolicy": "string", "health": { "issues": [ { "code": "string", "message": "string" } ] }, "modifiedAt": number, "roleArn": "string", "status": "string", "tags": { "string" : "string" }, "type": "string", "version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [capability](#API_DescribeCapability_ResponseSyntax) ** An object containing detailed information about the capability, including its name, ARN, type, status, version, configuration, health status, and timestamps for when it was created and last modified. Type: [Capability](API_Capability.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. ** message ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeCapability) # DescribeCluster Describes an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for `kubelet` and `kubectl` to communicate with your Kubernetes API server. For more information, see [Creating or updating a `kubeconfig` file for an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html). **Note** The API server endpoint and certificate authority data aren't available until the cluster reaches the `ACTIVE` state. ## Request Syntax ``` GET /clusters/name HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeCluster_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "accessConfig": { "authenticationMode": "string", "bootstrapClusterCreatorAdminPermissions": boolean }, "arn": "string", "certificateAuthority": { "data": "string" }, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "connectorConfig": { "activationCode": "string", "activationExpiry": number, "activationId": "string", "provider": "string", "roleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "createdAt": number, "deletionProtection": boolean, "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ], "endpoint": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "id": "string", "identity": { "oidc": { "issuer": "string" } }, "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string", "serviceIpv6Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "name": "string", "outpostConfig": { "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string" }, "outpostArns": [ "string" ] }, "platformVersion": "string", "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "clusterSecurityGroupId": "string", "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" }, "roleArn": "string", "status": "string", "storageConfig": { "blockStorage": { "enabled": boolean } }, "tags": { "string" : "string" }, "upgradePolicy": { "supportType": "string" }, "version": "string", "zonalShiftConfig": { "enabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [cluster](#API_DescribeCluster_ResponseSyntax) ** The full description of your specified cluster. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example describes a cluster named `my-cluster`. #### Sample Request ``` GET /clusters/my-cluster HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.120 Python/3.7.0 Darwin/18.2.0 botocore/1.12.110 X-Amz-Date: 20190322T161109Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Fri, 22 Mar 2019 16:11:07 GMT Content-Type: application/json Content-Length: 682 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: W85cPGkVvHcFa4g= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "cluster": { "name": "my-cluster", "arn": "arn:aws:eks:us-west-2:012345678910:cluster/my-cluster", "createdAt": 1553270518.433, "version": "1.11", "endpoint": null, "roleArn": "arn:aws:iam::012345678910:role/eksClusterRole", "resourcesVpcConfig": { "subnetIds": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz" ], "securityGroupIds": [ "sg-xxxxxxxxxxxxxxxxx" ], "vpcId": "vpc-xxxxxxxxxxxxxxxxx", "endpointPublicAccess": true, "endpointPrivateAccess": true }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": false } ] }, "identity": { "oidc": { "issuer": null } }, "status": "CREATING", "certificateAuthority": { "data": null }, "clientRequestToken": null, "platformVersion": "eks.2" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeCluster) # DescribeClusterVersions Lists available Kubernetes versions for Amazon EKS clusters. ## Request Syntax ``` GET /cluster-versions?clusterType=clusterType&clusterVersions=clusterVersions&defaultOnly=defaultOnly&includeAll=includeAll&maxResults=maxResults&nextToken=nextToken&status=status&versionStatus=versionStatus HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [clusterType](#API_DescribeClusterVersions_RequestSyntax) ** The type of cluster to filter versions by. ** [clusterVersions](#API_DescribeClusterVersions_RequestSyntax) ** List of specific cluster versions to describe. ** [defaultOnly](#API_DescribeClusterVersions_RequestSyntax) ** Filter to show only default versions. ** [includeAll](#API_DescribeClusterVersions_RequestSyntax) ** Include all available versions in the response. ** [maxResults](#API_DescribeClusterVersions_RequestSyntax) ** Maximum number of results to return. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_DescribeClusterVersions_RequestSyntax) ** Pagination token for the next set of results. ** [status](#API_DescribeClusterVersions_RequestSyntax) ** This field is deprecated. Use `versionStatus` instead, as that field matches for input and output of this action. Filter versions by their current status. Valid Values: `unsupported | standard-support | extended-support` ** [versionStatus](#API_DescribeClusterVersions_RequestSyntax) ** Filter versions by their current status. Valid Values: `UNSUPPORTED | STANDARD_SUPPORT | EXTENDED_SUPPORT` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "clusterVersions": [ { "clusterType": "string", "clusterVersion": "string", "defaultPlatformVersion": "string", "defaultVersion": boolean, "endOfExtendedSupportDate": number, "endOfStandardSupportDate": number, "kubernetesPatchVersion": "string", "releaseDate": number, "status": "string", "versionStatus": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [clusterVersions](#API_DescribeClusterVersions_ResponseSyntax) ** List of cluster version information objects. Type: Array of [ClusterVersionInformation](API_ClusterVersionInformation.md) objects ** [nextToken](#API_DescribeClusterVersions_ResponseSyntax) ** Pagination token for the next set of results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeClusterVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeClusterVersions) # DescribeEksAnywhereSubscription Returns descriptive information about a subscription. ## Request Syntax ``` GET /eks-anywhere-subscriptions/id HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [id](#API_DescribeEksAnywhereSubscription_RequestSyntax) ** The ID of the subscription. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "subscription": { "arn": "string", "autoRenew": boolean, "createdAt": number, "effectiveDate": number, "expirationDate": number, "id": "string", "licenseArns": [ "string" ], "licenseQuantity": number, "licenses": [ { "id": "string", "token": "string" } ], "licenseType": "string", "status": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [subscription](#API_DescribeEksAnywhereSubscription_ResponseSyntax) ** The full description of the subscription. Type: [EksAnywhereSubscription](API_EksAnywhereSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeEksAnywhereSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeEksAnywhereSubscription) # DescribeFargateProfile Describes an AWS Fargate profile. ## Request Syntax ``` GET /clusters/name/fargate-profiles/fargateProfileName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeFargateProfile_RequestSyntax) ** The name of your cluster. Required: Yes ** [fargateProfileName](#API_DescribeFargateProfile_RequestSyntax) ** The name of the Fargate profile to describe. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "fargateProfile": { "clusterName": "string", "createdAt": number, "fargateProfileArn": "string", "fargateProfileName": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "podExecutionRoleArn": "string", "selectors": [ { "labels": { "string" : "string" }, "namespace": "string" } ], "status": "string", "subnets": [ "string" ], "tags": { "string" : "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [fargateProfile](#API_DescribeFargateProfile_ResponseSyntax) ** The full description of your Fargate profile. Type: [FargateProfile](API_FargateProfile.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example describes a Fargate profile named `default-with-infrastructure-label` in the `my-cluster` cluster. #### Sample Request ``` GET /clusters/my-cluster/fargate-profiles/default-with-infrastructure-label HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.284 Python/3.7.5 Darwin/18.7.0 botocore/1.13.20 X-Amz-Date: 20191120T204303Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 20 Nov 2019 20:43:04 GMT Content-Type: application/json Content-Length: 651 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DebFwF0YPHcFkog= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "fargateProfile": { "fargateProfileName": "default-with-infrastructure-label", "fargateProfileArn": "arn:aws:eks:us-west-2:012345678910:fargateprofile/my-cluster/default-with-infrastructure-label/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clusterName": "fargate", "createdAt": 1574281537.866, "podExecutionRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSFargatePodExecutionRole", "subnets": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy" ], "selectors": [ { "namespace": "default", "labels": { "infrastructure": "fargate" } } ], "status": "ACTIVE", "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeFargateProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeFargateProfile) # DescribeIdentityProviderConfig Describes an identity provider configuration. ## Request Syntax ``` POST /clusters/name/identity-provider-configs/describe HTTP/1.1 Content-type: application/json { "identityProviderConfig": { "name": "string", "type": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeIdentityProviderConfig_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [identityProviderConfig](#API_DescribeIdentityProviderConfig_RequestSyntax) ** An object representing an identity provider configuration. Type: [IdentityProviderConfig](API_IdentityProviderConfig.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "identityProviderConfig": { "oidc": { "clientId": "string", "clusterName": "string", "groupsClaim": "string", "groupsPrefix": "string", "identityProviderConfigArn": "string", "identityProviderConfigName": "string", "issuerUrl": "string", "requiredClaims": { "string" : "string" }, "status": "string", "tags": { "string" : "string" }, "usernameClaim": "string", "usernamePrefix": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [identityProviderConfig](#API_DescribeIdentityProviderConfig_ResponseSyntax) ** The object that represents an OpenID Connect (OIDC) identity provider configuration. Type: [IdentityProviderConfigResponse](API_IdentityProviderConfigResponse.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeIdentityProviderConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeIdentityProviderConfig) # DescribeInsight Returns details about an insight that you specify using its ID. ## Request Syntax ``` GET /clusters/name/insights/id HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeInsight_RequestSyntax) ** The name of the cluster to describe the insight for. Required: Yes ** [id](#API_DescribeInsight_RequestSyntax) ** The identity of the insight to describe. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "insight": { "additionalInfo": { "string" : "string" }, "category": "string", "categorySpecificSummary": { "addonCompatibilityDetails": [ { "compatibleVersions": [ "string" ], "name": "string" } ], "deprecationDetails": [ { "clientStats": [ { "lastRequestTime": number, "numberOfRequestsLast30Days": number, "userAgent": "string" } ], "replacedWith": "string", "startServingReplacementVersion": "string", "stopServingVersion": "string", "usage": "string" } ] }, "description": "string", "id": "string", "insightStatus": { "reason": "string", "status": "string" }, "kubernetesVersion": "string", "lastRefreshTime": number, "lastTransitionTime": number, "name": "string", "recommendation": "string", "resources": [ { "arn": "string", "insightStatus": { "reason": "string", "status": "string" }, "kubernetesResourceUri": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [insight](#API_DescribeInsight_ResponseSyntax) ** The full description of the insight. Type: [Insight](API_Insight.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeInsight) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeInsight) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeInsight) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeInsight) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeInsight) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeInsight) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeInsight) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeInsight) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeInsight) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeInsight) # DescribeInsightsRefresh Returns the status of the latest on-demand cluster insights refresh operation. ## Request Syntax ``` GET /clusters/name/insights-refresh HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeInsightsRefresh_RequestSyntax) ** The name of the cluster associated with the insights refresh operation. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "endedAt": number, "message": "string", "startedAt": number, "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [endedAt](#API_DescribeInsightsRefresh_ResponseSyntax) ** The date and time when the insights refresh operation ended. Type: Timestamp ** [message](#API_DescribeInsightsRefresh_ResponseSyntax) ** The message associated with the insights refresh operation. Type: String ** [startedAt](#API_DescribeInsightsRefresh_ResponseSyntax) ** The date and time when the insights refresh operation started. Type: Timestamp ** [status](#API_DescribeInsightsRefresh_ResponseSyntax) ** The current status of the insights refresh operation. Type: String Valid Values: `IN_PROGRESS | FAILED | COMPLETED` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples ### Example of refresh in progress The following example shows when the cluster insights refresh workflow is in progress. #### Sample Request ``` GET /clusters/name/insights-refresh HTTP/1.1 ``` #### Sample Response ``` HTTP/1.1 200 Content-type: application/json { "message": "Cluster insights refresh is in progress.", "status": "IN_PROGRESS", "startedAt": "2025-08-19T13:45:11-07:00" } ``` ### Example of refresh completion The following example shows when the cluster insights refresh workflow completed successfully. #### Sample Request ``` GET /clusters/name/insights-refresh HTTP/1.1 ``` #### Sample Response ``` HTTP/1.1 200 Content-type: application/json { "message": "Cluster insights refresh has completed successfully.", "status": "COMPLETED", "startedAt": "2025-08-19T13:45:11-07:00", "endedAt": "2025-08-19T13:45:50-07:00" } ``` ### Example of refresh error The following example shows when the cluster insights refresh workflow encountered an error. #### Sample Request ``` GET /clusters/name/insights-refresh HTTP/1.1 ``` #### Sample Response ``` HTTP/1.1 200 Content-type: application/json { "message": "The latest cluster insights refresh encountered an error. Try StartInsightsRefresh again.", "status": "FAILED", "startedAt": "2025-08-19T13:45:11-07:00", "endedAt": "2025-08-19T13:45:50-07:00" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeInsightsRefresh) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeInsightsRefresh) # DescribeNodegroup Describes a managed node group. ## Request Syntax ``` GET /clusters/name/node-groups/nodegroupName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DescribeNodegroup_RequestSyntax) ** The name of your cluster. Required: Yes ** [nodegroupName](#API_DescribeNodegroup_RequestSyntax) ** The name of the node group to describe. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nodegroup": { "amiType": "string", "capacityType": "string", "clusterName": "string", "createdAt": number, "diskSize": number, "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "instanceTypes": [ "string" ], "labels": { "string" : "string" }, "launchTemplate": { "id": "string", "name": "string", "version": "string" }, "modifiedAt": number, "nodegroupArn": "string", "nodegroupName": "string", "nodeRepairConfig": { "enabled": boolean, "maxParallelNodesRepairedCount": number, "maxParallelNodesRepairedPercentage": number, "maxUnhealthyNodeThresholdCount": number, "maxUnhealthyNodeThresholdPercentage": number, "nodeRepairConfigOverrides": [ { "minRepairWaitTimeMins": number, "nodeMonitoringCondition": "string", "nodeUnhealthyReason": "string", "repairAction": "string" } ] }, "nodeRole": "string", "releaseVersion": "string", "remoteAccess": { "ec2SshKey": "string", "sourceSecurityGroups": [ "string" ] }, "resources": { "autoScalingGroups": [ { "name": "string" } ], "remoteAccessSecurityGroup": "string" }, "scalingConfig": { "desiredSize": number, "maxSize": number, "minSize": number }, "status": "string", "subnets": [ "string" ], "tags": { "string" : "string" }, "taints": [ { "effect": "string", "key": "string", "value": "string" } ], "updateConfig": { "maxUnavailable": number, "maxUnavailablePercentage": number, "updateStrategy": "string" }, "version": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nodegroup](#API_DescribeNodegroup_ResponseSyntax) ** The full description of your node group. Type: [Nodegroup](API_Nodegroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example This example describes a managed node group called `standard` in the `my-cluster` cluster. #### Sample Request ``` GET /clusters/my-cluster/node-groups/standard HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11 X-Amz-Date: 20191111T183235Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Mon, 11 Nov 2019 18:32:35 GMT Content-Type: application/json Content-Length: 1119 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAdikHT3vHcFz3w= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "nodegroup": { "nodegroupName": "standard", "nodegroupArn": "arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/standard/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clusterName": "my-cluster", "version": "1.14", "releaseVersion": "1.14.7-20190927", "createdAt": 1573496875.151, "modifiedAt": 1573496979.583, "status": "ACTIVE", "scalingConfig": { "minSize": 1, "maxSize": 3, "desiredSize": 2 }, "instanceTypes": [ "t3.medium" ], "subnets": [ "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz" ], "remoteAccess": { "ec2SshKey": "id_rsa", "sourceSecurityGroups": null }, "amiType": "AL2_x86_64", "nodeRole": "arn:aws:iam::012345678910:role/managed-NodeInstanceRole-1V94UAUPQY7GS", "labels": {}, "resources": { "autoScalingGroups": [ { "name": "eks-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "remoteAccessSecurityGroup": "sg-xxxxxxxxxxxxxxxxx" }, "diskSize": 20, "health": { "issues": [] }, "tags": {} } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeNodegroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeNodegroup) # DescribePodIdentityAssociation Returns 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 the `CreatePodIdentityAssocation` for newly created associations. Or, you can list the IDs for associations with `ListPodIdentityAssociations` and filter the list by namespace or service account. ## Request Syntax ``` GET /clusters/name/pod-identity-associations/associationId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [associationId](#API_DescribePodIdentityAssociation_RequestSyntax) ** The ID of the association that you want the description of. Required: Yes ** [name](#API_DescribePodIdentityAssociation_RequestSyntax) ** The name of the cluster that the association is in. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "association": { "associationArn": "string", "associationId": "string", "clusterName": "string", "createdAt": number, "disableSessionTags": boolean, "externalId": "string", "modifiedAt": number, "namespace": "string", "ownerArn": "string", "policy": "string", "roleArn": "string", "serviceAccount": "string", "tags": { "string" : "string" }, "targetRoleArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [association](#API_DescribePodIdentityAssociation_ResponseSyntax) ** The full description of the EKS Pod Identity association. Type: [PodIdentityAssociation](API_PodIdentityAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribePodIdentityAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribePodIdentityAssociation) # DescribeUpdate 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. ## Request Syntax ``` GET /clusters/name/updates/updateId?addonName=addonName&capabilityName=capabilityName&nodegroupName=nodegroupName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_DescribeUpdate_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). This parameter is required if the update is an add-on update. ** [capabilityName](#API_DescribeUpdate_RequestSyntax) ** The name of the capability for which you want to describe updates. ** [name](#API_DescribeUpdate_RequestSyntax) ** The name of the Amazon EKS cluster associated with the update. Required: Yes ** [nodegroupName](#API_DescribeUpdate_RequestSyntax) ** The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update. ** [updateId](#API_DescribeUpdate_RequestSyntax) ** The ID of the update to describe. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_DescribeUpdate_ResponseSyntax) ** The full description of the specified update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example describes an update with the ID `9f771284-9e30-4886-b5b1-3789b6bea4dc` for the `my-cluster` cluster. #### Sample Request ``` GET /clusters/my-cluster/updates/9f771284-9e30-4886-b5b1-3789b6bea4dc HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20181129T172927Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Thu, 29 Nov 2018 17:29:27 GMT Content-Type: application/json Content-Length: 228 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: RIo-oFsVvHcFXng= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "errors": [], "params": [{ "value": "1.11", "type": "Version" }, { "value": "eks.1", "type": "PlatformVersion" }], "status": "InProgress", "id": "9f771284-9e30-4886-b5b1-3789b6bea4dc", "createdAt": 1543512515.848, "type": "VersionUpdate" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DescribeUpdate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DescribeUpdate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DescribeUpdate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DescribeUpdate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DescribeUpdate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DescribeUpdate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DescribeUpdate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DescribeUpdate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DescribeUpdate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DescribeUpdate) # DisassociateAccessPolicy Disassociates an access policy from an access entry. ## Request Syntax ``` DELETE /clusters/name/access-entries/principalArn/access-policies/policyArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DisassociateAccessPolicy_RequestSyntax) ** The name of your cluster. Required: Yes ** [policyArn](#API_DisassociateAccessPolicy_RequestSyntax) ** The ARN of the policy to disassociate from the access entry. For a list of associated policies ARNs, use `ListAssociatedAccessPolicies`. Required: Yes ** [principalArn](#API_DisassociateAccessPolicy_RequestSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example disassociates the `AmazonEKSAdminPolicy` from an access entry. #### Sample Request ``` DELETE /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role/access-policies/arn%3Aaws%3Aeks%3A%3Aaws%3Acluster-access-policy%2FAmazonEKSAdminPolicy HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.disassociate-access-policy X-Amz-Date: 20230531T155944Z Authorization: AUTHPARAMS Content-Length: 0 ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 31 May 2023 16:00:00 GMT Content-Type: application/json Content-Length: 2 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: Fy5FqGDvPHcFgtw= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive {} ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DisassociateAccessPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DisassociateAccessPolicy) # DisassociateIdentityProviderConfig Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals. ## Request Syntax ``` POST /clusters/name/identity-provider-configs/disassociate HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "identityProviderConfig": { "name": "string", "type": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_DisassociateIdentityProviderConfig_RequestSyntax) ** The name of your cluster. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_DisassociateIdentityProviderConfig_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [identityProviderConfig](#API_DisassociateIdentityProviderConfig_RequestSyntax) ** An object representing an identity provider configuration. Type: [IdentityProviderConfig](API_IdentityProviderConfig.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_DisassociateIdentityProviderConfig_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ThrottlingException ** The request or operation couldn't be performed because a service is throttling requests. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 429 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example disassociates an OIDC identity provider named `my-config` from a cluster. #### Sample Request ``` POST /clusters/my-cluster/identity-provider-configs/disassociate HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201215T211826Z Authorization: AUTHPARAMS Content-Length: 127 { "identityProviderConfig": { "type": "oidc", "name": "my-config" }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 15 Dec 2020 21:18:27 GMT Content-Type: application/json Content-Length: 297 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: XnM1dE8TvHcFn8Q= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "status" : "InProgress", "type" : "DisassociateIdentityProviderConfig", "params" : [ { "type" : "IdentityProviderConfig", "value" : "[]" } ], "createdAt" : 1.60806710785E9, "errors" : [ ] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/DisassociateIdentityProviderConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/DisassociateIdentityProviderConfig) # ListAccessEntries Lists the access entries for your cluster. ## Request Syntax ``` GET /clusters/name/access-entries?associatedPolicyArn=associatedPolicyArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [associatedPolicyArn](#API_ListAccessEntries_RequestSyntax) ** The ARN of an `AccessPolicy`. When you specify an access policy ARN, only the access entries associated to that access policy are returned. For a list of available policy ARNs, use `ListAccessPolicies`. ** [name](#API_ListAccessEntries_RequestSyntax) ** The name of your cluster. Required: Yes ** [maxResults](#API_ListAccessEntries_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListAccessEntries_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "accessEntries": [ "string" ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [accessEntries](#API_ListAccessEntries_ResponseSyntax) ** The list of access entries that exist for the cluster. Type: Array of strings ** [nextToken](#API_ListAccessEntries_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists the access entries for a cluster. #### Sample Request ``` GET /clusters/my-cluster/access-entries HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.list-access-entries X-Amz-Date: 20230530T201107Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 30 May 2023 20:11:07 GMT Content-Type: application/json Content-Length: 124 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: FwK-WFHZvHcFjhA= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "accessEntries": ["arn:aws:iam::012345678910:role/my-other-role", "arn:aws:iam::012345678910:role/my-role"], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListAccessEntries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListAccessEntries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListAccessEntries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListAccessEntries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListAccessEntries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListAccessEntries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListAccessEntries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListAccessEntries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListAccessEntries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListAccessEntries) # ListAccessPolicies Lists the available access policies. ## Request Syntax ``` GET /access-policies?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAccessPolicies_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListAccessPolicies_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "accessPolicies": [ { "arn": "string", "name": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [accessPolicies](#API_ListAccessPolicies_ResponseSyntax) ** The list of available access policies. You can't view the contents of an access policy using the API. To view the contents, see [Access policy permissions](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions) in the *Amazon EKS User Guide*. Type: Array of [AccessPolicy](API_AccessPolicy.md) objects ** [nextToken](#API_ListAccessPolicies_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists the available access policies for a cluster. #### Sample Request ``` GET /access-policies HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.list-access-policies X-Amz-Date: 20230531T133734Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 31 May 2023 13:37:35 GMT Content-Type: application/json Content-Length: 543 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: FykQ6HjMvHcFbPA= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "accessPolicies": [{ "name": "AmazonEKSAdminPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminPolicy" }, { "name": "AmazonEKSClusterAdminPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSClusterAdminPolicy" }, { "name": "AmazonEKSEditPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSEditPolicy" }, { "name": "AmazonEKSViewPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy" }, { "name": "AmazonEMRJobPolicy", "arn": "arn:aws:eks::aws:cluster-access-policy/AmazonEMRJobPolicy" }], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListAccessPolicies) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListAccessPolicies) # ListAddons Lists the installed add-ons. ## Request Syntax ``` GET /clusters/name/addons?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListAddons_RequestSyntax) ** The name of your cluster. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ** [maxResults](#API_ListAddons_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListAddons_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "addons": [ "string" ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [addons](#API_ListAddons_ResponseSyntax) ** A list of installed add-ons. Type: Array of strings ** [nextToken](#API_ListAddons_ResponseSyntax) ** The `nextToken` value to include in a future `ListAddons` request. When the results of a `ListAddons` 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. 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists the add-ons installed to a cluster. #### Sample Request ``` GET /clusters/1-18/addons HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T144629Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:46:30 GMT Content-Type: application/json Content-Length: 39 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkYq8HCuvHcFU3Q= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "addons": ["vpc-cni"], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListAddons) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListAddons) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListAddons) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListAddons) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListAddons) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListAddons) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListAddons) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListAddons) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListAddons) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListAddons) # ListAssociatedAccessPolicies Lists the access policies associated with an access entry. ## Request Syntax ``` GET /clusters/name/access-entries/principalArn/access-policies?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListAssociatedAccessPolicies_RequestSyntax) ** The name of your cluster. Required: Yes ** [maxResults](#API_ListAssociatedAccessPolicies_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListAssociatedAccessPolicies_RequestSyntax) ** 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. ** [principalArn](#API_ListAssociatedAccessPolicies_RequestSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "associatedAccessPolicies": [ { "accessScope": { "namespaces": [ "string" ], "type": "string" }, "associatedAt": number, "modifiedAt": number, "policyArn": "string" } ], "clusterName": "string", "nextToken": "string", "principalArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [associatedAccessPolicies](#API_ListAssociatedAccessPolicies_ResponseSyntax) ** The list of access policies associated with the access entry. Type: Array of [AssociatedAccessPolicy](API_AssociatedAccessPolicy.md) objects ** [clusterName](#API_ListAssociatedAccessPolicies_ResponseSyntax) ** The name of your cluster. Type: String ** [nextToken](#API_ListAssociatedAccessPolicies_ResponseSyntax) ** 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. Type: String ** [principalArn](#API_ListAssociatedAccessPolicies_ResponseSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists the access policies that are associated with an access entry. #### Sample Request ``` GET /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role/access-policies HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.list-associated-access-policies X-Amz-Date: 20230531T155324Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 31 May 2023 15:53:34 GMT Content-Type: application/json Content-Length: 306 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: Fy4KSHE1vHcFWCQ= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "clusterName": "my-cluster", "principalArn": "arn:aws:iam::012345678910:role/my-role", "nextToken": null, "associatedAccessPolicies": [{ "policyArn": "arn:aws:eks::aws:cluster-access-policy/AmazonEKSAdminPolicy", "accessScope": { "type": "cluster", "namespaces": [] }, "associatedAt": 1685540747.281, "modifiedAt": 1685540747.281 }] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListAssociatedAccessPolicies) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListAssociatedAccessPolicies) # ListCapabilities Lists all managed capabilities in your Amazon EKS cluster. You can use this operation to get an overview of all capabilities and their current status. ## Request Syntax ``` GET /clusters/name/capabilities?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListCapabilities_RequestSyntax) ** The name of the Amazon EKS cluster for which you want to list capabilities. Required: Yes ** [maxResults](#API_ListCapabilities_RequestSyntax) ** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. If you don't specify a value, the default is 100 results. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListCapabilities_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "capabilities": [ { "arn": "string", "capabilityName": "string", "createdAt": number, "modifiedAt": number, "status": "string", "type": "string", "version": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [capabilities](#API_ListCapabilities_ResponseSyntax) ** A list of capability summary objects, each containing basic information about a capability including its name, ARN, type, status, version, and timestamps. Type: Array of [CapabilitySummary](API_CapabilitySummary.md) objects ** [nextToken](#API_ListCapabilities_ResponseSyntax) ** The `nextToken` value to include in a future `ListCapabilities` request. When the results of a `ListCapabilities` 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListCapabilities) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListCapabilities) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListCapabilities) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListCapabilities) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListCapabilities) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListCapabilities) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListCapabilities) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListCapabilities) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListCapabilities) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListCapabilities) # ListClusters Lists the Amazon EKS clusters in your AWS account in the specified AWS Region. ## Request Syntax ``` GET /clusters?include=include&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [include](#API_ListClusters_RequestSyntax) ** Indicates whether external clusters are included in the returned list. Use '`all`' to return [https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html](https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html)connected clusters, or blank to return only Amazon EKS clusters. '`all`' must be in lowercase otherwise an error occurs. ** [maxResults](#API_ListClusters_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListClusters_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "clusters": [ "string" ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [clusters](#API_ListClusters_ResponseSyntax) ** A list of all of the clusters for your account in the specified AWS Region . Type: Array of strings ** [nextToken](#API_ListClusters_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists all of the Amazon EKS clusters in the specified AWS Region. #### Sample Request ``` GET /clusters HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.15.0 Python/3.6.5 Darwin/16.7.0 botocore/1.10.0 X-Amz-Date: 20180531T231200Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Thu, 31 May 2018 23:12:00 GMT Content-Type: application/json Content-Length: 46 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: HxkiCF8EPHcF4nw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "clusters": [ "my-cluster", "prod" ], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListClusters) # ListEksAnywhereSubscriptions Displays the full description of the subscription. ## Request Syntax ``` GET /eks-anywhere-subscriptions?includeStatus=includeStatus&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [includeStatus](#API_ListEksAnywhereSubscriptions_RequestSyntax) ** An array of subscription statuses to filter on. Valid Values: `CREATING | ACTIVE | UPDATING | EXPIRING | EXPIRED | DELETING` ** [maxResults](#API_ListEksAnywhereSubscriptions_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListEksAnywhereSubscriptions_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "subscriptions": [ { "arn": "string", "autoRenew": boolean, "createdAt": number, "effectiveDate": number, "expirationDate": number, "id": "string", "licenseArns": [ "string" ], "licenseQuantity": number, "licenses": [ { "id": "string", "token": "string" } ], "licenseType": "string", "status": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListEksAnywhereSubscriptions_ResponseSyntax) ** 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. Type: String ** [subscriptions](#API_ListEksAnywhereSubscriptions_ResponseSyntax) ** A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults. Type: Array of [EksAnywhereSubscription](API_EksAnywhereSubscription.md) objects ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListEksAnywhereSubscriptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListEksAnywhereSubscriptions) # ListFargateProfiles Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified AWS Region. ## Request Syntax ``` GET /clusters/name/fargate-profiles?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListFargateProfiles_RequestSyntax) ** The name of your cluster. Required: Yes ** [maxResults](#API_ListFargateProfiles_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListFargateProfiles_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "fargateProfileNames": [ "string" ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [fargateProfileNames](#API_ListFargateProfiles_ResponseSyntax) ** A list of all of the Fargate profiles associated with the specified cluster. Type: Array of strings ** [nextToken](#API_ListFargateProfiles_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists the Fargate profiles in the `my-cluster` cluster. #### Sample Request ``` GET /clusters/my-cluster/fargate-profiles HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.284 Python/3.7.5 Darwin/18.7.0 botocore/1.13.20 X-Amz-Date: 20191120T210416Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 20 Nov 2019 21:04:16 GMT Content-Type: application/json Content-Length: 91 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DeeMiFxHvHcFd3g= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "fargateProfileNames": [ "default-with-infrastructure-label", "monitoring" ], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListFargateProfiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListFargateProfiles) # ListIdentityProviderConfigs Lists the identity provider configurations for your cluster. ## Request Syntax ``` GET /clusters/name/identity-provider-configs?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListIdentityProviderConfigs_RequestSyntax) ** The name of your cluster. Required: Yes ** [maxResults](#API_ListIdentityProviderConfigs_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListIdentityProviderConfigs_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "identityProviderConfigs": [ { "name": "string", "type": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [identityProviderConfigs](#API_ListIdentityProviderConfigs_ResponseSyntax) ** The identity provider configurations for the cluster. Type: Array of [IdentityProviderConfig](API_IdentityProviderConfig.md) objects ** [nextToken](#API_ListIdentityProviderConfigs_ResponseSyntax) ** The `nextToken` value to include in a future `ListIdentityProviderConfigsResponse` request. When the results of a `ListIdentityProviderConfigsResponse` 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. 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists the identity provider configs for a cluster. #### Sample Request ``` GET /clusters/my-cluster/identity-provider-configs HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201215T203618Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 15 Dec 2020 20:36:18 GMT Content-Type: application/json Content-Length: 81 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: XnGqaHs7vHcFb1g= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "identityProviderConfigs": [{ "type": "oidc", "name": "my-config" }], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListIdentityProviderConfigs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListIdentityProviderConfigs) # ListInsights Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status. The following lists the available categories: + `UPGRADE_READINESS`: Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. + `MISCONFIGURATION`: Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights. ## Request Syntax ``` POST /clusters/name/insights HTTP/1.1 Content-type: application/json { "filter": { "categories": [ "string" ], "kubernetesVersions": [ "string" ], "statuses": [ "string" ] }, "maxResults": number, "nextToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListInsights_RequestSyntax) ** The name of the Amazon EKS cluster associated with the insights. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [filter](#API_ListInsights_RequestSyntax) ** The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. Type: [InsightsFilter](API_InsightsFilter.md) object Required: No ** [maxResults](#API_ListInsights_RequestSyntax) ** The maximum number of identity provider configurations returned by `ListInsights` in paginated output. When you use this parameter, `ListInsights` 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 `ListInsights` request with the returned `nextToken` value. This value can be between 1 and 100. If you don't use this parameter, `ListInsights` returns up to 100 results and a `nextToken` value, if applicable. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [nextToken](#API_ListInsights_RequestSyntax) ** The `nextToken` value returned from a previous paginated `ListInsights` request. When the results of a `ListInsights` 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. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "insights": [ { "category": "string", "description": "string", "id": "string", "insightStatus": { "reason": "string", "status": "string" }, "kubernetesVersion": "string", "lastRefreshTime": number, "lastTransitionTime": number, "name": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [insights](#API_ListInsights_ResponseSyntax) ** The returned list of insights. Type: Array of [InsightSummary](API_InsightSummary.md) objects ** [nextToken](#API_ListInsights_ResponseSyntax) ** The `nextToken` value to include in a future `ListInsights` request. When the results of a `ListInsights` 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListInsights) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListInsights) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListInsights) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListInsights) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListInsights) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListInsights) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListInsights) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListInsights) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListInsights) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListInsights) # ListNodegroups Lists the managed node groups associated with the specified cluster in your AWS account in the specified AWS Region. Self-managed node groups aren't listed. ## Request Syntax ``` GET /clusters/name/node-groups?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListNodegroups_RequestSyntax) ** The name of your cluster. Required: Yes ** [maxResults](#API_ListNodegroups_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [nextToken](#API_ListNodegroups_RequestSyntax) ** 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. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "nodegroups": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListNodegroups_ResponseSyntax) ** 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. Type: String ** [nodegroups](#API_ListNodegroups_ResponseSyntax) ** A list of all of the node groups associated with the specified cluster. Type: Array of strings ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example This example lists all of the managed node groups that are associated with the `my-cluster` cluster. #### Sample Request ``` GET /clusters/my-cluster/node-groups HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11 X-Amz-Date: 20191111T183756Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Mon, 11 Nov 2019 18:37:56 GMT Content-Type: application/json Content-Length: 50 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAeUrHtPPHcFU_A= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "nodegroups": [ "gpu", "standard" ], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListNodegroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListNodegroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListNodegroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListNodegroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListNodegroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListNodegroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListNodegroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListNodegroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListNodegroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListNodegroups) # ListPodIdentityAssociations List 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 association uses. ## Request Syntax ``` GET /clusters/name/pod-identity-associations?maxResults=maxResults&namespace=namespace&nextToken=nextToken&serviceAccount=serviceAccount HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_ListPodIdentityAssociations_RequestSyntax) ** The name of the cluster that the associations are in. Required: Yes ** [maxResults](#API_ListPodIdentityAssociations_RequestSyntax) ** The maximum number of EKS Pod Identity association results returned by `ListPodIdentityAssociations` in paginated output. When you use this parameter, `ListPodIdentityAssociations` 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 `ListPodIdentityAssociations` request with the returned `nextToken` value. This value can be between 1 and 100. If you don't use this parameter, `ListPodIdentityAssociations` returns up to 100 results and a `nextToken` value if applicable. Valid Range: Minimum value of 1. Maximum value of 100. ** [namespace](#API_ListPodIdentityAssociations_RequestSyntax) ** The name of the Kubernetes namespace inside the cluster that the associations are in. ** [nextToken](#API_ListPodIdentityAssociations_RequestSyntax) ** The `nextToken` value returned from a previous paginated `ListUpdates` 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 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. ** [serviceAccount](#API_ListPodIdentityAssociations_RequestSyntax) ** The name of the Kubernetes service account that the associations use. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "associations": [ { "associationArn": "string", "associationId": "string", "clusterName": "string", "namespace": "string", "ownerArn": "string", "serviceAccount": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [associations](#API_ListPodIdentityAssociations_ResponseSyntax) ** The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided. Each summary is simplified by removing these fields compared to the full [https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html): + The IAM role: `roleArn` + The timestamp that the association was created at: `createdAt` + The most recent timestamp that the association was modified at:. `modifiedAt` + The tags on the association: `tags` Type: Array of [PodIdentityAssociationSummary](API_PodIdentityAssociationSummary.md) objects ** [nextToken](#API_ListPodIdentityAssociations_ResponseSyntax) ** The `nextToken` value to include in a future `ListPodIdentityAssociations` request. When the results of a `ListPodIdentityAssociations` 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. 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListPodIdentityAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListPodIdentityAssociations) # ListTagsForResource List the tags for an Amazon EKS resource. ## Request Syntax ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource to list tags for. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** The tags for the resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. ** message ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. HTTP Status Code: 400 ** NotFoundException ** A service resource associated with the request could not be found. Clients should not retry such requests. ** message ** A service resource associated with the request could not be found. Clients should not retry such requests. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListTagsForResource) # ListUpdates Lists the updates associated with an Amazon EKS resource in your AWS account, in the specified AWS Region. ## Request Syntax ``` GET /clusters/name/updates?addonName=addonName&capabilityName=capabilityName&maxResults=maxResults&nextToken=nextToken&nodegroupName=nodegroupName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_ListUpdates_RequestSyntax) ** The names of the installed add-ons that have available updates. ** [capabilityName](#API_ListUpdates_RequestSyntax) ** The name of the capability for which you want to list updates. ** [maxResults](#API_ListUpdates_RequestSyntax) ** 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. Valid Range: Minimum value of 1. Maximum value of 100. ** [name](#API_ListUpdates_RequestSyntax) ** The name of the Amazon EKS cluster to list updates for. Required: Yes ** [nextToken](#API_ListUpdates_RequestSyntax) ** 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. ** [nodegroupName](#API_ListUpdates_RequestSyntax) ** The name of the Amazon EKS managed node group to list updates for. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "updateIds": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListUpdates_ResponseSyntax) ** 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. Type: String ** [updateIds](#API_ListUpdates_ResponseSyntax) ** A list of all the updates for the specified cluster and Region. Type: Array of strings ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example lists all updates that are associated with the `my-cluster` cluster. #### Sample Request ``` GET /clusters/my-cluster/updates HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20181129T172901Z Authorization: AUTHPARAMS ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Thu, 29 Nov 2018 17:29:01 GMT Content-Type: application/json Content-Length: 71 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: RIo6pF2NPHcF5PQ= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "updateIds": ["9f771284-9e30-4886-b5b1-3789b6bea4dc"], "nextToken": null } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/ListUpdates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/ListUpdates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/ListUpdates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/ListUpdates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/ListUpdates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/ListUpdates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/ListUpdates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/ListUpdates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/ListUpdates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/ListUpdates) # RegisterCluster Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. Cluster connection requires two steps. First, send a [https://docs.aws.amazon.com/eks/latest/APIReference/API_RegisterClusterRequest.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_RegisterClusterRequest.html) to add it to the Amazon EKS control plane. Second, a [Manifest](https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml) containing the `activationID` and `activationCode` must be applied to the Kubernetes cluster through it's native provider to provide visibility. After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using `DeregisterCluster`. ## Request Syntax ``` POST /cluster-registrations HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "connectorConfig": { "provider": "string", "roleArn": "string" }, "name": "string", "tags": { "string" : "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_RegisterCluster_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [connectorConfig](#API_RegisterCluster_RequestSyntax) ** The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane. Type: [ConnectorConfigRequest](API_ConnectorConfigRequest.md) object Required: Yes ** [name](#API_RegisterCluster_RequestSyntax) ** A unique name for this cluster in your AWS Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ** [tags](#API_RegisterCluster_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "accessConfig": { "authenticationMode": "string", "bootstrapClusterCreatorAdminPermissions": boolean }, "arn": "string", "certificateAuthority": { "data": "string" }, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "connectorConfig": { "activationCode": "string", "activationExpiry": number, "activationId": "string", "provider": "string", "roleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "createdAt": number, "deletionProtection": boolean, "encryptionConfig": [ { "provider": { "keyArn": "string" }, "resources": [ "string" ] } ], "endpoint": "string", "health": { "issues": [ { "code": "string", "message": "string", "resourceIds": [ "string" ] } ] }, "id": "string", "identity": { "oidc": { "issuer": "string" } }, "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string", "serviceIpv6Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "name": "string", "outpostConfig": { "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string" }, "outpostArns": [ "string" ] }, "platformVersion": "string", "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "clusterSecurityGroupId": "string", "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" }, "roleArn": "string", "status": "string", "storageConfig": { "blockStorage": { "enabled": boolean } }, "tags": { "string" : "string" }, "upgradePolicy": { "supportType": "string" }, "version": "string", "zonalShiftConfig": { "enabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [cluster](#API_RegisterCluster_ResponseSyntax) ** An object representing an Amazon EKS cluster. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. ** message ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceLimitExceededException ** You have encountered a service limit on the specified resource. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourcePropagationDelayException ** Required resources (such as service-linked roles) were created and are still propagating. Retry later. ** message ** Required resources (such as service-linked roles) were created and are still propagating. Retry later. HTTP Status Code: 428 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. ** message ** The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example connects a Kubernetes cluster named `my-api-created-external-cluster`. #### Sample Request ``` POST /clusters HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.120 Python/3.7.0 Darwin/18.2.0 botocore/1.12.110 X-Amz-Date: 20190322T160158Z Authorization: AUTHPARAMS Content-Length: 368 { "name": "my-api-created-external-cluster", "connectorConfig": { "roleArn": "arn:aws:iam::ACCOUNT_ID:role/eks-connector-agent", "provider" : "OTHER" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/RegisterCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/RegisterCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/RegisterCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/RegisterCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/RegisterCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/RegisterCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/RegisterCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/RegisterCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/RegisterCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/RegisterCluster) # StartInsightsRefresh Initiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule. ## Request Syntax ``` POST /clusters/name/insights-refresh HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_StartInsightsRefresh_RequestSyntax) ** The name of the cluster for the refresh insights operation. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "message": "string", "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [message](#API_StartInsightsRefresh_ResponseSyntax) ** The message associated with the insights refresh operation. Type: String ** [status](#API_StartInsightsRefresh_ResponseSyntax) ** The current status of the insights refresh operation. Type: String Valid Values: `IN_PROGRESS | FAILED | COMPLETED` ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples ### Example The following example starts the cluster insights generation process. #### Sample Request ``` POST /clusters/name/insights-refresh HTTP/1.1 ``` #### Sample Response ``` HTTP/1.1 200 Content-type: application/json { "message": "Initiated cluster insights refresh.", "status": "IN_PROGRESS" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/StartInsightsRefresh) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/StartInsightsRefresh) # TagResource Associates the specified tags to an Amazon EKS resource with the specified `resourceArn`. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster. ## Request Syntax ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to add tags to. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_TagResource_RequestSyntax) ** Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. ** message ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. HTTP Status Code: 400 ** NotFoundException ** A service resource associated with the request could not be found. Clients should not retry such requests. ** message ** A service resource associated with the request could not be found. Clients should not retry such requests. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/TagResource) # UntagResource Deletes specified tags from an Amazon EKS resource. ## Request Syntax ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to delete tags from. Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** The keys of the tags to remove. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** BadRequestException ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. ** message ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. HTTP Status Code: 400 ** NotFoundException ** A service resource associated with the request could not be found. Clients should not retry such requests. ** message ** A service resource associated with the request could not be found. Clients should not retry such requests. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UntagResource) # UpdateAccessEntry Updates an access entry. ## Request Syntax ``` POST /clusters/name/access-entries/principalArn HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "kubernetesGroups": [ "string" ], "username": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateAccessEntry_RequestSyntax) ** The name of your cluster. Required: Yes ** [principalArn](#API_UpdateAccessEntry_RequestSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateAccessEntry_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [kubernetesGroups](#API_UpdateAccessEntry_RequestSyntax) ** The value for `name` that you've specified for `kind: Group` as a `subject` in a Kubernetes `RoleBinding` or `ClusterRoleBinding` object. Amazon EKS doesn't confirm that the value for `name` exists in any bindings on your cluster. You can specify one or more names. Kubernetes authorizes the `principalArn` of the access entry to access any cluster objects that you've specified in a Kubernetes `Role` or `ClusterRole` object that is also specified in a binding's `roleRef`. For more information about creating Kubernetes `RoleBinding`, `ClusterRoleBinding`, `Role`, or `ClusterRole` objects, see [Using RBAC Authorization in the Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/rbac/). If you want Amazon EKS to authorize the `principalArn` (instead of, or in addition to Kubernetes authorizing the `principalArn`), you can associate one or more access policies to the access entry using `AssociateAccessPolicy`. If you associate any access policies, the `principalARN` has all permissions assigned in the associated access policies and all permissions in any Kubernetes `Role` or `ClusterRole` objects that the group names are bound to. Type: Array of strings Required: No ** [username](#API_UpdateAccessEntry_RequestSyntax) ** The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see [Creating access entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries) in the *Amazon EKS User Guide*. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "accessEntry": { "accessEntryArn": "string", "clusterName": "string", "createdAt": number, "kubernetesGroups": [ "string" ], "modifiedAt": number, "principalArn": "string", "tags": { "string" : "string" }, "type": "string", "username": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [accessEntry](#API_UpdateAccessEntry_ResponseSyntax) ** The ARN of the IAM principal for the `AccessEntry`. Type: [AccessEntry](API_AccessEntry.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example updates an access entry by adding a value for `kubernetesGroups`. #### Sample Request ``` POST /clusters/my-cluster/access-entries/arn%3Aaws%3Aiam%3A%3A012345678910%3Arole%2Fmy-role HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.9.0 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/eks.update-access-entry X-Amz-Date: 20230531T132743Z Authorization: AUTHPARAMS Content-Length: 107 { "kubernetesGroups": ["my-kubernetes-group"], "clientRequestToken": "x111xxx1-111x-11xx-xxx1-x11x1111xxx1" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 31 May 2023 13:27:45 GMT Content-Type: application/json Content-Length: 507 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx Access-Control-Allow-Origin: * Access-Control-Allow-Headers: *,Authorization,Date,X-Amz-Date,X-Amz-Security-Token,X-Amz-Target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id x-amz-apigw-id: Fyi0rHRUPHcFyTA= Access-Control-Allow-Methods: GET,HEAD,PUT,POST,DELETE,OPTIONS Access-Control-Expose-Headers: x-amzn-errortype,x-amzn-errormessage,x-amzn-trace-id,x-amzn-requestid,x-amz-apigw-id,date X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "accessEntry": { "clusterName": "my-cluster", "principalArn": "arn:aws:iam::012345678910:role/my-role", "kubernetesGroups": ["my-kubernetes-group"], "accessEntryArn": "arn:aws:eks:us-west-2:012345678910:accessEntry/my-cluster/role/012345678910/my-role/fec43712-ee5b-dd95-5f88-edb855c578b2", "createdAt": 1.685475163532E9, "modifiedAt": 1.685539665508E9, "tags": {}, "username": "arn:aws:sts::012345678910:assumed-role/my-role/{{SessionName}}", "type": "STANDARD" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateAccessEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateAccessEntry) # UpdateAddon Updates an Amazon EKS add-on. ## Request Syntax ``` POST /clusters/name/addons/addonName/update HTTP/1.1 Content-type: application/json { "addonVersion": "string", "clientRequestToken": "string", "configurationValues": "string", "podIdentityAssociations": [ { "roleArn": "string", "serviceAccount": "string" } ], "resolveConflicts": "string", "serviceAccountRoleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [addonName](#API_UpdateAddon_RequestSyntax) ** The name of the add-on. The name must match one of the names returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html). Required: Yes ** [name](#API_UpdateAddon_RequestSyntax) ** The name of your cluster. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [addonVersion](#API_UpdateAddon_RequestSyntax) ** The version of the add-on. The version must match one of the versions returned by [https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html). Type: String Required: No ** [clientRequestToken](#API_UpdateAddon_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [configurationValues](#API_UpdateAddon_RequestSyntax) ** 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`. Type: String Required: No ** [podIdentityAssociations](#API_UpdateAddon_RequestSyntax) ** 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](https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html) in the *Amazon EKS User Guide*. Type: Array of [AddonPodIdentityAssociations](API_AddonPodIdentityAssociations.md) objects Required: No ** [resolveConflicts](#API_UpdateAddon_RequestSyntax) ** 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. Type: String Valid Values: `OVERWRITE | NONE | PRESERVE` Required: No ** [serviceAccountRoleArn](#API_UpdateAddon_RequestSyntax) ** 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](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) 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](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the *Amazon EKS User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_UpdateAddon_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example updates an add-on named `vpc-cni` to use an IAM role named `AmazonEKSCNIRole` and to overwrite the add-on's existing configuration with the Amazon EKS add-on's configuration. #### Sample Request ``` POST /clusters/my-cluster/addons/vpc-cni/update HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201125T145528Z Authorization: AUTHPARAMS { "serviceAccountRoleArn": "arn:aws:iam::012345678910:role/AmazonEKSCNIRole", "resolveConflicts": "overwrite", "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 25 Nov 2020 14:55:29 GMT Content-Type: application/json Content-Length: 288 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: WkZ_KGiBvHcFhtw= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "status": "InProgress", "type": "AddonUpdate", "params": [{ "type": "ServiceAccountRoleArn", "value": "arn:aws:iam::012345678910:role/AmazonEKSCNIRole" }, { "type": "ResolveConflicts", "value": "overwrite" }], "createdAt": 1606316129.051, "errors": [] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateAddon) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateAddon) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateAddon) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateAddon) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateAddon) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateAddon) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateAddon) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateAddon) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateAddon) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateAddon) # UpdateCapability Updates the configuration of a managed capability in your Amazon EKS cluster. You can update the IAM role, configuration settings, and delete propagation policy for a capability. When you update a capability, Amazon EKS applies the changes and may restart capability components as needed. The capability remains available during the update process, but some operations may be temporarily unavailable. ## Request Syntax ``` POST /clusters/name/capabilities/capabilityName HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "configuration": { "argoCd": { "networkAccess": { "vpceIds": [ "string" ] }, "rbacRoleMappings": { "addOrUpdateRoleMappings": [ { "identities": [ { "id": "string", "type": "string" } ], "role": "string" } ], "removeRoleMappings": [ { "identities": [ { "id": "string", "type": "string" } ], "role": "string" } ] } } }, "deletePropagationPolicy": "string", "roleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [capabilityName](#API_UpdateCapability_RequestSyntax) ** The name of the capability to update configuration for. Required: Yes ** [name](#API_UpdateCapability_RequestSyntax) ** The name of the Amazon EKS cluster that contains the capability you want to update configuration for. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateCapability_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation. Type: String Required: No ** [configuration](#API_UpdateCapability_RequestSyntax) ** The updated configuration settings for the capability. You only need to specify the configuration parameters you want to change. For Argo CD capabilities, you can update RBAC role mappings and network access settings. Type: [UpdateCapabilityConfiguration](API_UpdateCapabilityConfiguration.md) object Required: No ** [deletePropagationPolicy](#API_UpdateCapability_RequestSyntax) ** The updated delete propagation policy for the capability. Currently, the only supported value is `RETAIN`. Type: String Valid Values: `RETAIN` Required: No ** [roleArn](#API_UpdateCapability_RequestSyntax) ** The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services. If you specify a new role ARN, the capability will start using the new role for all subsequent operations. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_UpdateCapability_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. ** message ** You do not have sufficient access to perform this action. HTTP Status Code: 403 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateCapability) # UpdateClusterConfig Updates an Amazon EKS cluster configuration. 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 `DescribeUpdate`. You can use this operation to do the following actions: + You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see [Amazon EKS Cluster control plane logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the * *Amazon EKS User Guide* *. **Note** CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/). + You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see [ Cluster API server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the * *Amazon EKS User Guide* *. + You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see [https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) in the * *Amazon EKS User Guide* *. + You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, AWS configures zonal autoshift for the cluster. + You can also use this API operation to add, change, or remove the configuration in the cluster for EKS Hybrid Nodes. To remove the configuration, use the `remoteNetworkConfig` key with an object containing both subkeys with empty arrays for each. Here is an inline example: `"remoteNetworkConfig": { "remoteNodeNetworks": [], "remotePodNetworks": [] }`. 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`. ## Request Syntax ``` POST /clusters/name/update-config HTTP/1.1 Content-type: application/json { "accessConfig": { "authenticationMode": "string" }, "clientRequestToken": "string", "computeConfig": { "enabled": boolean, "nodePools": [ "string" ], "nodeRoleArn": "string" }, "controlPlaneScalingConfig": { "tier": "string" }, "deletionProtection": boolean, "kubernetesNetworkConfig": { "elasticLoadBalancing": { "enabled": boolean }, "ipFamily": "string", "serviceIpv4Cidr": "string" }, "logging": { "clusterLogging": [ { "enabled": boolean, "types": [ "string" ] } ] }, "remoteNetworkConfig": { "remoteNodeNetworks": [ { "cidrs": [ "string" ] } ], "remotePodNetworks": [ { "cidrs": [ "string" ] } ] }, "resourcesVpcConfig": { "endpointPrivateAccess": boolean, "endpointPublicAccess": boolean, "publicAccessCidrs": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] }, "storageConfig": { "blockStorage": { "enabled": boolean } }, "upgradePolicy": { "supportType": "string" }, "zonalShiftConfig": { "enabled": boolean } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateClusterConfig_RequestSyntax) ** The name of the Amazon EKS cluster to update. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [accessConfig](#API_UpdateClusterConfig_RequestSyntax) ** The access configuration for the cluster. Type: [UpdateAccessConfigRequest](API_UpdateAccessConfigRequest.md) object Required: No ** [clientRequestToken](#API_UpdateClusterConfig_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [computeConfig](#API_UpdateClusterConfig_RequestSyntax) ** Update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. Type: [ComputeConfigRequest](API_ComputeConfigRequest.md) object Required: No ** [controlPlaneScalingConfig](#API_UpdateClusterConfig_RequestSyntax) ** The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. Type: [ControlPlaneScalingConfig](API_ControlPlaneScalingConfig.md) object Required: No ** [deletionProtection](#API_UpdateClusterConfig_RequestSyntax) ** Specifies whether to enable or disable deletion protection for the cluster. When enabled (`true`), the cluster cannot be deleted until deletion protection is explicitly disabled. When disabled (`false`), the cluster can be deleted normally. Type: Boolean Required: No ** [kubernetesNetworkConfig](#API_UpdateClusterConfig_RequestSyntax) ** The Kubernetes network configuration for the cluster. Type: [KubernetesNetworkConfigRequest](API_KubernetesNetworkConfigRequest.md) object Required: No ** [logging](#API_UpdateClusterConfig_RequestSyntax) ** Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren't exported to CloudWatch Logs . For more information, see [Amazon EKS cluster control plane logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the * *Amazon EKS User Guide* *. CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/). Type: [Logging](API_Logging.md) object Required: No ** [remoteNetworkConfig](#API_UpdateClusterConfig_RequestSyntax) ** The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. Type: [RemoteNetworkConfigRequest](API_RemoteNetworkConfigRequest.md) object Required: No ** [resourcesVpcConfig](#API_UpdateClusterConfig_RequestSyntax) ** An object representing the VPC configuration to use for an Amazon EKS cluster. Type: [VpcConfigRequest](API_VpcConfigRequest.md) object Required: No ** [storageConfig](#API_UpdateClusterConfig_RequestSyntax) ** Update the configuration of the block storage capability of your EKS Auto Mode cluster. For example, enable the capability. Type: [StorageConfigRequest](API_StorageConfigRequest.md) object Required: No ** [upgradePolicy](#API_UpdateClusterConfig_RequestSyntax) ** You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support. Type: [UpgradePolicyRequest](API_UpgradePolicyRequest.md) object Required: No ** [zonalShiftConfig](#API_UpdateClusterConfig_RequestSyntax) ** Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, AWS configures zonal autoshift for the cluster. Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary. You can start a zonal shift for an EKS cluster, or you can allow AWS to do it for you by enabling *zonal autoshift*. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html) in the * *Amazon EKS User Guide* *. Type: [ZonalShiftConfigRequest](API_ZonalShiftConfigRequest.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_UpdateClusterConfig_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ThrottlingException ** The request or operation couldn't be performed because a service is throttling requests. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 429 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example disables the Amazon EKS public API server endpoint for the `my-cluster` cluster. #### Sample Request ``` POST /clusters/my-cluster/update-config HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20190228T215632Z Authorization: AUTHPARAMS { "resourcesVpcConfig": { "endpointPublicAccess": false }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Thu, 28 Feb 2019 21:56:33 GMT Content-Type: application/json Content-Length: 254 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: V1LanEMJPHcFvTg= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "id": "71abb011-b524-4983-b17f-c30baa1b5530", "status": "InProgress", "type": "EndpointAccessUpdate", "params": [ { "type": "EndpointPublicAccess", "value": "false" }, { "type": "EndpointPrivateAccess", "value": "true" } ], "createdAt": 1551390993.374, "errors": [] } } ``` ### Example The following example enables exporting all cluster control plane logs to CloudWatch Logs. #### Sample Request ``` POST /clusters/my-cluster/update-config HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.120 Python/3.7.0 Darwin/18.2.0 botocore/1.12.110 X-Amz-Date: 20190322T162335Z Authorization: AUTHPARAMS { "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": true } ] }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Fri, 22 Mar 2019 16:23:34 GMT Content-Type: application/json Content-Length: 313 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: W87Q5HlCvHcFxDA= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "id": "883405c8-65c6-4758-8cee-2a7c1340a6d9", "status": "InProgress", "type": "LoggingUpdate", "params": [ { "type": "ClusterLogging", "value": "{\"clusterLogging\":[{\"types\":[\"api\",\"audit\",\"authenticator\",\"controllerManager\",\"scheduler\"],\"enabled\":true}]}" } ], "createdAt": 1553271814.684, "errors": [] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateClusterConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateClusterConfig) # UpdateClusterVersion 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 [https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html) 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. ## Request Syntax ``` POST /clusters/name/updates HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "force": boolean, "version": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateClusterVersion_RequestSyntax) ** The name of the Amazon EKS cluster to update. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateClusterVersion_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [force](#API_UpdateClusterVersion_RequestSyntax) ** Set this value to `true` to override upgrade-blocking readiness checks when updating a cluster. Type: Boolean Required: No ** [version](#API_UpdateClusterVersion_RequestSyntax) ** The desired Kubernetes version following a successful update. Type: String Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_UpdateClusterVersion_ResponseSyntax) ** The full description of the specified update Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidStateException ** Amazon EKS detected upgrade readiness issues. Call the [https://docs.aws.amazon.com/eks/latest/APIReference/API_ListInsights.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_ListInsights.html) API to view detected upgrade blocking issues. Pass the [https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateClusterVersion.html#API_UpdateClusterVersion_RequestBody](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateClusterVersion.html#API_UpdateClusterVersion_RequestBody) flag when updating to override upgrade readiness errors. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ** ThrottlingException ** The request or operation couldn't be performed because a service is throttling requests. ** clusterName ** The Amazon EKS cluster associated with the exception. HTTP Status Code: 429 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example updates the `devel` cluster to Kubernetes version 1.11. #### Sample Request ``` POST /clusters/devel/updates HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20181129T172834Z Authorization: AUTHPARAMS { "version": "1.11", "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Thu, 29 Nov 2018 17:28:35 GMT Content-Type: application/json Content-Length: 228 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: RIo2bEs8vHcFXoA= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "errors": [], "params": [{ "value": "1.11", "type": "Version" }, { "value": "eks.1", "type": "PlatformVersion" }], "status": "InProgress", "id": "9f771284-9e30-4886-b5b1-3789b6bea4dc", "createdAt": 1543512515.848, "type": "VersionUpdate" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateClusterVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateClusterVersion) # UpdateEksAnywhereSubscription Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation. ## Request Syntax ``` POST /eks-anywhere-subscriptions/id HTTP/1.1 Content-type: application/json { "autoRenew": boolean, "clientRequestToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [id](#API_UpdateEksAnywhereSubscription_RequestSyntax) ** The ID of the subscription. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [autoRenew](#API_UpdateEksAnywhereSubscription_RequestSyntax) ** A boolean indicating whether or not to automatically renew the subscription. Type: Boolean Required: Yes ** [clientRequestToken](#API_UpdateEksAnywhereSubscription_RequestSyntax) ** Unique, case-sensitive identifier to ensure the idempotency of the request. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "subscription": { "arn": "string", "autoRenew": boolean, "createdAt": number, "effectiveDate": number, "expirationDate": number, "id": "string", "licenseArns": [ "string" ], "licenseQuantity": number, "licenses": [ { "id": "string", "token": "string" } ], "licenseType": "string", "status": "string", "tags": { "string" : "string" }, "term": { "duration": number, "unit": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [subscription](#API_UpdateEksAnywhereSubscription_ResponseSyntax) ** The full description of the updated subscription. Type: [EksAnywhereSubscription](API_EksAnywhereSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateEksAnywhereSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateEksAnywhereSubscription) # UpdateNodegroupConfig Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the [https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html) API operation. You can update the Kubernetes labels and taints for a node group and the scaling and version update configuration. ## Request Syntax ``` POST /clusters/name/node-groups/nodegroupName/update-config HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "labels": { "addOrUpdateLabels": { "string" : "string" }, "removeLabels": [ "string" ] }, "nodeRepairConfig": { "enabled": boolean, "maxParallelNodesRepairedCount": number, "maxParallelNodesRepairedPercentage": number, "maxUnhealthyNodeThresholdCount": number, "maxUnhealthyNodeThresholdPercentage": number, "nodeRepairConfigOverrides": [ { "minRepairWaitTimeMins": number, "nodeMonitoringCondition": "string", "nodeUnhealthyReason": "string", "repairAction": "string" } ] }, "scalingConfig": { "desiredSize": number, "maxSize": number, "minSize": number }, "taints": { "addOrUpdateTaints": [ { "effect": "string", "key": "string", "value": "string" } ], "removeTaints": [ { "effect": "string", "key": "string", "value": "string" } ] }, "updateConfig": { "maxUnavailable": number, "maxUnavailablePercentage": number, "updateStrategy": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateNodegroupConfig_RequestSyntax) ** The name of your cluster. Required: Yes ** [nodegroupName](#API_UpdateNodegroupConfig_RequestSyntax) ** The name of the managed node group to update. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateNodegroupConfig_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [labels](#API_UpdateNodegroupConfig_RequestSyntax) ** The Kubernetes `labels` to apply to the nodes in the node group after the update. Type: [UpdateLabelsPayload](API_UpdateLabelsPayload.md) object Required: No ** [nodeRepairConfig](#API_UpdateNodegroupConfig_RequestSyntax) ** The node auto repair configuration for the node group. Type: [NodeRepairConfig](API_NodeRepairConfig.md) object Required: No ** [scalingConfig](#API_UpdateNodegroupConfig_RequestSyntax) ** The scaling configuration details for the Auto Scaling group after the update. Type: [NodegroupScalingConfig](API_NodegroupScalingConfig.md) object Required: No ** [taints](#API_UpdateNodegroupConfig_RequestSyntax) ** The Kubernetes taints to be applied to the nodes in the node group after the update. For more information, see [Node taints on managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). Type: [UpdateTaintsPayload](API_UpdateTaintsPayload.md) object Required: No ** [updateConfig](#API_UpdateNodegroupConfig_RequestSyntax) ** The node group update configuration. Type: [NodegroupUpdateConfig](API_NodegroupUpdateConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_UpdateNodegroupConfig_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples ### Example This example updates the scaling configuration for a node group called `standard` in the `my-cluster` cluster. #### Sample Request ``` POST /clusters/my-cluster/node-groups/standard/update-config HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11 X-Amz-Date: 20191111T202415Z Authorization: AUTHPARAMS Content-Length: 127 { "scalingConfig": { "minSize": 2, "desiredSize": 4, "maxSize": 6 }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Mon, 11 Nov 2019 20:24:16 GMT Content-Type: application/json Content-Length: 247 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAt5dGkFPHcFzuQ= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "id": "4c6c3652-9c56-3c76-86e3-8a3930af1bae", "status": "InProgress", "type": "ConfigUpdate", "params": [ { "type": "MinSize", "value": "2" }, { "type": "MaxSize", "value": "6" }, { "type": "DesiredSize", "value": "4" } ], "createdAt": 1573503855.887, "errors": [] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateNodegroupConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateNodegroupConfig) # UpdateNodegroupVersion Updates 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 was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template. If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User Guide*. For information about Windows versions, see [Amazon EKS optimized Windows AMI versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) in the *Amazon EKS User Guide*. You cannot roll back a node group to an earlier Kubernetes version or AMI version. When a node in a managed node group is terminated due to a scaling action or update, every `Pod` on that node is drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can `force` the update if Amazon EKS is unable to drain the nodes as a result of a `Pod` disruption budget issue. ## Request Syntax ``` POST /clusters/name/node-groups/nodegroupName/update-version HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "force": boolean, "launchTemplate": { "id": "string", "name": "string", "version": "string" }, "releaseVersion": "string", "version": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [name](#API_UpdateNodegroupVersion_RequestSyntax) ** The name of your cluster. Required: Yes ** [nodegroupName](#API_UpdateNodegroupVersion_RequestSyntax) ** The name of the managed node group to update. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateNodegroupVersion_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [force](#API_UpdateNodegroupVersion_RequestSyntax) ** Force the update if any `Pod` on the existing node group can't be drained due to a `Pod` disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any `Pod` is running on the node. Type: Boolean Required: No ** [launchTemplate](#API_UpdateNodegroupVersion_RequestSyntax) ** An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template. When updating, you must specify the same launch template ID or name that was used to create the node group. Type: [LaunchTemplateSpecification](API_LaunchTemplateSpecification.md) object Required: No ** [releaseVersion](#API_UpdateNodegroupVersion_RequestSyntax) ** The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User Guide*. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see [Amazon EKS optimized Windows AMI versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html) in the *Amazon EKS User Guide*. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `releaseVersion`, or the node group update will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: String Required: No ** [version](#API_UpdateNodegroupVersion_RequestSyntax) ** The Kubernetes version to update to. If no version is specified, then the node group will be updated to match the cluster's current Kubernetes version, and the latest available AMI for that version will be used. You can also specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `version`, or the node group update will fail. For more information about using launch templates with Amazon EKS, see [Customizing managed nodes with launch templates](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [update](#API_UpdateNodegroupVersion_ResponseSyntax) ** An object representing an asynchronous update. Type: [Update](API_Update.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** ClientException ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) that doesn't have permissions to use the action or resource or specifying an identifier that is not valid. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is in use. ** addonName ** The specified add-on name is in use. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example 1 This example updates a node group that was deployed without a launch template to the latest available node group AMI version for the node group's current Kubernetes version. The example node group is named `standard` and is in the `prod` cluster. #### Sample Request ``` POST /clusters/prod/node-groups/standard/update-version HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11 X-Amz-Date: 20191111T184043Z Authorization: AUTHPARAMS Content-Length: 62 { "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Mon, 11 Nov 2019 18:40:43 GMT Content-Type: application/json Content-Length: 237 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAeuxEBkvHcF1sg= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "id": "079be772-956e-37c4-a966-960c1a6755a5", "status": "InProgress", "type": "VersionUpdate", "params": [ { "type": "Version", "value": "1.14" }, { "type": "ReleaseVersion", "value": "1.14.7-20190927" } ], "createdAt": 1573497643.374, "errors": [] } } ``` ### Example 2 This example updates a node group that was deployed with a launch template to version `3` of a launch template named `my-launch-template`. #### Sample Request ``` POST /clusters/my-cluster/node-groups/my-nodegroup/update-version HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20200812T144111Z Authorization: AUTHPARAMS Content-Length: 121 { "launchTemplate": { "name": "my-template", "version": "3" }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Wed, 12 Aug 2020 14:41:12 GMT Content-Type: application/json Content-Length: 248 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: DAeuxEBkvHcF1sg= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update": { "id": "8f63ed58-f571-3bf9-87bc-a35f5e3d7687", "status": "InProgress", "type": "VersionUpdate", "params": [{ "type": "LaunchTemplateName", "value": "my-launch-template" }, { "type": "LaunchTemplateVersion", "value": "3" }], "createdAt": 1597243272.809, "errors": [] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdateNodegroupVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdateNodegroupVersion) # UpdatePodIdentityAssociation Updates 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 of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings. Similar to AWS IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a *target IAM role* in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another AWS account. ## Request Syntax ``` POST /clusters/name/pod-identity-associations/associationId HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "disableSessionTags": boolean, "policy": "string", "roleArn": "string", "targetRoleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [associationId](#API_UpdatePodIdentityAssociation_RequestSyntax) ** The ID of the association to be updated. Required: Yes ** [name](#API_UpdatePodIdentityAssociation_RequestSyntax) ** The name of the cluster that you want to update the association in. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdatePodIdentityAssociation_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No ** [disableSessionTags](#API_UpdatePodIdentityAssociation_RequestSyntax) ** Disable the automatic sessions tags that are appended by EKS Pod Identity. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to AWS resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see [List of session tags added by EKS Pod Identity](https://docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags) in the *Amazon EKS User Guide*. AWS compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a `PackedPolicyTooLarge` error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity. Type: Boolean Required: No ** [policy](#API_UpdatePodIdentityAssociation_RequestSyntax) ** An optional IAM policy in JSON format (as an escaped string) that applies additional restrictions to this pod identity association beyond the IAM policies attached to the IAM role. This policy is applied as the intersection of the role's policies and this policy, allowing you to reduce the permissions that applications in the pods can use. Use this policy to enforce least privilege access while still leveraging a shared IAM role across multiple applications. **Important considerations** + **Session tags:** When using this policy, `disableSessionTags` must be set to `true`. + **Target role permissions:** If you specify both a `TargetRoleArn` and a policy, the policy restrictions apply only to the target role's permissions, not to the initial role used for assuming the target role. Type: String Required: No ** [roleArn](#API_UpdatePodIdentityAssociation_RequestSyntax) ** The new IAM role to change in the association. Type: String Required: No ** [targetRoleArn](#API_UpdatePodIdentityAssociation_RequestSyntax) ** The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod. When you run applications on Amazon EKS, your application might need to access AWS resources from a different role that exists in the same or different AWS account. For example, your application running in “Account A” might need to access resources, such as buckets in “Account B” or within “Account A” itself. You can create a association to access AWS resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the *IAM role* and *Target IAM role* fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "association": { "associationArn": "string", "associationId": "string", "clusterName": "string", "createdAt": number, "disableSessionTags": boolean, "externalId": "string", "modifiedAt": number, "namespace": "string", "ownerArn": "string", "policy": "string", "roleArn": "string", "serviceAccount": "string", "tags": { "string" : "string" }, "targetRoleArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [association](#API_UpdatePodIdentityAssociation_ResponseSyntax) ** The full description of the association that was updated. Type: [PodIdentityAssociation](API_PodIdentityAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. ** addonName ** The specified parameter for the add-on name is invalid. Review the available parameters for the API request ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The specified parameter is invalid. Review the available parameters for the API request. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** InvalidRequestException ** The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations. ** addonName ** The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** The Amazon EKS add-on name associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. You can view your available clusters with `ListClusters`. You can view your available managed node groups with `ListNodegroups`. Amazon EKS clusters and node groups are AWS Region specific. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** fargateProfileName ** The Fargate profile associated with the exception. ** message ** The Amazon EKS message associated with the exception. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 404 ** ServerException ** These errors are usually caused by a server-side issue. ** addonName ** The Amazon EKS add-on name associated with the exception. ** clusterName ** The Amazon EKS cluster associated with the exception. ** message ** These errors are usually caused by a server-side issue. ** nodegroupName ** The Amazon EKS managed node group associated with the exception. ** subscriptionId ** The Amazon EKS subscription ID with the exception. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-2017-11-01/UpdatePodIdentityAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-2017-11-01/UpdatePodIdentityAssociation) # Amazon EKS Auth The following actions are supported by Amazon EKS Auth: + [AssumeRoleForPodIdentity](API_auth_AssumeRoleForPodIdentity.md) # AssumeRoleForPodIdentity The Amazon EKS Auth API and the `AssumeRoleForPodIdentity` action are only used by the EKS Pod Identity Agent. We recommend that applications use the AWS SDKs to connect to AWS services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically. ## Request Syntax ``` POST /clusters/clusterName/assume-role-for-pod-identity HTTP/1.1 Content-type: application/json { "token": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [clusterName](#API_auth_AssumeRoleForPodIdentity_RequestSyntax) ** The name of the cluster for the request. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[0-9A-Za-z][A-Za-z0-9\-_]*` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [token](#API_auth_AssumeRoleForPodIdentity_RequestSyntax) ** The token of the Kubernetes service account for the pod. Type: String Length Constraints: Minimum length of 1. Pattern: `[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "assumedRoleUser": { "arn": "string", "assumeRoleId": "string" }, "audience": "string", "credentials": { "accessKeyId": "string", "expiration": number, "secretAccessKey": "string", "sessionToken": "string" }, "podIdentityAssociation": { "associationArn": "string", "associationId": "string" }, "subject": { "namespace": "string", "serviceAccount": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [assumedRoleUser](#API_auth_AssumeRoleForPodIdentity_ResponseSyntax) ** An object with the permanent IAM role identity and the temporary session name. The ARN of the IAM role that the temporary credentials authenticate to. The session name of the temporary session requested to AWS STS. The value is a unique identifier that contains the role ID, a colon (`:`), and the role session name of the role that is being assumed. The role ID is generated by IAM when the role is created. The role session name part of the value follows this format: `eks-clustername-podname-random UUID ` Type: [AssumedRoleUser](API_auth_AssumedRoleUser.md) object ** [audience](#API_auth_AssumeRoleForPodIdentity_ResponseSyntax) ** The identity that is allowed to use the credentials. This value is always `pods.eks.amazonaws.com`. Type: String ** [credentials](#API_auth_AssumeRoleForPodIdentity_ResponseSyntax) ** The * AWS Signature Version 4* type of temporary credentials. Type: [Credentials](API_auth_Credentials.md) object ** [podIdentityAssociation](#API_auth_AssumeRoleForPodIdentity_ResponseSyntax) ** The Amazon Resource Name (ARN) and ID of the EKS Pod Identity association. Type: [PodIdentityAssociation](API_auth_PodIdentityAssociation.md) object ** [subject](#API_auth_AssumeRoleForPodIdentity_ResponseSyntax) ** The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. Type: [Subject](API_auth_Subject.md) object ## Errors For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). ** AccessDeniedException ** You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*. HTTP Status Code: 400 ** ExpiredTokenException ** The specified Kubernetes service account token is expired. HTTP Status Code: 400 ** InternalServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** InvalidRequestException ** This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message. HTTP Status Code: 400 ** InvalidTokenException ** The specified Kubernetes service account token is invalid. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource could not be found. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is unavailable. Back off and retry the operation. HTTP Status Code: 503 ** ThrottlingException ** The request was denied because your request rate is too high. Reduce the frequency of requests. HTTP Status Code: 429 ## Examples In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *Amazon EKS General Reference*. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example The following example assumes an IAM role with the EKS Pod Identity association called `my-association` in a cluster called `my-cluster`. #### Sample Request ``` POST /clusters/my-cluster/assume-role-for-pod-identity HTTP/1.1 Host: eks-auth.us-west-2.api.aws Accept-Encoding: identity User-Agent: aws-cli/1.29.81 md/Botocore#1.31.81 ua/2.0 os/macos#22.6.0 md/arch#x86_64 lang/python#3.8.0 md/pyimpl#CPython cfg/retry-mode#legacy botocore/1.31.81 X-Amz-Date: 20231121T192727Z Authorization: AUTHPARAMS Content-length: 1043 { "token": "eyJhbEXAMPLE" } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Fri, 22 Mar 2019 16:01:58 GMT Content-Type: application/json Content-Length: 682 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: W84GUEIbPHcFW2Q= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "assumedRoleUser": { "arn": "arn:aws:sts::012345678910:assumed-role/my-role/eks-my-cluster-podname-randomUUID", "assumeRoleId": "AROA123456789EXAMPLE:eks-my-cluster-podname-randomUUID" }, "audience": "pods.eks.amazonaws.com", "credentials": { "accessKeyId": "ASIAIOSFODNN7EXAMPLE", "expiration": 1.70061547E9, "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "sessionToken": "EXAMPLE" }, "podIdentityAssociation": { "associationArn": "arn:aws:eks:us-west-2:012345678910:podidentityassociation/my-association/a-abcdefghijklmnop1", "associationId": "a-abcdefghijklmnop1" }, "subject": { "namespace": "my-namespace", "serviceAccount": "my-serviceaccount" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eks-auth-2023-11-26/AssumeRoleForPodIdentity) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eks-auth-2023-11-26/AssumeRoleForPodIdentity)