aws_sdk_ec2/client/

describe_capacity_reservation_topology.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCapacityReservationTopology`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dry_run(bool)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the operation, 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>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::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> <p>You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.</p> <p>Default: <code>10</code></p><br>
    ///   - [`capacity_reservation_ids(impl Into<String>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::capacity_reservation_ids) / [`set_capacity_reservation_ids(Option<Vec::<String>>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::set_capacity_reservation_ids):<br>required: **false**<br><p>The Capacity Reservation IDs.</p> <p>Default: Describes all your Capacity Reservations.</p> <p>Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>availability-zone</code> - The name of the Availability Zone (for example, <code>us-west-2a</code>) or Local Zone (for example, <code>us-west-2-lax-1b</code>) that the Capacity Reservation is in.</p></li>  <li>   <p><code>instance-type</code> - The instance type (for example, <code>p4d.24xlarge</code>) or instance family (for example, <code>p4d*</code>). You can use the <code>*</code> wildcard to match zero or more characters, or the <code>?</code> wildcard to match zero or one character.</p></li> </ul><br>
    /// - On success, responds with [`DescribeCapacityReservationTopologyOutput`](crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
    ///   - [`capacity_reservations(Option<Vec::<CapacityReservationTopology>>)`](crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyOutput::capacity_reservations): <p>Information about the topology of each Capacity Reservation.</p>
    /// - On failure, responds with [`SdkError<DescribeCapacityReservationTopologyError>`](crate::operation::describe_capacity_reservation_topology::DescribeCapacityReservationTopologyError)
    pub fn describe_capacity_reservation_topology(
        &self,
    ) -> crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder {
        crate::operation::describe_capacity_reservation_topology::builders::DescribeCapacityReservationTopologyFluentBuilder::new(self.handle.clone())
    }
}