aws_sdk_sesv2/client/
get_dedicated_ips.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 [`GetDedicatedIps`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`pool_name(impl Into<String>)`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::pool_name) / [`set_pool_name(Option<String>)`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::set_pool_name):<br>required: **false**<br><p>The name of the IP pool that the dedicated IP address is associated with.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token returned from a previous call to <code>GetDedicatedIps</code> to indicate the position of the dedicated IP pool in the list of IP pools.</p><br>
9    ///   - [`page_size(i32)`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::set_page_size):<br>required: **false**<br><p>The number of results to show in a single call to <code>GetDedicatedIpsRequest</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p><br>
10    /// - On success, responds with [`GetDedicatedIpsOutput`](crate::operation::get_dedicated_ips::GetDedicatedIpsOutput) with field(s):
11    ///   - [`dedicated_ips(Option<Vec::<DedicatedIp>>)`](crate::operation::get_dedicated_ips::GetDedicatedIpsOutput::dedicated_ips): <p>A list of dedicated IP addresses that are associated with your Amazon Web Services account.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::get_dedicated_ips::GetDedicatedIpsOutput::next_token): <p>A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to <code>GetDedicatedIps</code>, passing this token in the <code>NextToken</code> parameter.</p>
13    /// - On failure, responds with [`SdkError<GetDedicatedIpsError>`](crate::operation::get_dedicated_ips::GetDedicatedIpsError)
14    pub fn get_dedicated_ips(&self) -> crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder {
15        crate::operation::get_dedicated_ips::builders::GetDedicatedIpsFluentBuilder::new(self.handle.clone())
16    }
17}