aws_sdk_ec2/client/
get_ipam_policy_allocation_rules.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetIpamPolicyAllocationRules`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`dry_run(bool)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_dry_run):<br>required: **false**<br><p>A check for 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>
7    ///   - [`ipam_policy_id(impl Into<String>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::ipam_policy_id) / [`set_ipam_policy_id(Option<String>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_ipam_policy_id):<br>required: **true**<br><p>The ID of the IPAM policy for which to get allocation rules.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters for the allocation rules.</p><br>
9    ///   - [`locale(impl Into<String>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::locale) / [`set_locale(Option<String>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_locale):<br>required: **false**<br><p>The locale for which to get the allocation rules.</p><br>
10    ///   - [`resource_type(IpamPolicyResourceType)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::resource_type) / [`set_resource_type(Option<IpamPolicyResourceType>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_resource_type):<br>required: **false**<br><p>The resource type for which to get the allocation rules.</p> <p>The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:</p> <ul>  <li>   <p>Elastic IP addresses</p></li> </ul><br>
11    ///   - [`max_results(i32)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
12    ///   - [`next_token(impl Into<String>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
13    /// - On success, responds with [`GetIpamPolicyAllocationRulesOutput`](crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput) with field(s):
14    ///   - [`ipam_policy_documents(Option<Vec::<IpamPolicyDocument>>)`](crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput::ipam_policy_documents): <p>The IPAM policy documents containing the allocation rules.</p> <p>Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput::next_token): <p>The token to use to retrieve the next page of results.</p>
16    /// - On failure, responds with [`SdkError<GetIpamPolicyAllocationRulesError>`](crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesError)
17    pub fn get_ipam_policy_allocation_rules(
18        &self,
19    ) -> crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder {
20        crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_ec2/client/get_ipam_policy_allocation_rules.rs

aws_sdk_ec2/client/
get_ipam_policy_allocation_rules.rs
