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

ListStreams

Gets summary information about live streams in your account, in the AWS region where the API request is processed.

Request Syntax


POST /ListStreams HTTP/1.1
Content-type: application/json

{
   "filterBy": { 
      "health": "string"
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterBy

Filters the stream list to match the specified criterion.

Type: StreamFilters object

Required: No

maxResults

Maximum number of streams to return. Default: 100.

Type: Integer

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

Required: No

nextToken

The first stream to retrieve. This is used for pagination; see the nextToken response field.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [a-zA-Z0-9+/=_-]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "streams": [ 
      { 
         "channelArn": "string",
         "health": "string",
         "startTime": "string",
         "state": "string",
         "streamId": "string",
         "viewerCount": number
      }
   ]
}

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.

nextToken

If there are more streams than maxResults, use nextToken in the request to get the next set.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [a-zA-Z0-9+/=_-]*

streams

List of streams.

Type: Array of StreamSummary objects

Errors

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

AccessDeniedException

exceptionMessage: User does not have sufficient access to perform this action.

HTTP Status Code: 403

ValidationException

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

HTTP Status Code: 400