aws_sdk_appflow/client/
describe_connector_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 [`DescribeConnectorEntity`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`connector_entity_name(impl Into<String>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::connector_entity_name) / [`set_connector_entity_name(Option<String>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::set_connector_entity_name):<br>required: **true**<br><p>The entity name for that connector.</p><br>
7    ///   - [`connector_type(ConnectorType)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::connector_type) / [`set_connector_type(Option<ConnectorType>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::set_connector_type):<br>required: **false**<br><p>The type of connector application, such as Salesforce, Amplitude, and so on.</p><br>
8    ///   - [`connector_profile_name(impl Into<String>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::connector_profile_name) / [`set_connector_profile_name(Option<String>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::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.</p><br>
9    ///   - [`api_version(impl Into<String>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::api_version) / [`set_api_version(Option<String>)`](crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::set_api_version):<br>required: **false**<br><p>The version of the API that's used by the connector.</p><br>
10    /// - On success, responds with [`DescribeConnectorEntityOutput`](crate::operation::describe_connector_entity::DescribeConnectorEntityOutput) with field(s):
11    ///   - [`connector_entity_fields(Vec::<ConnectorEntityField>)`](crate::operation::describe_connector_entity::DescribeConnectorEntityOutput::connector_entity_fields): <p>Describes the fields for that connector entity. For example, for an <i>account</i> entity, the fields would be <i>account name</i>, <i>account ID</i>, and so on.</p>
12    /// - On failure, responds with [`SdkError<DescribeConnectorEntityError>`](crate::operation::describe_connector_entity::DescribeConnectorEntityError)
13    pub fn describe_connector_entity(&self) -> crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder {
14        crate::operation::describe_connector_entity::builders::DescribeConnectorEntityFluentBuilder::new(self.handle.clone())
15    }
16}