IAM / Client / upload_ssh_public_key

upload_ssh_public_key#

IAM.Client.upload_ssh_public_key(**kwargs)#

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this operation can be 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 in the CodeCommit User Guide.

See also: AWS API Documentation

Request Syntax

response = client.upload_ssh_public_key(
    UserName='string',
    SSHPublicKeyBody='string'
)
Parameters:

  • UserName (string) –

    [REQUIRED]

    The name of the IAM user to associate the SSH public key with.

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

  • SSHPublicKeyBody (string) –

    [REQUIRED]

    The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

    The regex pattern used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character ( \u0020) through the end of the ASCII character range

    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    • The special characters tab ( \u0009), line feed ( \u000A), and carriage return ( \u000D)

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Contains the response to a successful UploadSSHPublicKey request.

    • SSHPublicKey (dict) –

      Contains information 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, when the SSH public key was uploaded.

Exceptions