Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListChannels

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

Request Syntax


GET /spaces/spaceId/channels?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of channels to include in the results.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token for the next set of channel to return. You receive this token from a previous ListChannels operation.

spaceId

The unique ID of the private re:Post.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "channels": [ 
      { 
         "channelDescription": "string",
         "channelId": "string",
         "channelName": "string",
         "channelStatus": "string",
         "createDateTime": "string",
         "deleteDateTime": "string",
         "groupCount": number,
         "spaceId": "string",
         "userCount": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

channels

An array of structures that contain some information about the channels in the private re:Post.

Type: Array of ChannelData objects

nextToken

The token that you use when you request the next set of channels.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400