describe_host_reservations ¶

def describe_host_reservations(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    filter: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    host_reservation_id_set: Optional[
        "capo_ec2.types.host_reservation_id_set.HostReservationIdSet"
    ] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.describe_host_reservations_result.DescribeHostReservationsResult":
    """<p>Describes reservations that are associated with Dedicated Hosts in your account.</p>

    Args:
        filter: <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance family (for example, <code>m4</code>).</p> </li> <li> <p> <code>payment-option</code> - The payment option (<code>NoUpfront</code> | <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p> <code>state</code> - The state of the reservation (<code>payment-pending</code> | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p> </li> <li> <p> <code>tag:<key></code> - 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> <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> </ul>
        host_reservation_id_set: <p>The host reservation IDs.</p>
        max_results: <p>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_host_reservations_request.DescribeHostReservationsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_host_reservations_result.DescribeHostReservationsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_host_reservations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeHostReservations")
    )
    input_: capo_ec2.types.describe_host_reservations_request.DescribeHostReservationsRequest = {}
    if filter is not None:
        input_["filter"] = filter
    if host_reservation_id_set is not None:
        input_["host_reservation_id_set"] = host_reservation_id_set
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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