Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.
Parameters:
-
connector_type
(ConnectorType)
–
The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
-
connector_label
(Optional[ConnectorLabel], default:
None
)
–
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
Raises:
Source code in docs_src/capo_appflow/_services/appflow.py
| def describe_connector(
self,
connector_type: "capo_appflow.types.connector_type.ConnectorType",
*,
config_overrides: Optional[AppflowClientConfig] = None,
connector_label: Optional[
"capo_appflow.types.connector_label.ConnectorLabel"
] = None,
) -> "capo_appflow.types.describe_connector_response.DescribeConnectorResponse":
"""<p>Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.</p>
Args:
connector_type: <p>The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.</p>
connector_label: <p>The label of the connector. The label is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.</p>
Raises:
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_request.DescribeConnectorRequest]",
) -> OperationResponse[
"capo_appflow.types.describe_connector_response.DescribeConnectorResponse"
]:
import capo_appflow._operations.sandstone_configuration_service_lambda.describe_connector
output, http_response = (
capo_appflow._operations.sandstone_configuration_service_lambda.describe_connector.describe_connector(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeConnector")
)
input_: capo_appflow.types.describe_connector_request.DescribeConnectorRequest = {
"connector_type": connector_type
}
if connector_label is not None:
input_["connector_label"] = connector_label
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|