aws_sdk_ec2/client/

describe_capacity_reservation_billing_requests.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCapacityReservationBillingRequests`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`capacity_reservation_ids(impl Into<String>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::capacity_reservation_ids) / [`set_capacity_reservation_ids(Option<Vec::<String>>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::set_capacity_reservation_ids):<br>required: **false**<br><p>The ID of the Capacity Reservation.</p><br>
    ///   - [`role(CallerRole)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::role) / [`set_role(Option<CallerRole>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::set_role):<br>required: **true**<br><p>Specify one of the following:</p> <ul>  <li>   <p><code>odcr-owner</code> - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the <code>requested-by</code> filter.</p></li>  <li>   <p><code>unused-reservation-billing-owner</code> - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the <code>unused-reservation-billing-owner</code> filter.</p></li> </ul><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters.</p> <ul>  <li>   <p><code>status</code> - The state of the request (<code>pending</code> | <code>accepted</code> | <code>rejected</code> | <code>cancelled</code> | <code>revoked</code> | <code>expired</code>).</p></li>  <li>   <p><code>requested-by</code> - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify <code>requested-by</code> for <b>Role</b>.</p></li>  <li>   <p><code>unused-reservation-billing-owner</code> - The ID of the consumer account to which the request was sent. Not supported if you specify <code>unused-reservation-billing-owner</code> for <b>Role</b>.</p></li> </ul><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
    /// - On success, responds with [`DescribeCapacityReservationBillingRequestsOutput`](crate::operation::describe_capacity_reservation_billing_requests::DescribeCapacityReservationBillingRequestsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_capacity_reservation_billing_requests::DescribeCapacityReservationBillingRequestsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    ///   - [`capacity_reservation_billing_requests(Option<Vec::<CapacityReservationBillingRequest>>)`](crate::operation::describe_capacity_reservation_billing_requests::DescribeCapacityReservationBillingRequestsOutput::capacity_reservation_billing_requests): <p>Information about the request.</p>
    /// - On failure, responds with [`SdkError<DescribeCapacityReservationBillingRequestsError>`](crate::operation::describe_capacity_reservation_billing_requests::DescribeCapacityReservationBillingRequestsError)
    pub fn describe_capacity_reservation_billing_requests(
        &self,
    ) -> crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder {
        crate::operation::describe_capacity_reservation_billing_requests::builders::DescribeCapacityReservationBillingRequestsFluentBuilder::new(
            self.handle.clone(),
        )
    }
}