Skip to content

DescribeKeyPairsRequest

Source code in docs_src/capo_ec2/types/describe_key_pairs_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class DescribeKeyPairsRequest(TypedDict, closed=True):
    key_names: NotRequired["capo_ec2.types.key_name_string_list.KeyNameStringList"]
    """<p>The key pair names.</p> <p>Default: Describes all of your key pairs.</p>"""
    key_pair_ids: NotRequired[
        "capo_ec2.types.key_pair_id_string_list.KeyPairIdStringList"
    ]
    """<p>The IDs of the key pairs.</p>"""
    include_public_key: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>If <code>true</code>, the public key material is included in the response.</p> <p>Default: <code>false</code> </p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>The filters.</p> <ul> <li> <p> <code>key-pair-id</code> - The ID of the key pair.</p> </li> <li> <p> <code>fingerprint</code> - The fingerprint of the key pair.</p> </li> <li> <p> <code>key-name</code> - The name of the key pair.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> </ul>"""

dry_run instance-attribute 

dry_run: NotRequired[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 instance-attribute 

filters: NotRequired[FilterList]

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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

include_public_key instance-attribute 

include_public_key: NotRequired[Boolean]

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

Default: false

key_names instance-attribute 

key_names: NotRequired[KeyNameStringList]

The key pair names.

Default: Describes all of your key pairs.

key_pair_ids instance-attribute 

key_pair_ids: NotRequired[KeyPairIdStringList]

The IDs of the key pairs.