aws_sdk_finspace/client/
get_kx_database.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 [`GetKxDatabase`](crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`environment_id(impl Into<String>)`](crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment.</p><br>
7    ///   - [`database_name(impl Into<String>)`](crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder::set_database_name):<br>required: **true**<br><p>The name of the kdb database.</p><br>
8    /// - On success, responds with [`GetKxDatabaseOutput`](crate::operation::get_kx_database::GetKxDatabaseOutput) with field(s):
9    ///   - [`database_name(Option<String>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::database_name): <p>The name of the kdb database for which the information is retrieved.</p>
10    ///   - [`database_arn(Option<String>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::database_arn): <p>The ARN identifier of the database.</p>
11    ///   - [`environment_id(Option<String>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::environment_id): <p>A unique identifier for the kdb environment.</p>
12    ///   - [`description(Option<String>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::description): <p>A description of the database.</p>
13    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::created_timestamp): <p>The timestamp at which the database is 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>
14    ///   - [`last_modified_timestamp(Option<DateTime>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::last_modified_timestamp): <p>The last time that the database was modified. 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>
15    ///   - [`last_completed_changeset_id(Option<String>)`](crate::operation::get_kx_database::GetKxDatabaseOutput::last_completed_changeset_id): <p>A unique identifier for the changeset.</p>
16    ///   - [`num_bytes(i64)`](crate::operation::get_kx_database::GetKxDatabaseOutput::num_bytes): <p>The total number of bytes in the database.</p>
17    ///   - [`num_changesets(i32)`](crate::operation::get_kx_database::GetKxDatabaseOutput::num_changesets): <p>The total number of changesets in the database.</p>
18    ///   - [`num_files(i32)`](crate::operation::get_kx_database::GetKxDatabaseOutput::num_files): <p>The total number of files in the database.</p>
19    /// - On failure, responds with [`SdkError<GetKxDatabaseError>`](crate::operation::get_kx_database::GetKxDatabaseError)
20    pub fn get_kx_database(&self) -> crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder {
21        crate::operation::get_kx_database::builders::GetKxDatabaseFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_finspace/client/get_kx_database.rs

aws_sdk_finspace/client/
get_kx_database.rs
