rePostPrivate / Paginator / ListChannels

ListChannels¶

class rePostPrivate.Paginator.ListChannels¶

paginator = client.get_paginator('list_channels')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from rePostPrivate.Client.list_channels().

Request Syntax

response_iterator = paginator.paginate(
    spaceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

spaceId (string) –
[REQUIRED]

The unique ID of the private re:Post.
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

{
    'channels': [
        {
            'spaceId': 'string',
            'channelId': 'string',
            'channelName': 'string',
            'channelDescription': 'string',
            'createDateTime': datetime(2015, 1, 1),
            'deleteDateTime': datetime(2015, 1, 1),
            'channelStatus': 'CREATED'|'CREATING'|'CREATE_FAILED'|'DELETED'|'DELETING'|'DELETE_FAILED',
            'userCount': 123,
            'groupCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- channels (list) –
  
  An array of structures that contain some information about the channels in the private re:Post.
  - (dict) –
    
    A structure that contains some information about a channel in a private re:Post.
    - spaceId (string) –
      
      The unique ID of the private re:Post.
    - channelId (string) –
      
      The unique ID of the private re:Post channel.
    - channelName (string) –
      
      The name for the channel. This must be unique per private re:Post.
    - channelDescription (string) –
      
      A description for the channel. This is used only to help you identify this channel.
    - createDateTime (datetime) –
      
      The date when the channel was created.
    - deleteDateTime (datetime) –
      
      The date when the channel was deleted.
    - channelStatus (string) –
      
      The status pf the channel.
    - userCount (integer) –
      
      The number of users that are part of the channel.
    - groupCount (integer) –
      
      The number of groups that are part of the channel.
- NextToken (string) –
  
  A token to resume pagination.