aws_sdk_glue/client/
list_entities.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 [`ListEntities`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`connection_name(impl Into<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::connection_name) / [`set_connection_name(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::set_connection_name):<br>required: **false**<br><p>A name for the connection that has required credentials to query any connection type.</p><br>
8    ///   - [`catalog_id(impl Into<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::catalog_id) / [`set_catalog_id(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::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    ///   - [`parent_entity_name(impl Into<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::parent_entity_name) / [`set_parent_entity_name(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::set_parent_entity_name):<br>required: **false**<br><p>Name of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::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::list_entities::builders::ListEntitiesFluentBuilder::data_store_api_version) / [`set_data_store_api_version(Option<String>)`](crate::operation::list_entities::builders::ListEntitiesFluentBuilder::set_data_store_api_version):<br>required: **false**<br><p>The API version of the SaaS connector.</p><br>
12    /// - On success, responds with [`ListEntitiesOutput`](crate::operation::list_entities::ListEntitiesOutput) with field(s):
13    ///   - [`entities(Option<Vec::<Entity>>)`](crate::operation::list_entities::ListEntitiesOutput::entities): <p>A list of <code>Entity</code> objects.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_entities::ListEntitiesOutput::next_token): <p>A continuation token, present if the current segment is not the last.</p>
15    /// - On failure, responds with [`SdkError<ListEntitiesError>`](crate::operation::list_entities::ListEntitiesError)
16    pub fn list_entities(&self) -> crate::operation::list_entities::builders::ListEntitiesFluentBuilder {
17        crate::operation::list_entities::builders::ListEntitiesFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_glue/client/list_entities.rs

aws_sdk_glue/client/
list_entities.rs
