aws_sdk_ec2/client/

get_coip_pool_usage.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetCoipPoolUsage`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`pool_id(impl Into<String>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::pool_id) / [`set_pool_id(Option<String>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::set_pool_id):<br>required: **true**<br><p>The ID of the address pool.</p><br>
    ///   - [`filters(Filter)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters.</p> <ul>  <li>   <p><code>coip-address-usage.allocation-id</code> - The allocation ID of the address.</p></li>  <li>   <p><code>coip-address-usage.aws-account-id</code> - The ID of the Amazon Web Services account that is using the customer-owned IP address.</p></li>  <li>   <p><code>coip-address-usage.aws-service</code> - The Amazon Web Services service that is using the customer-owned IP address.</p></li>  <li>   <p><code>coip-address-usage.co-ip</code> - The customer-owned IP address.</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::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 [`GetCoipPoolUsageOutput`](crate::operation::get_coip_pool_usage::GetCoipPoolUsageOutput) with field(s):
    ///   - [`coip_pool_id(Option<String>)`](crate::operation::get_coip_pool_usage::GetCoipPoolUsageOutput::coip_pool_id): <p>The ID of the customer-owned address pool.</p>
    ///   - [`coip_address_usages(Option<Vec::<CoipAddressUsage>>)`](crate::operation::get_coip_pool_usage::GetCoipPoolUsageOutput::coip_address_usages): <p>Information about the address usage.</p>
    ///   - [`local_gateway_route_table_id(Option<String>)`](crate::operation::get_coip_pool_usage::GetCoipPoolUsageOutput::local_gateway_route_table_id): <p>The ID of the local gateway route table.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_coip_pool_usage::GetCoipPoolUsageOutput::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<GetCoipPoolUsageError>`](crate::operation::get_coip_pool_usage::GetCoipPoolUsageError)
    pub fn get_coip_pool_usage(&self) -> crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder {
        crate::operation::get_coip_pool_usage::builders::GetCoipPoolUsageFluentBuilder::new(self.handle.clone())
    }
}