1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetKxVolume`](crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`environment_id(impl Into<String>)`](crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment, whose clusters can attach to the volume.</p><br>
    ///   - [`volume_name(impl Into<String>)`](crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder::volume_name) / [`set_volume_name(Option<String>)`](crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder::set_volume_name):<br>required: **true**<br><p>A unique identifier for the volume.</p><br>
    /// - On success, responds with [`GetKxVolumeOutput`](crate::operation::get_kx_volume::GetKxVolumeOutput) with field(s):
    ///   - [`environment_id(Option<String>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::environment_id): <p>A unique identifier for the kdb environment, whose clusters can attach to the volume.</p>
    ///   - [`volume_name(Option<String>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::volume_name): <p>A unique identifier for the volume.</p>
    ///   - [`volume_type(Option<KxVolumeType>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::volume_type): <p>The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type.</p>
    ///   - [`volume_arn(Option<String>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::volume_arn): <p>The ARN identifier of the volume.</p>
    ///   - [`nas1_configuration(Option<KxNas1Configuration>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::nas1_configuration): <p>Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>
    ///   - [`status(Option<KxVolumeStatus>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::status): <p>The status of volume creation.</p> <ul>  <li>   <p>CREATING – The volume creation is in progress.</p></li>  <li>   <p>CREATE_FAILED – The volume creation has failed.</p></li>  <li>   <p>ACTIVE – The volume is active.</p></li>  <li>   <p>UPDATING – The volume is in the process of being updated.</p></li>  <li>   <p>UPDATE_FAILED – The update action failed.</p></li>  <li>   <p>UPDATED – The volume is successfully updated.</p></li>  <li>   <p>DELETING – The volume is in the process of being deleted.</p></li>  <li>   <p>DELETE_FAILED – The system failed to delete the volume.</p></li>  <li>   <p>DELETED – The volume is successfully deleted.</p></li> </ul>
    ///   - [`status_reason(Option<String>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::status_reason): <p>The error message when a failed state occurs.</p>
    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::created_timestamp): <p>The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
    ///   - [`description(Option<String>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::description): <p>A description of the volume.</p>
    ///   - [`az_mode(Option<KxAzMode>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::az_mode): <p>The number of availability zones you want to assign per cluster. Currently, FinSpace only support <code>SINGLE</code> for volumes.</p>
    ///   - [`availability_zone_ids(Option<Vec::<String>>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::availability_zone_ids): <p>The identifier of the availability zones.</p>
    ///   - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::last_modified_timestamp): <p>The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>
    ///   - [`attached_clusters(Option<Vec::<KxAttachedCluster>>)`](crate::operation::get_kx_volume::GetKxVolumeOutput::attached_clusters): <p>A list of cluster identifiers that a volume is attached to.</p>
    /// - On failure, responds with [`SdkError<GetKxVolumeError>`](crate::operation::get_kx_volume::GetKxVolumeError)
    pub fn get_kx_volume(&self) -> crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder {
        crate::operation::get_kx_volume::builders::GetKxVolumeFluentBuilder::new(self.handle.clone())
    }
}