EKS / Client / describe_nodegroup

describe_nodegroup#

EKS.Client.describe_nodegroup(**kwargs)#

Returns descriptive information about an Amazon EKS node group.

Request Syntax

response = client.describe_nodegroup(
    clusterName='string',
    nodegroupName='string'
)

Parameters:

clusterName (string) –
[REQUIRED]

The name of the Amazon EKS cluster associated with the node group.
nodegroupName (string) –
[REQUIRED]

The name of the node group to describe.

Return type:

dict

Returns:

Response Syntax

{
    'nodegroup': {
        'nodegroupName': 'string',
        'nodegroupArn': 'string',
        'clusterName': 'string',
        'version': 'string',
        'releaseVersion': 'string',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1),
        'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED',
        'capacityType': 'ON_DEMAND'|'SPOT',
        'scalingConfig': {
            'minSize': 123,
            'maxSize': 123,
            'desiredSize': 123
        },
        'instanceTypes': [
            'string',
        ],
        'subnets': [
            'string',
        ],
        'remoteAccess': {
            'ec2SshKey': 'string',
            'sourceSecurityGroups': [
                'string',
            ]
        },
        'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64'|'CUSTOM'|'BOTTLEROCKET_ARM_64'|'BOTTLEROCKET_x86_64'|'BOTTLEROCKET_ARM_64_NVIDIA'|'BOTTLEROCKET_x86_64_NVIDIA'|'WINDOWS_CORE_2019_x86_64'|'WINDOWS_FULL_2019_x86_64'|'WINDOWS_CORE_2022_x86_64'|'WINDOWS_FULL_2022_x86_64',
        'nodeRole': 'string',
        'labels': {
            'string': 'string'
        },
        'taints': [
            {
                'key': 'string',
                'value': 'string',
                'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE'
            },
        ],
        'resources': {
            'autoScalingGroups': [
                {
                    'name': 'string'
                },
            ],
            'remoteAccessSecurityGroup': 'string'
        },
        'diskSize': 123,
        'health': {
            'issues': [
                {
                    'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'Ec2SubnetMissingIpv6Assignment'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'AmiIdNotFound'|'AutoScalingGroupOptInRequired'|'AutoScalingGroupRateLimitExceeded'|'Ec2LaunchTemplateDeletionFailure'|'Ec2LaunchTemplateInvalidConfiguration'|'Ec2LaunchTemplateMaxLimitExceeded'|'Ec2SubnetListTooLong'|'IamThrottling'|'NodeTerminationFailure'|'PodEvictionFailure'|'SourceEc2LaunchTemplateNotFound'|'LimitExceeded'|'Unknown'|'AutoScalingGroupInstanceRefreshActive',
                    'message': 'string',
                    'resourceIds': [
                        'string',
                    ]
                },
            ]
        },
        'updateConfig': {
            'maxUnavailable': 123,
            'maxUnavailablePercentage': 123
        },
        'launchTemplate': {
            'name': 'string',
            'version': 'string',
            'id': 'string'
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) –
- nodegroup (dict) –
  
  The full description of your node group.
  - nodegroupName (string) –
    
    The name associated with an Amazon EKS managed node group.
  - nodegroupArn (string) –
    
    The Amazon Resource Name (ARN) associated with the managed node group.
  - clusterName (string) –
    
    The name of the cluster that the managed node group resides in.
  - version (string) –
    
    The Kubernetes version of the managed node group.
  - releaseVersion (string) –
    
    If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren’t deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.
  - createdAt (datetime) –
    
    The Unix epoch timestamp in seconds for when the managed node group was created.
  - modifiedAt (datetime) –
    
    The Unix epoch timestamp in seconds for when the managed node group was last modified.
  - status (string) –
    
    The current status of the managed node group.
  - capacityType (string) –
    
    The capacity type of your managed node group.
  - scalingConfig (dict) –
    
    The scaling configuration details for the Auto Scaling group that is associated with your node group.
    - minSize (integer) –
      
      The minimum number of nodes that the managed node group can scale in to.
    - maxSize (integer) –
      
      The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.
    - desiredSize (integer) –
      
      The current number of nodes that the managed node group should maintain.
      
      Warning
      If you use Cluster Autoscaler, you shouldn’t change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.
      
      Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.
      
      This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is altered by Cluster Autoscaler (but can be out-of-date for short periods of time). Cluster Autoscaler doesn’t scale a managed node group lower than minSize or higher than maxSize.
  - instanceTypes (list) –
    
    If the node group wasn’t deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.
    - (string) –
  - subnets (list) –
    
    The subnets that were specified for the Auto Scaling group that is associated with your node group.
    - (string) –
  - remoteAccess (dict) –
    
    If the node group wasn’t deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.
    - ec2SshKey (string) –
      
      The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see Amazon EC2 key pairs and Windows instances in the Amazon Elastic Compute Cloud User Guide for Windows Instances.
    - sourceSecurityGroups (list) –
      
      The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don’t specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( 0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
      - (string) –
  - amiType (string) –
    
    If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren’t deployed using a launch template, this is the AMI type that was specified in the node group configuration.
  - nodeRole (string) –
    
    The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.
  - labels (dict) –
    
    The Kubernetes labels applied to the nodes in the node group.
    
    Note
    Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.
    - (string) –
      - (string) –
  - taints (list) –
    
    The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups.
    - (dict) –
      
      A property that allows a node to repel a set of pods. For more information, see Node taints on managed node groups.
      - key (string) –
        
        The key of the taint.
      - value (string) –
        
        The value of the taint.
      - effect (string) –
        
        The effect of the taint.
  - resources (dict) –
    
    The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
    - autoScalingGroups (list) –
      
      The Auto Scaling groups associated with the node group.
      - (dict) –
        
        An Auto Scaling group that is associated with an Amazon EKS managed node group.
        
        name (string) –
        
        The name of the Auto Scaling group associated with an Amazon EKS managed node group.
    - remoteAccessSecurityGroup (string) –
      
      The remote access security group associated with the node group. This security group controls SSH access to the nodes.
  - diskSize (integer) –
    
    If the node group wasn’t deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.
  - health (dict) –
    
    The health status of the node group. If there are issues with your node group’s health, they are listed here.
    - issues (list) –
      
      Any issues that are associated with the node group.
      - (dict) –
        
        An object representing an issue with an Amazon EKS resource.
        
        code (string) –
        
        A brief description of the error.
        
        AccessDenied: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.
        
        AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
        
        AutoScalingGroupNotFound: We couldn’t find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.
        
        ClusterUnreachable: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests.
        
        Ec2LaunchTemplateNotFound: We couldn’t find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.
        
        Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.
        
        Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
        
        Ec2SecurityGroupNotFound: We couldn’t find the cluster security group for the cluster. You must recreate your cluster.
        
        Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the auto-assign public IP address setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the Amazon VPC User Guide.
        
        IamInstanceProfileNotFound: We couldn’t find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.
        
        IamNodeRoleNotFound: We couldn’t find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.
        
        InstanceLimitExceeded: Your Amazon Web Services account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.
        
        InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.
        
        InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
        
        NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes.
        
        message (string) –
        
        The error message associated with the issue.
        
        resourceIds (list) –
        
        The Amazon Web Services resources that are afflicted by this issue.
        
        (string) –
  - updateConfig (dict) –
    
    The node group update configuration.
    - maxUnavailable (integer) –
      
      The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    - maxUnavailablePercentage (integer) –
      
      The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
  - launchTemplate (dict) –
    
    If a launch template was used to create the node group, then this is the launch template that was used.
    - name (string) –
      
      The name of the launch template.
      
      You must specify either the launch template name or the launch template ID in the request, but not both.
    - version (string) –
      
      The version number of the launch template to use. If no version is specified, then the template’s default version is used.
    - id (string) –
      
      The ID of the launch template.
      
      You must specify either the launch template ID or the launch template name in the request, but not both.
  - tags (dict) –
    
    The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
    - (string) –
      
      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
      - (string) –
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Exceptions

EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ServerException
EKS.Client.exceptions.ServiceUnavailableException