aws_sdk_connect/operation/list_phone_numbers/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_phone_numbers::_list_phone_numbers_output::ListPhoneNumbersOutputBuilder;
3
4pub use crate::operation::list_phone_numbers::_list_phone_numbers_input::ListPhoneNumbersInputBuilder;
5
6impl crate::operation::list_phone_numbers::builders::ListPhoneNumbersInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::list_phone_numbers::ListPhoneNumbersOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_phone_numbers::ListPhoneNumbersError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_phone_numbers();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListPhoneNumbers`.
24///
25/// <p>Provides information about the phone numbers for the specified Amazon Connect instance.</p>
26/// <p>For more information about phone numbers, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p><important>
27/// <ul>
28/// <li>
29/// <p>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to return phone number types. ListPhoneNumbers doesn't support number types <code>UIFN</code>, <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>. While it returns numbers of those types, it incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>.</p></li>
30/// <li>
31/// <p>The phone number <code>Arn</code> value that is returned from each of the items in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList">PhoneNumberSummaryList</a> cannot be used to tag phone number resources. It will fail with a <code>ResourceNotFoundException</code>. Instead, use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> API. It returns the new phone number ARN that can be used to tag phone number resources.</p></li>
32/// </ul>
33/// </important>
34#[derive(::std::clone::Clone, ::std::fmt::Debug)]
35pub struct ListPhoneNumbersFluentBuilder {
36 handle: ::std::sync::Arc<crate::client::Handle>,
37 inner: crate::operation::list_phone_numbers::builders::ListPhoneNumbersInputBuilder,
38 config_override: ::std::option::Option<crate::config::Builder>,
39}
40impl
41 crate::client::customize::internal::CustomizableSend<
42 crate::operation::list_phone_numbers::ListPhoneNumbersOutput,
43 crate::operation::list_phone_numbers::ListPhoneNumbersError,
44 > for ListPhoneNumbersFluentBuilder
45{
46 fn send(
47 self,
48 config_override: crate::config::Builder,
49 ) -> crate::client::customize::internal::BoxFuture<
50 crate::client::customize::internal::SendResult<
51 crate::operation::list_phone_numbers::ListPhoneNumbersOutput,
52 crate::operation::list_phone_numbers::ListPhoneNumbersError,
53 >,
54 > {
55 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
56 }
57}
58impl ListPhoneNumbersFluentBuilder {
59 /// Creates a new `ListPhoneNumbersFluentBuilder`.
60 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
61 Self {
62 handle,
63 inner: ::std::default::Default::default(),
64 config_override: ::std::option::Option::None,
65 }
66 }
67 /// Access the ListPhoneNumbers as a reference.
68 pub fn as_input(&self) -> &crate::operation::list_phone_numbers::builders::ListPhoneNumbersInputBuilder {
69 &self.inner
70 }
71 /// Sends the request and returns the response.
72 ///
73 /// If an error occurs, an `SdkError` will be returned with additional details that
74 /// can be matched against.
75 ///
76 /// By default, any retryable failures will be retried twice. Retry behavior
77 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
78 /// set when configuring the client.
79 pub async fn send(
80 self,
81 ) -> ::std::result::Result<
82 crate::operation::list_phone_numbers::ListPhoneNumbersOutput,
83 ::aws_smithy_runtime_api::client::result::SdkError<
84 crate::operation::list_phone_numbers::ListPhoneNumbersError,
85 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
86 >,
87 > {
88 let input = self
89 .inner
90 .build()
91 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
92 let runtime_plugins = crate::operation::list_phone_numbers::ListPhoneNumbers::operation_runtime_plugins(
93 self.handle.runtime_plugins.clone(),
94 &self.handle.conf,
95 self.config_override,
96 );
97 crate::operation::list_phone_numbers::ListPhoneNumbers::orchestrate(&runtime_plugins, input).await
98 }
99
100 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
101 pub fn customize(
102 self,
103 ) -> crate::client::customize::CustomizableOperation<
104 crate::operation::list_phone_numbers::ListPhoneNumbersOutput,
105 crate::operation::list_phone_numbers::ListPhoneNumbersError,
106 Self,
107 > {
108 crate::client::customize::CustomizableOperation::new(self)
109 }
110 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
111 self.set_config_override(::std::option::Option::Some(config_override.into()));
112 self
113 }
114
115 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
116 self.config_override = config_override;
117 self
118 }
119 /// Create a paginator for this request
120 ///
121 /// Paginators are used by calling [`send().await`](crate::operation::list_phone_numbers::paginator::ListPhoneNumbersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
122 pub fn into_paginator(self) -> crate::operation::list_phone_numbers::paginator::ListPhoneNumbersPaginator {
123 crate::operation::list_phone_numbers::paginator::ListPhoneNumbersPaginator::new(self.handle, self.inner)
124 }
125 /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
126 pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.instance_id(input.into());
128 self
129 }
130 /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
131 pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_instance_id(input);
133 self
134 }
135 /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
136 pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_instance_id()
138 }
139 ///
140 /// Appends an item to `PhoneNumberTypes`.
141 ///
142 /// To override the contents of this collection use [`set_phone_number_types`](Self::set_phone_number_types).
143 ///
144 /// <p>The type of phone number.</p><note>
145 /// <p>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to return phone number types. While ListPhoneNumbers returns number types <code>UIFN</code>, <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>, it incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>.</p>
146 /// </note>
147 pub fn phone_number_types(mut self, input: crate::types::PhoneNumberType) -> Self {
148 self.inner = self.inner.phone_number_types(input);
149 self
150 }
151 /// <p>The type of phone number.</p><note>
152 /// <p>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to return phone number types. While ListPhoneNumbers returns number types <code>UIFN</code>, <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>, it incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>.</p>
153 /// </note>
154 pub fn set_phone_number_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::PhoneNumberType>>) -> Self {
155 self.inner = self.inner.set_phone_number_types(input);
156 self
157 }
158 /// <p>The type of phone number.</p><note>
159 /// <p>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to return phone number types. While ListPhoneNumbers returns number types <code>UIFN</code>, <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>, it incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>.</p>
160 /// </note>
161 pub fn get_phone_number_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PhoneNumberType>> {
162 self.inner.get_phone_number_types()
163 }
164 ///
165 /// Appends an item to `PhoneNumberCountryCodes`.
166 ///
167 /// To override the contents of this collection use [`set_phone_number_country_codes`](Self::set_phone_number_country_codes).
168 ///
169 /// <p>The ISO country code.</p>
170 pub fn phone_number_country_codes(mut self, input: crate::types::PhoneNumberCountryCode) -> Self {
171 self.inner = self.inner.phone_number_country_codes(input);
172 self
173 }
174 /// <p>The ISO country code.</p>
175 pub fn set_phone_number_country_codes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::PhoneNumberCountryCode>>) -> Self {
176 self.inner = self.inner.set_phone_number_country_codes(input);
177 self
178 }
179 /// <p>The ISO country code.</p>
180 pub fn get_phone_number_country_codes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PhoneNumberCountryCode>> {
181 self.inner.get_phone_number_country_codes()
182 }
183 /// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
184 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
185 self.inner = self.inner.next_token(input.into());
186 self
187 }
188 /// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
189 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
190 self.inner = self.inner.set_next_token(input);
191 self
192 }
193 /// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
194 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
195 self.inner.get_next_token()
196 }
197 /// <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
198 pub fn max_results(mut self, input: i32) -> Self {
199 self.inner = self.inner.max_results(input);
200 self
201 }
202 /// <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
203 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
204 self.inner = self.inner.set_max_results(input);
205 self
206 }
207 /// <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
208 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
209 self.inner.get_max_results()
210 }
211}