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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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)


21702
21703
21704
21705
21706
21707
21708
21709
21710
# File 'lib/aws-sdk-ec2/types.rb', line 21702

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :key_pair_ids,
  :dry_run,
  :include_public_key)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<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`:&lt;key&gt; - 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:



21702
21703
21704
21705
21706
21707
21708
21709
21710
# File 'lib/aws-sdk-ec2/types.rb', line 21702

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :key_pair_ids,
  :dry_run,
  :include_public_key)
  SENSITIVE = []
  include Aws::Structure
end

#include_public_keyBoolean

If ‘true`, the public key material is included in the response.

Default: ‘false`

Returns:

  • (Boolean)


21702
21703
21704
21705
21706
21707
21708
21709
21710
# File 'lib/aws-sdk-ec2/types.rb', line 21702

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :key_pair_ids,
  :dry_run,
  :include_public_key)
  SENSITIVE = []
  include Aws::Structure
end

#key_namesArray<String>

The key pair names.

Default: Describes all of your key pairs.

Returns:

  • (Array<String>)


21702
21703
21704
21705
21706
21707
21708
21709
21710
# File 'lib/aws-sdk-ec2/types.rb', line 21702

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :key_pair_ids,
  :dry_run,
  :include_public_key)
  SENSITIVE = []
  include Aws::Structure
end

#key_pair_idsArray<String>

The IDs of the key pairs.

Returns:

  • (Array<String>)


21702
21703
21704
21705
21706
21707
21708
21709
21710
# File 'lib/aws-sdk-ec2/types.rb', line 21702

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :key_pair_ids,
  :dry_run,
  :include_public_key)
  SENSITIVE = []
  include Aws::Structure
end