Skip to content

IAM  >  Operations  >  get_ssh_public_key

get_ssh_public_key

Operation

get_ssh_public_key async 

get_ssh_public_key(input: GetSSHPublicKeyInput, plugins: list[Plugin] | None = None) -> GetSSHPublicKeyOutput

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 in the CodeCommit User Guide.

Parameters:

Name Type Description Default
input GetSSHPublicKeyInput

An instance of GetSSHPublicKeyInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetSSHPublicKeyOutput

An instance of GetSSHPublicKeyOutput.

Input

GetSSHPublicKeyInput dataclass

Bases: _SerdeShape

Dataclass for GetSSHPublicKeyInput structure.

Attributes

encoding class-attribute instance-attribute 
encoding: str | None = ...

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.

ssh_public_key_id class-attribute instance-attribute 
ssh_public_key_id: str | None = ...

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

user_name class-attribute instance-attribute 
user_name: str | None = ...

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

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: _+=,.@-

Output

GetSSHPublicKeyOutput dataclass

Bases: _SerdeShape

Contains the response to a successful GetSSHPublicKey request.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

ssh_public_key class-attribute instance-attribute 
ssh_public_key: SSHPublicKey | None = ...

A structure containing details about the SSH public key.