ManagedintegrationsforIoTDeviceManagement / Client / list_cloud_connectors

list_cloud_connectors

ManagedintegrationsforIoTDeviceManagement.Client.list_cloud_connectors(**kwargs)

Returns a list of connectors based on permissions.

See also: AWS API Documentation

Request Syntax

response = client.list_cloud_connectors(
    Type='LISTED'|'UNLISTED',
    LambdaArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Type (string) – The type of cloud connectors to filter by when listing available connectors.

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

  • MaxResults (integer) – The maximum number of results to return at one time.

  • NextToken (string) – A token that can be used to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Name': 'string',
            'EndpointConfig': {
                'lambda': {
                    'arn': 'string'
                }
            },
            'Description': 'string',
            'EndpointType': 'LAMBDA',
            'Id': 'string',
            'Type': 'LISTED'|'UNLISTED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of connectors.

      • (dict) –

        Structure describing a connector.

        • Name (string) –

          The display name of the C2C connector.

        • EndpointConfig (dict) –

          The configuration details for the cloud connector endpoint, including connection parameters and authentication requirements.

          • lambda (dict) –

            The Lambda function configuration for the endpoint, used when the endpoint communicates through an AWS Lambda function.

            • arn (string) –

              The Amazon Resource Name (ARN) of the Lambda function used as an endpoint.

        • Description (string) –

          A description of the C2C connector.

        • EndpointType (string) –

          The type of endpoint used for the C2C connector.

        • Id (string) –

          The identifier of the C2C connector.

        • Type (string) –

          The type of cloud connector created.

    • NextToken (string) –

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

Exceptions