aws_sdk_ec2/operation/describe_volumes_modifications/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_volumes_modifications::_describe_volumes_modifications_output::DescribeVolumesModificationsOutputBuilder;
3
4pub use crate::operation::describe_volumes_modifications::_describe_volumes_modifications_input::DescribeVolumesModificationsInputBuilder;
5
6impl crate::operation::describe_volumes_modifications::builders::DescribeVolumesModificationsInputBuilder {
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::describe_volumes_modifications::DescribeVolumesModificationsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_volumes_modifications::DescribeVolumesModificationsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_volumes_modifications();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeVolumesModifications`.
24///
25/// <p>Describes the most recent volume modification request for the specified EBS volumes.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html"> Monitor the progress of volume modifications</a> in the <i>Amazon EBS User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeVolumesModificationsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_volumes_modifications::builders::DescribeVolumesModificationsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_volumes_modifications::DescribeVolumesModificationsOutput,
36        crate::operation::describe_volumes_modifications::DescribeVolumesModificationsError,
37    > for DescribeVolumesModificationsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::describe_volumes_modifications::DescribeVolumesModificationsOutput,
45            crate::operation::describe_volumes_modifications::DescribeVolumesModificationsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeVolumesModificationsFluentBuilder {
52    /// Creates a new `DescribeVolumesModificationsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the DescribeVolumesModifications as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_volumes_modifications::builders::DescribeVolumesModificationsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::describe_volumes_modifications::DescribeVolumesModificationsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_volumes_modifications::DescribeVolumesModificationsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::describe_volumes_modifications::DescribeVolumesModifications::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_volumes_modifications::DescribeVolumesModifications::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::describe_volumes_modifications::DescribeVolumesModificationsOutput,
98        crate::operation::describe_volumes_modifications::DescribeVolumesModificationsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::describe_volumes_modifications::paginator::DescribeVolumesModificationsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::describe_volumes_modifications::paginator::DescribeVolumesModificationsPaginator {
116        crate::operation::describe_volumes_modifications::paginator::DescribeVolumesModificationsPaginator::new(self.handle, self.inner)
117    }
118    /// <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>
119    pub fn dry_run(mut self, input: bool) -> Self {
120        self.inner = self.inner.dry_run(input);
121        self
122    }
123    /// <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>
124    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
125        self.inner = self.inner.set_dry_run(input);
126        self
127    }
128    /// <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>
129    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
130        self.inner.get_dry_run()
131    }
132    ///
133    /// Appends an item to `VolumeIds`.
134    ///
135    /// To override the contents of this collection use [`set_volume_ids`](Self::set_volume_ids).
136    ///
137    /// <p>The IDs of the volumes.</p>
138    pub fn volume_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
139        self.inner = self.inner.volume_ids(input.into());
140        self
141    }
142    /// <p>The IDs of the volumes.</p>
143    pub fn set_volume_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
144        self.inner = self.inner.set_volume_ids(input);
145        self
146    }
147    /// <p>The IDs of the volumes.</p>
148    pub fn get_volume_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
149        self.inner.get_volume_ids()
150    }
151    ///
152    /// Appends an item to `Filters`.
153    ///
154    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
155    ///
156    /// <p>The filters.</p>
157    /// <ul>
158    /// <li>
159    /// <p><code>modification-state</code> - The current modification state (modifying | optimizing | completed | failed).</p></li>
160    /// <li>
161    /// <p><code>original-iops</code> - The original IOPS rate of the volume.</p></li>
162    /// <li>
163    /// <p><code>original-size</code> - The original size of the volume, in GiB.</p></li>
164    /// <li>
165    /// <p><code>original-volume-type</code> - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p></li>
166    /// <li>
167    /// <p><code>originalMultiAttachEnabled</code> - Indicates whether Multi-Attach support was enabled (true | false).</p></li>
168    /// <li>
169    /// <p><code>start-time</code> - The modification start time.</p></li>
170    /// <li>
171    /// <p><code>target-iops</code> - The target IOPS rate of the volume.</p></li>
172    /// <li>
173    /// <p><code>target-size</code> - The target size of the volume, in GiB.</p></li>
174    /// <li>
175    /// <p><code>target-volume-type</code> - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p></li>
176    /// <li>
177    /// <p><code>targetMultiAttachEnabled</code> - Indicates whether Multi-Attach support is to be enabled (true | false).</p></li>
178    /// <li>
179    /// <p><code>volume-id</code> - The ID of the volume.</p></li>
180    /// </ul>
181    pub fn filters(mut self, input: crate::types::Filter) -> Self {
182        self.inner = self.inner.filters(input);
183        self
184    }
185    /// <p>The filters.</p>
186    /// <ul>
187    /// <li>
188    /// <p><code>modification-state</code> - The current modification state (modifying | optimizing | completed | failed).</p></li>
189    /// <li>
190    /// <p><code>original-iops</code> - The original IOPS rate of the volume.</p></li>
191    /// <li>
192    /// <p><code>original-size</code> - The original size of the volume, in GiB.</p></li>
193    /// <li>
194    /// <p><code>original-volume-type</code> - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p></li>
195    /// <li>
196    /// <p><code>originalMultiAttachEnabled</code> - Indicates whether Multi-Attach support was enabled (true | false).</p></li>
197    /// <li>
198    /// <p><code>start-time</code> - The modification start time.</p></li>
199    /// <li>
200    /// <p><code>target-iops</code> - The target IOPS rate of the volume.</p></li>
201    /// <li>
202    /// <p><code>target-size</code> - The target size of the volume, in GiB.</p></li>
203    /// <li>
204    /// <p><code>target-volume-type</code> - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p></li>
205    /// <li>
206    /// <p><code>targetMultiAttachEnabled</code> - Indicates whether Multi-Attach support is to be enabled (true | false).</p></li>
207    /// <li>
208    /// <p><code>volume-id</code> - The ID of the volume.</p></li>
209    /// </ul>
210    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
211        self.inner = self.inner.set_filters(input);
212        self
213    }
214    /// <p>The filters.</p>
215    /// <ul>
216    /// <li>
217    /// <p><code>modification-state</code> - The current modification state (modifying | optimizing | completed | failed).</p></li>
218    /// <li>
219    /// <p><code>original-iops</code> - The original IOPS rate of the volume.</p></li>
220    /// <li>
221    /// <p><code>original-size</code> - The original size of the volume, in GiB.</p></li>
222    /// <li>
223    /// <p><code>original-volume-type</code> - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p></li>
224    /// <li>
225    /// <p><code>originalMultiAttachEnabled</code> - Indicates whether Multi-Attach support was enabled (true | false).</p></li>
226    /// <li>
227    /// <p><code>start-time</code> - The modification start time.</p></li>
228    /// <li>
229    /// <p><code>target-iops</code> - The target IOPS rate of the volume.</p></li>
230    /// <li>
231    /// <p><code>target-size</code> - The target size of the volume, in GiB.</p></li>
232    /// <li>
233    /// <p><code>target-volume-type</code> - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p></li>
234    /// <li>
235    /// <p><code>targetMultiAttachEnabled</code> - Indicates whether Multi-Attach support is to be enabled (true | false).</p></li>
236    /// <li>
237    /// <p><code>volume-id</code> - The ID of the volume.</p></li>
238    /// </ul>
239    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
240        self.inner.get_filters()
241    }
242    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
243    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
244        self.inner = self.inner.next_token(input.into());
245        self
246    }
247    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
248    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
249        self.inner = self.inner.set_next_token(input);
250        self
251    }
252    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
253    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
254        self.inner.get_next_token()
255    }
256    /// <p>The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
257    pub fn max_results(mut self, input: i32) -> Self {
258        self.inner = self.inner.max_results(input);
259        self
260    }
261    /// <p>The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
262    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
263        self.inner = self.inner.set_max_results(input);
264        self
265    }
266    /// <p>The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
267    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
268        self.inner.get_max_results()
269    }
270}