ec2_describe_key_pairs {aws.ecx} | R Documentation |
Describe Key Pairs
Description
Describe Key Pairs
Usage
ec2_describe_key_pairs(
Filter = NULL,
KeyName = NULL,
KeyPairId = NULL,
DryRun = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
Filter |
Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional] |
KeyName |
List. The key pair names. Default: Describes all your key pairs. [optional] |
KeyPairId |
List. The IDs of the key pairs.[optional] |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
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
:\ - 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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.
KeyName
The key pair names.
Default: Describes all your key pairs.
KeyPairId
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
.