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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeKeyPairsRequest data as a hash:

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

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)


14822
14823
14824
14825
14826
14827
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14822

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

The filters.

  • fingerprint - The fingerprint of the key pair.

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

Returns:



14822
14823
14824
14825
14826
14827
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14822

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :dry_run)
  include Aws::Structure
end

#key_namesArray<String>

The key pair names.

Default: Describes all your key pairs.

Returns:

  • (Array<String>)


14822
14823
14824
14825
14826
14827
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14822

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :dry_run)
  include Aws::Structure
end