EKS / Client / cancel_update

cancel_update¶

EKS.Client.cancel_update(**kwargs)¶

Cancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this is supported for VersionRollback update types on EKS Auto Mode clusters when nodes are rolling back.

A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails.

Request Syntax

response = client.cancel_update(
    name='string',
    updateId='string',
    clientRequestToken='string'
)

Parameters:

name (string) –
[REQUIRED]

The name of the Amazon EKS cluster associated with the update.
updateId (string) –
[REQUIRED]

The ID of the update to cancel.
clientRequestToken (string) –
A 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'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate'|'CapabilityUpdate'|'ControlPlaneScalingConfigUpdate'|'VendedLogsUpdate'|'ControlPlaneEgressUpdate'|'VersionRollback',
        'params': [
            {
                'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection'|'NodeRepairConfig'|'RoleArn'|'RoleMappingsToAddOrUpdate'|'RoleMappingsToRemove'|'NetworkAccess'|'VendedLogs'|'UpdatedTier'|'PreviousTier'|'WarmPoolEnabled'|'WarmPoolMaxGroupPreparedCapacity'|'WarmPoolMinSize'|'WarmPoolState'|'WarmPoolReuseOnScaleIn'|'ControlPlaneEgressMode',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'errors': [
            {
                'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound',
                'errorMessage': 'string',
                'resourceIds': [
                    'string',
                ]
            },
        ],
        'cancellation': {
            'status': 'InProgress'|'Failed'|'Successful',
            'reason': '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 at object creation.
  - 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: We couldn’t find one of the subnets associated with the cluster.
        
        SecurityGroupNotFound: We couldn’t find one of the security groups associated with the cluster.
        
        EniLimitReached: You have reached the elastic network interface limit for your account.
        
        IpNotAvailable: A subnet associated with the cluster doesn’t have any available IP addresses.
        
        AccessDenied: You don’t have permissions to perform the specified operation.
        
        OperationNotPermitted: The service role associated with the cluster doesn’t have the required access permissions for Amazon EKS.
        
        VpcIdNotFound: We couldn’t find the VPC associated with the cluster.
      - errorMessage (string) –
        
        A more complete description of the error.
      - resourceIds (list) –
        
        An optional field that contains the resource IDs associated with the error.
        
        (string) –
  - cancellation (dict) –
    
    The latest cancellation information for the update. This field is present only if any cancellation is attempted for the update.
    - status (string) –
      
      The current status of the cancellation. Valid values are InProgress, Failed, and Successful.
    - reason (string) –
      
      A message providing additional details about the cancellation, such as the reason for the cancellation or failure details.

Exceptions

EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ServerException
EKS.Client.exceptions.ResourceInUseException
EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.InvalidRequestException
EKS.Client.exceptions.ThrottlingException
EKS.Client.exceptions.InvalidStateException