describe_key_pairs ¶

def describe_key_pairs(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    key_names: Optional[
        "capo_ec2.types.key_name_string_list.KeyNameStringList"
    ] = None,
    key_pair_ids: Optional[
        "capo_ec2.types.key_pair_id_string_list.KeyPairIdStringList"
    ] = None,
    include_public_key: Optional["capo_ec2.types.boolean.Boolean"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_key_pairs_result.DescribeKeyPairsResult":
    """<p>Describes the specified key pairs or all of your key pairs.</p> <p>For more information about key pairs, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        key_names: <p>The key pair names.</p> <p>Default: Describes all of your key pairs.</p>
        key_pair_ids: <p>The IDs of the key pairs.</p>
        include_public_key: <p>If <code>true</code>, the public key material is included in the response.</p> <p>Default: <code>false</code> </p>
        dry_run: <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: <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>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To display a key pair
        This example displays the fingerprint for the specified key.

        >>> client.describe_key_pairs(key_names=['my-key-pair'])
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_key_pairs_request.DescribeKeyPairsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_key_pairs_result.DescribeKeyPairsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_key_pairs

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_key_pairs.describe_key_pairs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeKeyPairs")
    )
    input_: capo_ec2.types.describe_key_pairs_request.DescribeKeyPairsRequest = {}
    if key_names is not None:
        input_["key_names"] = key_names
    if key_pair_ids is not None:
        input_["key_pair_ids"] = key_pair_ids
    if include_public_key is not None:
        input_["include_public_key"] = include_public_key
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output