Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
Parameters:
-
connector_entity_name
(EntityName)
–
The entity name for that connector.
-
connector_type
(Optional[ConnectorType], default:
None
)
–
The type of connector application, such as Salesforce, Amplitude, and so on.
-
connector_profile_name
(Optional[ConnectorProfileName], default:
None
)
–
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
-
api_version
(Optional[ApiVersion], default:
None
)
–
The version of the API that's used by the connector.
Raises:
Source code in docs_src/capo_appflow/_services/appflow.py
| def describe_connector_entity(
self,
connector_entity_name: "capo_appflow.types.entity_name.EntityName",
*,
config_overrides: Optional[AppflowClientConfig] = None,
connector_type: Optional[
"capo_appflow.types.connector_type.ConnectorType"
] = None,
connector_profile_name: Optional[
"capo_appflow.types.connector_profile_name.ConnectorProfileName"
] = None,
api_version: Optional["capo_appflow.types.api_version.ApiVersion"] = None,
) -> "capo_appflow.types.describe_connector_entity_response.DescribeConnectorEntityResponse":
"""<p> Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity. </p>
Args:
connector_entity_name: <p> The entity name for that connector. </p>
connector_type: <p> The type of connector application, such as Salesforce, Amplitude, and so on. </p>
connector_profile_name: <p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
api_version: <p>The version of the API that's used by the connector.</p>
Raises:
capo_appflow.errors.connector_authentication_exception.ConnectorAuthenticationException: <p> An error occurred when authenticating with the connector endpoint. </p>
capo_appflow.errors.connector_server_exception.ConnectorServerException: <p> An error occurred when retrieving data from the connector endpoint. </p>
capo_appflow.errors.internal_server_exception.InternalServerException: <p> An internal service error occurred during the processing of your request. Try again later. </p>
capo_appflow.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource specified in the request (such as the source or destination connector profile) is not found. </p>
capo_appflow.errors.validation_exception.ValidationException: <p> The request has invalid or missing parameters. </p>
capo_appflow.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_appflow.types.describe_connector_entity_request.DescribeConnectorEntityRequest]",
) -> OperationResponse[
"capo_appflow.types.describe_connector_entity_response.DescribeConnectorEntityResponse"
]:
import capo_appflow._operations.sandstone_configuration_service_lambda.describe_connector_entity
output, http_response = (
capo_appflow._operations.sandstone_configuration_service_lambda.describe_connector_entity.describe_connector_entity(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeConnectorEntity")
)
input_: capo_appflow.types.describe_connector_entity_request.DescribeConnectorEntityRequest = {
"connector_entity_name": connector_entity_name
}
if connector_type is not None:
input_["connector_type"] = connector_type
if connector_profile_name is not None:
input_["connector_profile_name"] = connector_profile_name
if api_version is not None:
input_["api_version"] = api_version
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|