aws_sdk_fsx/client/
describe_storage_virtual_machines.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 [`DescribeStorageVirtualMachines`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`storage_virtual_machine_ids(impl Into<String>)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::storage_virtual_machine_ids) / [`set_storage_virtual_machine_ids(Option<Vec::<String>>)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::set_storage_virtual_machine_ids):<br>required: **false**<br><p>Enter the ID of one or more SVMs that you want to view.</p><br>
8    ///   - [`filters(StorageVirtualMachineFilter)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::filters) / [`set_filters(Option<Vec::<StorageVirtualMachineFilter>>)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::set_filters):<br>required: **false**<br><p>Enter a filter name:value pair to view a select set of SVMs.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of resources to return in the response. This value must be an integer greater than zero.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::set_next_token):<br>required: **false**<br><p>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</p><br>
11    /// - On success, responds with [`DescribeStorageVirtualMachinesOutput`](crate::operation::describe_storage_virtual_machines::DescribeStorageVirtualMachinesOutput) with field(s):
12    ///   - [`storage_virtual_machines(Option<Vec::<StorageVirtualMachine>>)`](crate::operation::describe_storage_virtual_machines::DescribeStorageVirtualMachinesOutput::storage_virtual_machines): <p>Returned after a successful <code>DescribeStorageVirtualMachines</code> operation, describing each SVM.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_storage_virtual_machines::DescribeStorageVirtualMachinesOutput::next_token): <p>(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous <code>NextToken</code> value left off.</p>
14    /// - On failure, responds with [`SdkError<DescribeStorageVirtualMachinesError>`](crate::operation::describe_storage_virtual_machines::DescribeStorageVirtualMachinesError)
15    pub fn describe_storage_virtual_machines(
16        &self,
17    ) -> crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder {
18        crate::operation::describe_storage_virtual_machines::builders::DescribeStorageVirtualMachinesFluentBuilder::new(self.handle.clone())
19    }
20}