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: ["KeyPairName"],
  key_pair_ids: ["KeyPairId"],
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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.

#filters ⇒ Array<Types::Filter>

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:<key> - 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.

Returns:

#key_names ⇒ Array<String>

The key pair names.

Default: Describes all your key pairs.

Returns:

  • (Array<String>) —

    The key pair names.

#key_pair_ids ⇒ Array<String>

The IDs of the key pairs.

Returns:

  • (Array<String>) —

    The IDs of the key pairs.