ServiceResource / Collection / key_pairs

key_pairs¶

EC2.ServiceResource.key_pairs¶

A collection of KeyPairInfo resources.A KeyPairInfo Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()¶

Creates an iterable of all KeyPairInfo resources in the collection.

See also: AWS API Documentation

Request Syntax

key_pair_info_iterator = ec2.key_pairs.all()

Return type:: list(ec2.KeyPairInfo)
Returns:: A list of KeyPairInfo resources

filter(**kwargs)¶

Creates an iterable of all KeyPairInfo resources in the collection filtered by kwargs passed to method. A KeyPairInfo collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

key_pair_info_iterator = ec2.key_pairs.filter(
    KeyNames=[
        'string',
    ],
    KeyPairIds=[
        'string',
    ],
    IncludePublicKey=True|False,
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

KeyNames (list) –
The key pair names.

Default: Describes all of your key pairs.
- (string) –
KeyPairIds (list) –
The IDs of the key pairs.
- (string) –
IncludePublicKey (boolean) –
If true, the public key material is included in the response.

Default: false
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.
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.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - 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) –

Return type:

list(ec2.KeyPairInfo)

Returns:

A list of KeyPairInfo resources

limit(**kwargs)¶

Creates an iterable up to a specified amount of KeyPairInfo resources in the collection.

See also: AWS API Documentation

Request Syntax

key_pair_info_iterator = ec2.key_pairs.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(ec2.KeyPairInfo)
Returns:: A list of KeyPairInfo resources

page_size(**kwargs)¶

Creates an iterable of all KeyPairInfo resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

key_pair_info_iterator = ec2.key_pairs.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(ec2.KeyPairInfo)
Returns:: A list of KeyPairInfo resources