describe_connector_profiles async ¶

async def describe_connector_profiles(
    self,
    *,
    config_overrides: Optional[AsyncAppflowClientConfig] = None,
    connector_profile_names: Optional[
        "capo_appflow.types.connector_profile_name_list.ConnectorProfileNameList"
    ] = None,
    connector_type: Optional[
        "capo_appflow.types.connector_type.ConnectorType"
    ] = None,
    connector_label: Optional[
        "capo_appflow.types.connector_label.ConnectorLabel"
    ] = 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_connector_profiles_response.DescribeConnectorProfilesResponse":
    """<p> Returns a list of <code>connector-profile</code> details matching the provided <code>connector-profile</code> names and <code>connector-types</code>. Both input lists are optional, and you can use them to filter the result. </p> <p>If no names or <code>connector-types</code> are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.</p>

    Args:
        connector_profile_names: <p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
        connector_type: <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
        connector_label: <p>The name of the connector. The name is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.</p>
        max_results: <p> Specifies the maximum number of items that should be returned in the result set. The default for <code>maxResults</code> is 20 (for all paginated API operations). </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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appflow.types.describe_connector_profiles_request.DescribeConnectorProfilesRequest]",
    ) -> AsyncOperationResponse[
        "capo_appflow.types.describe_connector_profiles_response.DescribeConnectorProfilesResponse"
    ]:
        import capo_appflow._operations.sandstone_configuration_service_lambda.describe_connector_profiles

        (
            output,
            http_response,
        ) = await capo_appflow._operations.sandstone_configuration_service_lambda.describe_connector_profiles.async_describe_connector_profiles(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConnectorProfiles")
    )
    input_: capo_appflow.types.describe_connector_profiles_request.DescribeConnectorProfilesRequest = {}
    if connector_profile_names is not None:
        input_["connector_profile_names"] = connector_profile_names
    if connector_type is not None:
        input_["connector_type"] = connector_type
    if connector_label is not None:
        input_["connector_label"] = connector_label
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output