:doc:`Lightsail <../../lightsail>` / Client / delete_key_pair

***************
delete_key_pair
***************



.. py:method:: Lightsail.Client.delete_key_pair(**kwargs)

  

  Deletes the specified key pair by removing the public key from Amazon Lightsail.

   

  You can delete key pairs that were created using the `ImportKeyPair <https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html>`__ and `CreateKeyPair <https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html>`__ actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the `DownloadDefaultKeyPair <https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html>`__ API.

   

  The ``delete key pair`` operation supports tag-based access control via resource tags applied to the resource identified by ``key pair name``. For more information, see the `Amazon Lightsail Developer Guide <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPair>`_  


  **Request Syntax**
  ::

    response = client.delete_key_pair(
        keyPairName='string',
        expectedFingerprint='string'
    )
    
  :type keyPairName: string
  :param keyPairName: **[REQUIRED]** 

    The name of the key pair to delete.

    

  
  :type expectedFingerprint: string
  :param expectedFingerprint: 

    The RSA fingerprint of the Lightsail default key pair to delete.

     

    .. note::

      

      The ``expectedFingerprint`` parameter is required only when specifying to delete a Lightsail default key pair.

      

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'operation': {
              'id': 'string',
              'resourceName': 'string',
              'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
              'createdAt': datetime(2015, 1, 1),
              'location': {
                  'availabilityZone': 'string',
                  'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'|'ap-southeast-3'
              },
              'isTerminal': True|False,
              'operationDetails': 'string',
              'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps',
              'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
              'statusChangedAt': datetime(2015, 1, 1),
              'errorCode': 'string',
              'errorDetails': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **operation** *(dict) --* 

        An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

        
        

        - **id** *(string) --* 

          The ID of the operation.

          
        

        - **resourceName** *(string) --* 

          The resource name.

          
        

        - **resourceType** *(string) --* 

          The resource type.

          
        

        - **createdAt** *(datetime) --* 

          The timestamp when the operation was initialized ( ``1479816991.349``).

          
        

        - **location** *(dict) --* 

          The Amazon Web Services Region and Availability Zone.

          
          

          - **availabilityZone** *(string) --* 

            The Availability Zone. Follows the format ``us-east-2a`` (case-sensitive).

            
          

          - **regionName** *(string) --* 

            The Amazon Web Services Region name.

            
      
        

        - **isTerminal** *(boolean) --* 

          A Boolean value indicating whether the operation is terminal.

          
        

        - **operationDetails** *(string) --* 

          Details about the operation ( ``Debian-1GB-Ohio-1``).

          
        

        - **operationType** *(string) --* 

          The type of operation.

          
        

        - **status** *(string) --* 

          The status of the operation.

          
        

        - **statusChangedAt** *(datetime) --* 

          The timestamp when the status was changed ( ``1479816991.349``).

          
        

        - **errorCode** *(string) --* 

          The error code.

          
        

        - **errorDetails** *(string) --* 

          The error details.

          
    
  
  **Exceptions**
  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.OperationFailureException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccountSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  