Class UpdateSSHPublicKeyCommandProtected

Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected 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, UpdateSSHPublicKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, UpdateSSHPublicKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // UpdateSSHPublicKeyRequest
  UserName: "STRING_VALUE", // required
  SSHPublicKeyId: "STRING_VALUE", // required
  Status: "Active" || "Inactive", // required
};
const command = new UpdateSSHPublicKeyCommand(input);
const response = await client.send(command);
// {};

Param

UpdateSSHPublicKeyCommandInput

Returns

UpdateSSHPublicKeyCommandOutput

See

• UpdateSSHPublicKeyCommandInput for command's input shape.
• UpdateSSHPublicKeyCommandOutput 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

IAMServiceException

Base exception class for all service exceptions from IAM service.