aws_sdk_athena/client/
get_table_metadata.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 [`GetTableMetadata`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`catalog_name(impl Into<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::catalog_name) / [`set_catalog_name(Option<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::set_catalog_name):<br>required: **true**<br><p>The name of the data catalog that contains the database and table metadata to return.</p><br>
7    ///   - [`database_name(impl Into<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::set_database_name):<br>required: **true**<br><p>The name of the database that contains the table metadata to return.</p><br>
8    ///   - [`table_name(impl Into<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::table_name) / [`set_table_name(Option<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::set_table_name):<br>required: **true**<br><p>The name of the table for which metadata is returned.</p><br>
9    ///   - [`work_group(impl Into<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::work_group) / [`set_work_group(Option<String>)`](crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::set_work_group):<br>required: **false**<br><p>The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.</p><br>
10    /// - On success, responds with [`GetTableMetadataOutput`](crate::operation::get_table_metadata::GetTableMetadataOutput) with field(s):
11    ///   - [`table_metadata(Option<TableMetadata>)`](crate::operation::get_table_metadata::GetTableMetadataOutput::table_metadata): <p>An object that contains table metadata.</p>
12    /// - On failure, responds with [`SdkError<GetTableMetadataError>`](crate::operation::get_table_metadata::GetTableMetadataError)
13    pub fn get_table_metadata(&self) -> crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder {
14        crate::operation::get_table_metadata::builders::GetTableMetadataFluentBuilder::new(self.handle.clone())
15    }
16}