rePostPrivate / Client / list_channels

list_channels¶

rePostPrivate.Client.list_channels(**kwargs)¶

Returns the list of channel within a private re:Post with some information about each channel.

Request Syntax

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

Parameters:

spaceId (string) –
[REQUIRED]

The unique ID of the private re:Post.
nextToken (string) – The token for the next set of channel to return. You receive this token from a previous ListChannels operation.
maxResults (integer) – The maximum number of channels to include in the results.

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) –
  
  The token that you use when you request the next set of channels.

Exceptions

rePostPrivate.Client.exceptions.ValidationException
rePostPrivate.Client.exceptions.AccessDeniedException
rePostPrivate.Client.exceptions.ThrottlingException
rePostPrivate.Client.exceptions.InternalServerException