EKS / Client / disassociate_identity_provider_config

disassociate_identity_provider_config#

EKS.Client.disassociate_identity_provider_config(**kwargs)#

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

response = client.disassociate_identity_provider_config(
    clusterName='string',
    identityProviderConfig={
        'type': 'string',
        'name': 'string'
    },
    clientRequestToken='string'
)

Parameters:

clusterName (string) –
[REQUIRED]

The name of your cluster.
identityProviderConfig (dict) –
[REQUIRED]

An object representing an identity provider configuration.
- type (string) – [REQUIRED]
  
  The type of the identity provider configuration. The only type available is oidc.
- name (string) – [REQUIRED]
  
  The name of the identity provider configuration.
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',
        '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'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig',
                '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',
                ]
            },
        ]
    }
}

Response Structure

(dict) –
- update (dict) –
  
  An object representing an asynchronous 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) –

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