IoTAnalytics / Client / list_channels

list_channels

IoTAnalytics.Client.list_channels(**kwargs)

Retrieves a list of channels.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) –

    The maximum number of results to return in this request.

    The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'channelSummaries': [
        {
            'channelName': 'string',
            'channelStorage': {
                'serviceManagedS3': {},
                'customerManagedS3': {
                    'bucket': 'string',
                    'keyPrefix': 'string',
                    'roleArn': 'string'
                }
            },
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'lastMessageArrivalTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • channelSummaries (list) –

      A list of ChannelSummary objects.

      • (dict) –

        A summary of information about a channel.

        • channelName (string) –

          The name of the channel.

        • channelStorage (dict) –

          Where channel data is stored.

          • serviceManagedS3 (dict) –

            Used to store channel data in an S3 bucket managed by IoT Analytics.

          • customerManagedS3 (dict) –

            Used to store channel data in an S3 bucket that you manage.

            • bucket (string) –

              The name of the S3 bucket in which channel data is stored.

            • keyPrefix (string) –

              (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

            • roleArn (string) –

              The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.

        • status (string) –

          The status of the channel.

        • creationTime (datetime) –

          When the channel was created.

        • lastUpdateTime (datetime) –

          The last time the channel was updated.

        • lastMessageArrivalTime (datetime) –

          The last time when a new message arrived in the channel.

          IoT Analytics updates this value at most once per minute for one channel. Hence, the lastMessageArrivalTime value is an approximation.

          This feature only applies to messages that arrived in the data store after October 23, 2020.

    • nextToken (string) –

      The token to retrieve the next set of results, or null if there are no more results.

Exceptions