Skip to content

Describe Key Pairs

ec2_describe_key_pairs R Documentation

Describes the specified key pairs or all of your key pairs

Description

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

Usage

ec2_describe_key_pairs(Filters, KeyNames, KeyPairIds, DryRun,
  IncludePublicKey)

Arguments

Filters

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.

KeyNames

The key pair names.

Default: Describes all of your key pairs.

KeyPairIds

The IDs of the key pairs.

DryRun

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.

IncludePublicKey

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

Default: false

Value

A list with the following syntax: 

list(
  KeyPairs = list(
    list(
      KeyPairId = "string",
      KeyFingerprint = "string",
      KeyName = "string",
      KeyType = "rsa"|"ed25519",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      PublicKey = "string",
      CreateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_key_pairs(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  KeyNames = list(
    "string"
  ),
  KeyPairIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  IncludePublicKey = TRUE|FALSE
)

Examples

## Not run: 
# This example displays the fingerprint for the specified key.
svc$describe_key_pairs(
  KeyNames = list(
    "my-key-pair"
  )
)

## End(Not run)