Skip to main content

aws_sdk_glue/client/
batch_get_partition.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 [`BatchGetPartition`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`catalog_id(impl Into<String>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::catalog_id) / [`set_catalog_id(Option<String>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::set_catalog_id):<br>required: **false**<br><p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the Amazon Web Services account ID is used by default.</p><br>
7    ///   - [`database_name(impl Into<String>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::set_database_name):<br>required: **true**<br><p>The name of the catalog database where the partitions reside.</p><br>
8    ///   - [`table_name(impl Into<String>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::table_name) / [`set_table_name(Option<String>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::set_table_name):<br>required: **true**<br><p>The name of the partitions' table.</p><br>
9    ///   - [`partitions_to_get(PartitionValueList)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::partitions_to_get) / [`set_partitions_to_get(Option<Vec::<PartitionValueList>>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::set_partitions_to_get):<br>required: **true**<br><p>A list of partition values identifying the partitions to retrieve.</p><br>
10    ///   - [`audit_context(AuditContext)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::audit_context) / [`set_audit_context(Option<AuditContext>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::set_audit_context):<br>required: **false**<br><p>A structure containing the Lake Formation audit context.</p><br>
11    ///   - [`query_session_context(QuerySessionContext)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::query_session_context) / [`set_query_session_context(Option<QuerySessionContext>)`](crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::set_query_session_context):<br>required: **false**<br><p>A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.</p><br>
12    /// - On success, responds with [`BatchGetPartitionOutput`](crate::operation::batch_get_partition::BatchGetPartitionOutput) with field(s):
13    ///   - [`partitions(Option<Vec::<Partition>>)`](crate::operation::batch_get_partition::BatchGetPartitionOutput::partitions): <p>A list of the requested partitions.</p>
14    ///   - [`unprocessed_keys(Option<Vec::<PartitionValueList>>)`](crate::operation::batch_get_partition::BatchGetPartitionOutput::unprocessed_keys): <p>A list of the partition values in the request for which partitions were not returned.</p>
15    /// - On failure, responds with [`SdkError<BatchGetPartitionError>`](crate::operation::batch_get_partition::BatchGetPartitionError)
16    pub fn batch_get_partition(&self) -> crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder {
17        crate::operation::batch_get_partition::builders::BatchGetPartitionFluentBuilder::new(self.handle.clone())
18    }
19}