aws_sdk_finspace/client/
list_kx_volumes.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 [`ListKxVolumes`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`environment_id(impl Into<String>)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment, whose clusters can attach to the volume.</p><br>
7    ///   - [`max_results(i32)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in this request.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates where a results page should begin.</p><br>
9    ///   - [`volume_type(KxVolumeType)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::volume_type) / [`set_volume_type(Option<KxVolumeType>)`](crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::set_volume_type):<br>required: **false**<br><p>The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.</p><br>
10    /// - On success, responds with [`ListKxVolumesOutput`](crate::operation::list_kx_volumes::ListKxVolumesOutput) with field(s):
11    ///   - [`kx_volume_summaries(Option<Vec::<KxVolume>>)`](crate::operation::list_kx_volumes::ListKxVolumesOutput::kx_volume_summaries): <p>A summary of volumes.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_kx_volumes::ListKxVolumesOutput::next_token): <p>A token that indicates where a results page should begin.</p>
13    /// - On failure, responds with [`SdkError<ListKxVolumesError>`](crate::operation::list_kx_volumes::ListKxVolumesError)
14    pub fn list_kx_volumes(&self) -> crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder {
15        crate::operation::list_kx_volumes::builders::ListKxVolumesFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_finspace/client/list_kx_volumes.rs

aws_sdk_finspace/client/
list_kx_volumes.rs
