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

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)


16387
16388
16389
16390
16391
16392
16393
16394
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16387

class DescribeKeyPairsRequest < Struct.new(
  :filters,
  :key_names,
  :key_pair_ids,
  :dry_run)
  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:<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:



16387
16388
16389
16390
16391
16392
16393
16394
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16387

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

#key_namesArray<String>

The key pair names.

Default: Describes all your key pairs.

Returns:

  • (Array<String>)


16387
16388
16389
16390
16391
16392
16393
16394
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16387

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

#key_pair_idsArray<String>

The IDs of the key pairs.

Returns:

  • (Array<String>)


16387
16388
16389
16390
16391
16392
16393
16394
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16387

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