:doc:`IAM <../../iam>` / Client / get_ssh_public_key

******************
get_ssh_public_key
******************



.. py:method:: IAM.Client.get_ssh_public_key(**kwargs)

  

  Retrieves the specified SSH public key, including metadata about the key.

   

  The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see `Set up CodeCommit for SSH connections <https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html>`__ in the *CodeCommit User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/GetSSHPublicKey>`_  


  **Request Syntax**
  ::

    response = client.get_ssh_public_key(
        UserName='string',
        SSHPublicKeyId='string',
        Encoding='SSH'|'PEM'
    )
    
  :type UserName: string
  :param UserName: **[REQUIRED]** 

    The name of the IAM user associated with the SSH public key.

     

    This parameter allows (through its `regex pattern <http://wikipedia.org/wiki/regex>`__) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    

  
  :type SSHPublicKeyId: string
  :param SSHPublicKeyId: **[REQUIRED]** 

    The unique identifier for the SSH public key.

     

    This parameter allows (through its `regex pattern <http://wikipedia.org/wiki/regex>`__) a string of characters that can consist of any upper or lowercased letter or digit.

    

  
  :type Encoding: string
  :param Encoding: **[REQUIRED]** 

    Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use ``SSH``. To retrieve the public key in PEM format, use ``PEM``.

    

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

    
    ::

      {
          'SSHPublicKey': {
              'UserName': 'string',
              'SSHPublicKeyId': 'string',
              'Fingerprint': 'string',
              'SSHPublicKeyBody': 'string',
              'Status': 'Active'|'Inactive'|'Expired',
              'UploadDate': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the response to a successful `GetSSHPublicKey <https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetSSHPublicKey.html>`__ request.

      
      

      - **SSHPublicKey** *(dict) --* 

        A structure containing details about the SSH public key.

        
        

        - **UserName** *(string) --* 

          The name of the IAM user associated with the SSH public key.

          
        

        - **SSHPublicKeyId** *(string) --* 

          The unique identifier for the SSH public key.

          
        

        - **Fingerprint** *(string) --* 

          The MD5 message digest of the SSH public key.

          
        

        - **SSHPublicKeyBody** *(string) --* 

          The SSH public key.

          
        

        - **Status** *(string) --* 

          The status of the SSH public key. ``Active`` means that the key can be used for authentication with an CodeCommit repository. ``Inactive`` means that the key cannot be used.

          
        

        - **UploadDate** *(datetime) --* 

          The date and time, in `ISO 8601 date-time format <http://www.iso.org/iso/iso8601>`__, when the SSH public key was uploaded.

          
    
  
  **Exceptions**
  
  *   :py:class:`IAM.Client.exceptions.NoSuchEntityException`

  
  *   :py:class:`IAM.Client.exceptions.UnrecognizedPublicKeyEncodingException`

  