| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisVideo.ListStreams
Description
Returns an array of StreamInfo objects. Each object describes a
stream. To retrieve only streams that satisfy a specific condition, you
can specify a StreamNameCondition.
This operation returns paginated results.
Synopsis
- data ListStreams = ListStreams' {}
- newListStreams :: ListStreams
- listStreams_nextToken :: Lens' ListStreams (Maybe Text)
- listStreams_streamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition)
- listStreams_maxResults :: Lens' ListStreams (Maybe Natural)
- data ListStreamsResponse = ListStreamsResponse' {
- streamInfoList :: Maybe [StreamInfo]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListStreamsResponse :: Int -> ListStreamsResponse
- listStreamsResponse_streamInfoList :: Lens' ListStreamsResponse (Maybe [StreamInfo])
- listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text)
- listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int
Creating a Request
data ListStreams Source #
See: newListStreams smart constructor.
Constructors
| ListStreams' | |
Fields
| |
Instances
newListStreams :: ListStreams Source #
Create a value of ListStreams with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListStreams', listStreams_nextToken - If you specify this parameter, when the result of a ListStreams
operation is truncated, the call returns the NextToken in the
response. To get another batch of streams, provide this token in your
next request.
$sel:streamNameCondition:ListStreams', listStreams_streamNameCondition - Optional: Returns only streams that satisfy a specific condition.
Currently, you can specify only the prefix of a stream name as a
condition.
$sel:maxResults:ListStreams', listStreams_maxResults - The maximum number of streams to return in the response. The default is
10,000.
Request Lenses
listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #
If you specify this parameter, when the result of a ListStreams
operation is truncated, the call returns the NextToken in the
response. To get another batch of streams, provide this token in your
next request.
listStreams_streamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition) Source #
Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.
listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #
The maximum number of streams to return in the response. The default is 10,000.
Destructuring the Response
data ListStreamsResponse Source #
See: newListStreamsResponse smart constructor.
Constructors
| ListStreamsResponse' | |
Fields
| |
Instances
newListStreamsResponse Source #
Arguments
| :: Int | |
| -> ListStreamsResponse |
Create a value of ListStreamsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamInfoList:ListStreamsResponse', listStreamsResponse_streamInfoList - An array of StreamInfo objects.
$sel:nextToken:ListStreams', listStreamsResponse_nextToken - If the response is truncated, the call returns this element with a
token. To get the next batch of streams, use this token in your next
request.
$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.
Response Lenses
listStreamsResponse_streamInfoList :: Lens' ListStreamsResponse (Maybe [StreamInfo]) Source #
An array of StreamInfo objects.
listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #
If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.
listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #
The response's http status code.