Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.
Parameters:
-
connector_types
(Optional[ConnectorTypeList], default:
None
)
–
The type of connector, such as Salesforce, Amplitude, and so on.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of items that should be returned in the result set. The default is 20.
-
next_token
(Optional[NextToken], default:
None
)
–
The pagination token for the next page of data.
Raises:
Source code in docs_src/capo_appflow/_services/appflow.py
| def describe_connectors(
self,
*,
config_overrides: Optional[AppflowClientConfig] = None,
connector_types: Optional[
"capo_appflow.types.connector_type_list.ConnectorTypeList"
] = None,
max_results: Optional["capo_appflow.types.max_results.MaxResults"] = None,
next_token: Optional["capo_appflow.types.next_token.NextToken"] = None,
) -> "capo_appflow.types.describe_connectors_response.DescribeConnectorsResponse":
"""<p> Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a <code>nextToken</code> object, which can be be passed in to the next call to the <code>DescribeConnectors</code> API operation to retrieve the next page. </p>
Args:
connector_types: <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
max_results: <p>The maximum number of items that should be returned in the result set. The default is 20.</p>
next_token: <p> The pagination token for the next page of data. </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.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_connectors_request.DescribeConnectorsRequest]",
) -> OperationResponse[
"capo_appflow.types.describe_connectors_response.DescribeConnectorsResponse"
]:
import capo_appflow._operations.sandstone_configuration_service_lambda.describe_connectors
output, http_response = (
capo_appflow._operations.sandstone_configuration_service_lambda.describe_connectors.describe_connectors(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeConnectors")
)
input_: capo_appflow.types.describe_connectors_request.DescribeConnectorsRequest = {}
if connector_types is not None:
input_["connector_types"] = connector_types
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|