aws_sdk_ec2/client/

describe_capacity_block_status.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCapacityBlockStatus`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`capacity_block_ids(impl Into<String>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::capacity_block_ids) / [`set_capacity_block_ids(Option<Vec::<String>>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::set_capacity_block_ids):<br>required: **false**<br><p>The ID of the Capacity Block.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::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_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::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_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters.</p> <ul>  <li>   <p><code>interconnect-status</code> - The status of the interconnect for the Capacity Block (<code>ok</code> | <code>impaired</code> | <code>insufficient-data</code>).</p></li> </ul><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::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 [`DescribeCapacityBlockStatusOutput`](crate::operation::describe_capacity_block_status::DescribeCapacityBlockStatusOutput) with field(s):
    ///   - [`capacity_block_statuses(Option<Vec::<CapacityBlockStatus>>)`](crate::operation::describe_capacity_block_status::DescribeCapacityBlockStatusOutput::capacity_block_statuses): <p>The availability of capacity for a Capacity Block.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_capacity_block_status::DescribeCapacityBlockStatusOutput::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>
    /// - On failure, responds with [`SdkError<DescribeCapacityBlockStatusError>`](crate::operation::describe_capacity_block_status::DescribeCapacityBlockStatusError)
    pub fn describe_capacity_block_status(
        &self,
    ) -> crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder {
        crate::operation::describe_capacity_block_status::builders::DescribeCapacityBlockStatusFluentBuilder::new(self.handle.clone())
    }
}