aws_sdk_ec2/client/
list_volumes_in_recycle_bin.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 [`ListVolumesInRecycleBin`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`volume_ids(impl Into<String>)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::volume_ids) / [`set_volume_ids(Option<Vec::<String>>)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::set_volume_ids):<br>required: **false**<br><p>The IDs of the volumes to list. Omit this parameter to list all of the volumes that are in the Recycle Bin.</p><br>
7    ///   - [`dry_run(bool)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
8    ///   - [`max_results(i32)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p> <p>Valid range: 5 - 500</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
10    /// - On success, responds with [`ListVolumesInRecycleBinOutput`](crate::operation::list_volumes_in_recycle_bin::ListVolumesInRecycleBinOutput) with field(s):
11    ///   - [`volumes(Option<Vec::<VolumeRecycleBinInfo>>)`](crate::operation::list_volumes_in_recycle_bin::ListVolumesInRecycleBinOutput::volumes): <p>Information about the volumes.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_volumes_in_recycle_bin::ListVolumesInRecycleBinOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
13    /// - On failure, responds with [`SdkError<ListVolumesInRecycleBinError>`](crate::operation::list_volumes_in_recycle_bin::ListVolumesInRecycleBinError)
14    pub fn list_volumes_in_recycle_bin(&self) -> crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder {
15        crate::operation::list_volumes_in_recycle_bin::builders::ListVolumesInRecycleBinFluentBuilder::new(self.handle.clone())
16    }
17}