key-pair-exists¶

Description¶

Wait until JMESPath query length(KeyPairs[].KeyName) > 0 returns True when polling with describe-key-pairs. It will poll every 5 seconds until a successful state has been reached. This will exit with a return code of 255 after 6 failed checks.

Synopsis¶

  key-pair-exists
[--filters <value>]
[--key-names <value>]
[--key-pair-ids <value>]
[--dry-run | --no-dry-run]
[--include-public-key | --no-include-public-key]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

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.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--key-names (list)

The key pair names.

Default: Describes all of your key pairs.

(string)

Syntax:

"string" "string" ...

--key-pair-ids (list)

The IDs of the key pairs.

(string)

Syntax:

"string" "string" ...

--dry-run | --no-dry-run (boolean)

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 .

--include-public-key | --no-include-public-key (boolean)

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

Default: false

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To wait until a key pair exists

The following wait key-pair-exists example pauses and resumes running only after it confirms that the specified key pair exists. It produces no output.

aws ec2 wait key-pair-exists \
    --key-names my-key-pair

Output¶

None

Table of Contents

Feedback

User Guide