KeyPairExists

class EC2.Waiter.KeyPairExists
waiter = client.get_waiter('key_pair_exists')
wait(**kwargs)

Polls EC2.Client.describe_key_pairs() every 5 seconds until a successful state is reached. An error is returned after 6 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    KeyNames=[
        'string',
    ],
    KeyPairIds=[
        'string',
    ],
    DryRun=True|False,
    IncludePublicKey=True|False,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • 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.
    • (dict) --

      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) --
  • KeyNames (list) --

    The key pair names.

    Default: Describes all of your key pairs.

    • (string) --
  • KeyPairIds (list) --

    The IDs of the key pairs.

    • (string) --
  • DryRun (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 .
  • IncludePublicKey (boolean) --

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

    Default: false

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 5

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 6

Returns

None