You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::DescribeKeyPairsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeKeyPairsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  key_names: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeKeyPairs.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#filtersArray<Types::Filter>

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

Returns:

#key_namesArray<String>

One or more key pair names.

Default: Describes all your key pairs.

Returns:

  • (Array<String>)

    One or more key pair names.