aws_sdk_appflow/client/

list_connector_entities.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListConnectorEntities`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`connector_profile_name(impl Into<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::connector_profile_name) / [`set_connector_profile_name(Option<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::set_connector_profile_name):<br>required: **false**<br><p>The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account, and is used to query the downstream connector.</p><br>
    ///   - [`connector_type(ConnectorType)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::connector_type) / [`set_connector_type(Option<ConnectorType>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::set_connector_type):<br>required: **false**<br><p>The type of connector, such as Salesforce, Amplitude, and so on.</p><br>
    ///   - [`entities_path(impl Into<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::entities_path) / [`set_entities_path(Option<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::set_entities_path):<br>required: **false**<br><p>This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the <code>entitiesPath</code> parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.</p><br>
    ///   - [`api_version(impl Into<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::api_version) / [`set_api_version(Option<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::set_api_version):<br>required: **false**<br><p>The version of the API that's used by the connector.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items that the operation returns in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that was provided by your prior <code>ListConnectorEntities</code> operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.</p><br>
    /// - On success, responds with [`ListConnectorEntitiesOutput`](crate::operation::list_connector_entities::ListConnectorEntitiesOutput) with field(s):
    ///   - [`connector_entity_map(HashMap::<String, Vec::<ConnectorEntity>>)`](crate::operation::list_connector_entities::ListConnectorEntitiesOutput::connector_entity_map): <p>The response of <code>ListConnectorEntities</code> lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_connector_entities::ListConnectorEntitiesOutput::next_token): <p>A token that you specify in your next <code>ListConnectorEntities</code> operation to get the next page of results in paginated response. The <code>ListConnectorEntities</code> operation provides this token if the response is too big for the page size.</p>
    /// - On failure, responds with [`SdkError<ListConnectorEntitiesError>`](crate::operation::list_connector_entities::ListConnectorEntitiesError)
    pub fn list_connector_entities(&self) -> crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder {
        crate::operation::list_connector_entities::builders::ListConnectorEntitiesFluentBuilder::new(self.handle.clone())
    }
}