Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DescribeKeyPairsCommand

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide.

Example Syntax

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

import { EC2Client, DescribeKeyPairsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeKeyPairsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeKeyPairsRequest
  KeyNames: [ // KeyNameStringList
    "STRING_VALUE",
  ],
  KeyPairIds: [ // KeyPairIdStringList
    "STRING_VALUE",
  ],
  IncludePublicKey: true || false,
  DryRun: true || false,
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new DescribeKeyPairsCommand(input);
const response = await client.send(command);
// { // DescribeKeyPairsResult
//   KeyPairs: [ // KeyPairList
//     { // KeyPairInfo
//       KeyPairId: "STRING_VALUE",
//       KeyType: "rsa" || "ed25519",
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       PublicKey: "STRING_VALUE",
//       CreateTime: new Date("TIMESTAMP"),
//       KeyName: "STRING_VALUE",
//       KeyFingerprint: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

Loading code editor

DescribeKeyPairsCommand Input

See DescribeKeyPairsCommandInput for more details

Parameter	Type	Description
`DryRun`	`boolean \| undefined`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
`Filters`	`Filter[] \| undefined`	The filters. `key-pair-id` - The ID of the key pair. `fingerprint` - The fingerprint of the key pair. `key-name` - The name of the key pair. `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.
`IncludePublicKey`	`boolean \| undefined`	If `true`, the public key material is included in the response. Default: `false`
`KeyNames`	`string[] \| undefined`	The key pair names. Default: Describes all of your key pairs.
`KeyPairIds`	`string[] \| undefined`	The IDs of the key pairs.

DescribeKeyPairsCommand Output

See DescribeKeyPairsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`KeyPairs`	`KeyPairInfo[] \| undefined`	Information about the key pairs.

Throws

Name	Fault	Details
EC2ServiceException		Base exception class for all service exceptions from EC2 service.

Getting Started

References