aws_sdk_glue/client/
describe_entity.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 [`DescribeEntity`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`connection_name(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::connection_name) / [`set_connection_name(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_connection_name):<br>required: **true**<br><p>The name of the connection that contains the connection type credentials.</p><br>
8    ///   - [`catalog_id(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::catalog_id) / [`set_catalog_id(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_catalog_id):<br>required: **false**<br><p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p><br>
9    ///   - [`entity_name(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::entity_name) / [`set_entity_name(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_entity_name):<br>required: **true**<br><p>The name of the entity that you want to describe from the connection type.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_next_token):<br>required: **false**<br><p>A continuation token, included if this is a continuation call.</p><br>
11    ///   - [`data_store_api_version(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::data_store_api_version) / [`set_data_store_api_version(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_data_store_api_version):<br>required: **false**<br><p>The version of the API used for the data store.</p><br>
12    /// - On success, responds with [`DescribeEntityOutput`](crate::operation::describe_entity::DescribeEntityOutput) with field(s):
13    ///   - [`fields(Option<Vec::<Field>>)`](crate::operation::describe_entity::DescribeEntityOutput::fields): <p>Describes the fields for that connector entity. This is the list of <code>Field</code> objects. <code>Field</code> is very similar to column in a database. The <code>Field</code> object has information about different properties associated with fields in the connector.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_entity::DescribeEntityOutput::next_token): <p>A continuation token, present if the current segment is not the last.</p>
15    /// - On failure, responds with [`SdkError<DescribeEntityError>`](crate::operation::describe_entity::DescribeEntityError)
16    pub fn describe_entity(&self) -> crate::operation::describe_entity::builders::DescribeEntityFluentBuilder {
17        crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_glue/client/describe_entity.rs

aws_sdk_glue/client/
describe_entity.rs
