EKS

Table of Contents

Client

class EKS.Client

A low-level client representing Amazon Elastic Container Service for Kubernetes (EKS):

import boto3

client = boto3.client('eks')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_cluster(**kwargs)

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, like etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint.

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

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 worker nodes (for example, to support kubectl exec , logs , and proxy data flows).

After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_cluster(
    name='string',
    version='string',
    roleArn='string',
    resourcesVpcConfig={
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    },
    clientRequestToken='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    The unique name to give to your cluster.

  • version (string) -- The desired Kubernetes version for your cluster. If you do not specify a value here, the latest version available in Amazon EKS is used.
  • roleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the * Amazon EKS User Guide * .

  • resourcesVpcConfig (dict) --

    [REQUIRED]

    The VPC subnets and security groups 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 and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You may specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

    • subnetIds (list) -- [REQUIRED]

      Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.

      • (string) --
    • securityGroupIds (list) --

      Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you do not specify a security group, the default security group for your VPC is used.

      • (string) --
  • clientRequestToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'cluster': {
        'name': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'version': 'string',
        'endpoint': 'string',
        'roleArn': 'string',
        'resourcesVpcConfig': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ],
            'vpcId': 'string'
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'certificateAuthority': {
            'data': 'string'
        },
        'clientRequestToken': 'string',
        'platformVersion': 'string'
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      The full description of your new cluster.

      • name (string) --

        The name of the cluster.

      • arn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the cluster was created.

      • version (string) --

        The Kubernetes server version for the cluster.

      • endpoint (string) --

        The endpoint for your Kubernetes API server.

      • roleArn (string) --

        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.

      • resourcesVpcConfig (dict) --

        The VPC subnets and security groups 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 and Cluster Security Group Considerations in the Amazon EKS User Guide .

        • subnetIds (list) --

          The subnets associated with your cluster.

          • (string) --
        • securityGroupIds (list) --

          The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

          • (string) --
        • vpcId (string) --

          The VPC associated with your cluster.

      • status (string) --

        The current status of the cluster.

      • certificateAuthority (dict) --

        The certificate-authority-data for your cluster.

        • data (string) --

          The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

      • clientRequestToken (string) --

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

      • platformVersion (string) --

        The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the * Amazon EKS User Guide * .

delete_cluster(**kwargs)

Deletes the Amazon EKS cluster control plane.

Note

If you have active services 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 in the Amazon EKS User Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_cluster(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name of the cluster to delete.

Return type
dict
Returns
Response Syntax
{
    'cluster': {
        'name': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'version': 'string',
        'endpoint': 'string',
        'roleArn': 'string',
        'resourcesVpcConfig': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ],
            'vpcId': 'string'
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'certificateAuthority': {
            'data': 'string'
        },
        'clientRequestToken': 'string',
        'platformVersion': 'string'
    }
}

Response Structure

  • (dict) --
    • cluster (dict) --

      The full description of the cluster to delete.

      • name (string) --

        The name of the cluster.

      • arn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the cluster was created.

      • version (string) --

        The Kubernetes server version for the cluster.

      • endpoint (string) --

        The endpoint for your Kubernetes API server.

      • roleArn (string) --

        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.

      • resourcesVpcConfig (dict) --

        The VPC subnets and security groups 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 and Cluster Security Group Considerations in the Amazon EKS User Guide .

        • subnetIds (list) --

          The subnets associated with your cluster.

          • (string) --
        • securityGroupIds (list) --

          The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

          • (string) --
        • vpcId (string) --

          The VPC associated with your cluster.

      • status (string) --

        The current status of the cluster.

      • certificateAuthority (dict) --

        The certificate-authority-data for your cluster.

        • data (string) --

          The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

      • clientRequestToken (string) --

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

      • platformVersion (string) --

        The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the * Amazon EKS User Guide * .

describe_cluster(**kwargs)

Returns descriptive information about 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 Create a kubeconfig for Amazon EKS .

Note

The API server endpoint and certificate authority data are not available until the cluster reaches the ACTIVE state.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name of the cluster to describe.

Return type
dict
Returns
Response Syntax
{
    'cluster': {
        'name': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'version': 'string',
        'endpoint': 'string',
        'roleArn': 'string',
        'resourcesVpcConfig': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ],
            'vpcId': 'string'
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'certificateAuthority': {
            'data': 'string'
        },
        'clientRequestToken': 'string',
        'platformVersion': 'string'
    }
}

Response Structure

  • (dict) --
    • cluster (dict) --

      The full description of your specified cluster.

      • name (string) --

        The name of the cluster.

      • arn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the cluster was created.

      • version (string) --

        The Kubernetes server version for the cluster.

      • endpoint (string) --

        The endpoint for your Kubernetes API server.

      • roleArn (string) --

        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.

      • resourcesVpcConfig (dict) --

        The VPC subnets and security groups 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 and Cluster Security Group Considerations in the Amazon EKS User Guide .

        • subnetIds (list) --

          The subnets associated with your cluster.

          • (string) --
        • securityGroupIds (list) --

          The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

          • (string) --
        • vpcId (string) --

          The VPC associated with your cluster.

      • status (string) --

        The current status of the cluster.

      • certificateAuthority (dict) --

        The certificate-authority-data for your cluster.

        • data (string) --

          The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

      • clientRequestToken (string) --

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

      • platformVersion (string) --

        The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the * Amazon EKS User Guide * .

describe_update(**kwargs)

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded , the update is complete. If an update fails, the status is Failed , and an error detail explains the reason for the failure.

See also: AWS API Documentation

Request Syntax

response = client.describe_update(
    name='string',
    updateId='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the Amazon EKS cluster to update.

  • updateId (string) --

    [REQUIRED]

    The ID of the update to describe.

Return type

dict

Returns

Response Syntax

{
    'update': {
        'id': 'string',
        'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
        'type': 'VersionUpdate',
        'params': [
            {
                'type': 'Version'|'PlatformVersion',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'errors': [
            {
                'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown',
                'errorMessage': 'string',
                'resourceIds': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • update (dict) --

      The full description of the specified update.

      • id (string) --

        A UUID that is used to track the update.

      • status (string) --

        The current status of the update.

      • type (string) --

        The type of the update.

      • params (list) --

        A key-value map that contains the parameters associated with the update.

        • (dict) --

          An object representing the details of an update request.

          • type (string) --

            The keys associated with an update request.

          • value (string) --

            The value of the keys submitted as part of an update request.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the update was created.

      • errors (list) --

        Any errors associated with a Failed update.

        • (dict) --

          An object representing an error when an asynchronous operation fails.

          • errorCode (string) --

            A brief description of the error.

            • SubnetNotFound : One of the subnets associated with the cluster could not be found.
            • SecurityGroupNotFound : One of the security groups associated with the cluster could not be found.
            • EniLimitReached : You have reached the elastic network interface limit for your account.
            • IpNotAvailable : A subnet associated with the cluster does not have any free IP addresses.
            • AccessDenied : You do not have permissions to perform the specified operation.
            • OperationNotPermitted : The service role associated with the cluster does not have the required access permissions for Amazon EKS.
            • VpcIdNotFound : The VPC associated with the cluster could not be found.
          • errorMessage (string) --

            A more complete description of the error.

          • resourceIds (list) --

            An optional field that contains the resource IDs associated with the error.

            • (string) --

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_clusters(**kwargs)

Lists the Amazon EKS clusters in your AWS account in the specified Region.

See also: AWS API Documentation

Request Syntax

response = client.list_clusters(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
  • nextToken (string) --

    The nextToken value returned from a previous paginated ListClusters 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.

    Note

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Return type

dict

Returns

Response Syntax

{
    'clusters': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • clusters (list) --

      A list of all of the clusters for your account in the specified Region.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_updates(**kwargs)

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

See also: AWS API Documentation

Request Syntax

response = client.list_updates(
    name='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the Amazon EKS cluster for which to list updates.

  • nextToken (string) -- 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.
  • maxResults (integer) -- The maximum number of update results returned by ListUpdates in paginated output. When this parameter is used, ListUpdates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListUpdates returns up to 100 results and a nextToken value if applicable.
Return type

dict

Returns

Response Syntax

{
    'updateIds': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • updateIds (list) --

      A list of all the updates for the specified cluster and Region.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

update_cluster_version(**kwargs)

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful ), the cluster status moves to Active .

See also: AWS API Documentation

Request Syntax

response = client.update_cluster_version(
    name='string',
    version='string',
    clientRequestToken='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the Amazon EKS cluster to update.

  • version (string) --

    [REQUIRED]

    The desired Kubernetes version following a successful update.

  • clientRequestToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'update': {
        'id': 'string',
        'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
        'type': 'VersionUpdate',
        'params': [
            {
                'type': 'Version'|'PlatformVersion',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'errors': [
            {
                'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown',
                'errorMessage': 'string',
                'resourceIds': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • update (dict) --

      The full description of the specified update

      • id (string) --

        A UUID that is used to track the update.

      • status (string) --

        The current status of the update.

      • type (string) --

        The type of the update.

      • params (list) --

        A key-value map that contains the parameters associated with the update.

        • (dict) --

          An object representing the details of an update request.

          • type (string) --

            The keys associated with an update request.

          • value (string) --

            The value of the keys submitted as part of an update request.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the update was created.

      • errors (list) --

        Any errors associated with a Failed update.

        • (dict) --

          An object representing an error when an asynchronous operation fails.

          • errorCode (string) --

            A brief description of the error.

            • SubnetNotFound : One of the subnets associated with the cluster could not be found.
            • SecurityGroupNotFound : One of the security groups associated with the cluster could not be found.
            • EniLimitReached : You have reached the elastic network interface limit for your account.
            • IpNotAvailable : A subnet associated with the cluster does not have any free IP addresses.
            • AccessDenied : You do not have permissions to perform the specified operation.
            • OperationNotPermitted : The service role associated with the cluster does not have the required access permissions for Amazon EKS.
            • VpcIdNotFound : The VPC associated with the cluster could not be found.
          • errorMessage (string) --

            A more complete description of the error.

          • resourceIds (list) --

            An optional field that contains the resource IDs associated with the error.

            • (string) --

Paginators

The available paginators are:

Waiters

The available waiters are:

class EKS.Waiter.ClusterActive
waiter = client.get_waiter('cluster_active')
wait(**kwargs)

Polls EKS.Client.describe_cluster() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the cluster to describe.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 40

Returns

None

class EKS.Waiter.ClusterDeleted
waiter = client.get_waiter('cluster_deleted')
wait(**kwargs)

Polls EKS.Client.describe_cluster() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the cluster to describe.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 40

Returns

None