ListChannels
Retrieves a list of channels.
Request Syntax
GET /channels?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return in this request.
The default value is 100.
Valid Range: Minimum value of 1. Maximum value of 250.
- nextToken
-
The token for the next set of results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"channelSummaries": [
{
"channelName": "string",
"channelStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"creationTime": number,
"lastMessageArrivalTime": number,
"lastUpdateTime": number,
"status": "string"
}
],
"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.
- channelSummaries
-
A list of
ChannelSummary
objects.Type: Array of ChannelSummary objects
- nextToken
-
The token to retrieve the next set of results, or
null
if there are no more results.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
There was an internal failure.
HTTP Status Code: 500
- InvalidRequestException
-
The request was not valid.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: