list_connector_entities ¶

def list_connector_entities(
    self,
    *,
    config_overrides: Optional[AppflowClientConfig] = None,
    connector_profile_name: Optional[
        "capo_appflow.types.connector_profile_name.ConnectorProfileName"
    ] = None,
    connector_type: Optional[
        "capo_appflow.types.connector_type.ConnectorType"
    ] = None,
    entities_path: Optional["capo_appflow.types.entities_path.EntitiesPath"] = None,
    api_version: Optional["capo_appflow.types.api_version.ApiVersion"] = None,
    max_results: Optional[
        "capo_appflow.types.list_entities_max_results.ListEntitiesMaxResults"
    ] = None,
    next_token: Optional["capo_appflow.types.next_token.NextToken"] = None,
) -> "capo_appflow.types.list_connector_entities_response.ListConnectorEntitiesResponse":
    """<p> Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for <i>Account</i> and <i>Opportunity</i> entities, or query ServiceNow for the <i>Incident</i> entity. </p>

    Args:
        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, and is used to query the downstream connector. </p>
        connector_type: <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
        entities_path: <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>
        api_version: <p>The version of the API that's used by the connector.</p>
        max_results: <p>The maximum number of items that the operation returns in the response.</p>
        next_token: <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>

    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.list_connector_entities_request.ListConnectorEntitiesRequest]",
    ) -> OperationResponse[
        "capo_appflow.types.list_connector_entities_response.ListConnectorEntitiesResponse"
    ]:
        import capo_appflow._operations.sandstone_configuration_service_lambda.list_connector_entities

        output, http_response = (
            capo_appflow._operations.sandstone_configuration_service_lambda.list_connector_entities.list_connector_entities(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConnectorEntities")
    )
    input_: capo_appflow.types.list_connector_entities_request.ListConnectorEntitiesRequest = {}
    if connector_profile_name is not None:
        input_["connector_profile_name"] = connector_profile_name
    if connector_type is not None:
        input_["connector_type"] = connector_type
    if entities_path is not None:
        input_["entities_path"] = entities_path
    if api_version is not None:
        input_["api_version"] = api_version
    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