ManagedintegrationsforIoTDeviceManagement / Paginator / ListCloudConnectors

ListCloudConnectors

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListCloudConnectors

paginator = client.get_paginator('list_cloud_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ManagedintegrationsforIoTDeviceManagement.Client.list_cloud_connectors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Type='LISTED'|'UNLISTED',
    LambdaArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.