aws_sdk_ec2/client/
get_ipam_address_history.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 [`GetIpamAddressHistory`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::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>
8    ///   - [`cidr(impl Into<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::cidr) / [`set_cidr(Option<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_cidr):<br>required: **true**<br><p>The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.</p><br>
9    ///   - [`ipam_scope_id(impl Into<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::ipam_scope_id) / [`set_ipam_scope_id(Option<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_ipam_scope_id):<br>required: **true**<br><p>The ID of the IPAM scope that the CIDR is in.</p><br>
10    ///   - [`vpc_id(impl Into<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::vpc_id) / [`set_vpc_id(Option<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_vpc_id):<br>required: **false**<br><p>The ID of the VPC you want your history records filtered by.</p><br>
11    ///   - [`start_time(DateTime)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_start_time):<br>required: **false**<br><p>The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.</p><br>
12    ///   - [`end_time(DateTime)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_end_time):<br>required: **false**<br><p>The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.</p><br>
13    ///   - [`max_results(i32)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of historical results you would like returned per page. Defaults to 100.</p><br>
14    ///   - [`next_token(impl Into<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
15    /// - On success, responds with [`GetIpamAddressHistoryOutput`](crate::operation::get_ipam_address_history::GetIpamAddressHistoryOutput) with field(s):
16    ///   - [`history_records(Option<Vec::<IpamAddressHistoryRecord>>)`](crate::operation::get_ipam_address_history::GetIpamAddressHistoryOutput::history_records): <p>A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::get_ipam_address_history::GetIpamAddressHistoryOutput::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>
18    /// - On failure, responds with [`SdkError<GetIpamAddressHistoryError>`](crate::operation::get_ipam_address_history::GetIpamAddressHistoryError)
19    pub fn get_ipam_address_history(&self) -> crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder {
20        crate::operation::get_ipam_address_history::builders::GetIpamAddressHistoryFluentBuilder::new(self.handle.clone())
21    }
22}