Class GetSSHPublicKeyCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, GetSSHPublicKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetSSHPublicKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetSSHPublicKeyRequest
  UserName: "STRING_VALUE", // required
  SSHPublicKeyId: "STRING_VALUE", // required
  Encoding: "SSH" || "PEM", // required
};
const command = new GetSSHPublicKeyCommand(input);
const response = await client.send(command);
// { // GetSSHPublicKeyResponse
//   SSHPublicKey: { // SSHPublicKey
//     UserName: "STRING_VALUE", // required
//     SSHPublicKeyId: "STRING_VALUE", // required
//     Fingerprint: "STRING_VALUE", // required
//     SSHPublicKeyBody: "STRING_VALUE", // required
//     Status: "Active" || "Inactive", // required
//     UploadDate: new Date("TIMESTAMP"),
//   },
// };

Param

GetSSHPublicKeyCommandInput

Returns

GetSSHPublicKeyCommandOutput

See

• GetSSHPublicKeyCommandInput for command's input shape.
• GetSSHPublicKeyCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

UnrecognizedPublicKeyEncodingException (client fault)

The request was rejected because the public key encoding format is unsupported or unrecognized.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.