Skip to content

list_cloud_connectors

list_cloud_connectors(
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    type: Optional[CloudConnectorType] = None,
    lambda_arn: Optional[LambdaArn] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListCloudConnectorsResponse

Returns a list of connectors filtered by its Lambda Amazon Resource Name (ARN) and type.

Parameters:

  • type (Optional[CloudConnectorType], default: None ) –

    The type of cloud connectors to filter by when listing available connectors.

  • lambda_arn (Optional[LambdaArn], default: None ) –

    The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return at one time.

  • next_token (Optional[NextToken], default: None ) –

    A token that can be used to retrieve the next set of results.

Raises:

Examples:

ListCloudConnectors happy path to get a list of connector resources

>>> client.list_cloud_connectors(max_results=5)
ListCloudConnectors error path for unauthorized user
>>> client.list_cloud_connectors(max_results=5)
Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py
def list_cloud_connectors(
    self,
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    type: Optional[
        "capo_iot_managed_integrations.types.cloud_connector_type.CloudConnectorType"
    ] = None,
    lambda_arn: Optional[
        "capo_iot_managed_integrations.types.lambda_arn.LambdaArn"
    ] = None,
    max_results: Optional[
        "capo_iot_managed_integrations.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_iot_managed_integrations.types.next_token.NextToken"
    ] = None,
) -> "capo_iot_managed_integrations.types.list_cloud_connectors_response.ListCloudConnectorsResponse":
    """<p>Returns a list of connectors filtered by its Lambda Amazon Resource Name (ARN) and <code>type</code>.</p>

    Args:
        type: <p>The type of cloud connectors to filter by when listing available connectors.</p>
        lambda_arn: <p>The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.</p>
        max_results: <p>The maximum number of results to return at one time.</p>
        next_token: <p>A token that can be used to retrieve the next set of results.</p>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</p>
        capo_iot_managed_integrations.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot_managed_integrations.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot_managed_integrations.errors.validation_exception.ValidationException: <p>A validation error occurred when performing the API request.</p>
        capo_iot_managed_integrations.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        ListCloudConnectors happy path to get a list of connector resources

        >>> client.list_cloud_connectors(max_results=5)
        ListCloudConnectors error path for unauthorized user

        >>> client.list_cloud_connectors(max_results=5)
    """

    def _handler(
        req: "OperationRequest[capo_iot_managed_integrations.types.list_cloud_connectors_request.ListCloudConnectorsRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.list_cloud_connectors_response.ListCloudConnectorsResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.list_cloud_connectors

        output, http_response = (
            capo_iot_managed_integrations._operations.iot_managed_integrations.list_cloud_connectors.list_cloud_connectors(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCloudConnectors")
    )
    input_: capo_iot_managed_integrations.types.list_cloud_connectors_request.ListCloudConnectorsRequest = {}
    if type is not None:
        input_["type"] = type
    if lambda_arn is not None:
        input_["lambda_arn"] = lambda_arn
    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