Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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
.
- listStreams :: ListStreams
- data ListStreams
- lsNextToken :: Lens' ListStreams (Maybe Text)
- lsStreamNameCondition :: Lens' ListStreams (Maybe StreamNameCondition)
- lsMaxResults :: Lens' ListStreams (Maybe Natural)
- listStreamsResponse :: Int -> ListStreamsResponse
- data ListStreamsResponse
- lsrsStreamInfoList :: Lens' ListStreamsResponse [StreamInfo]
- lsrsNextToken :: Lens' ListStreamsResponse (Maybe Text)
- lsrsResponseStatus :: Lens' ListStreamsResponse Int
Creating a Request
listStreams :: ListStreams Source #
Creates a value of ListStreams
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsNextToken
- If you specify this parameter, when the result of aListStreams
operation is truncated, the call returns theNextToken
in the response. To get another batch of streams, provide this token in your next request.lsStreamNameCondition
- Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.lsMaxResults
- The maximum number of streams to return in the response. The default is 10,000.
data ListStreams Source #
See: listStreams
smart constructor.
Request Lenses
lsNextToken :: 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.
lsStreamNameCondition :: 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.
lsMaxResults :: Lens' ListStreams (Maybe Natural) Source #
The maximum number of streams to return in the response. The default is 10,000.
Destructuring the Response
Creates a value of ListStreamsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrsStreamInfoList
- An array ofStreamInfo
objects.lsrsNextToken
- 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.lsrsResponseStatus
- -- | The response status code.
data ListStreamsResponse Source #
See: listStreamsResponse
smart constructor.
Response Lenses
lsrsStreamInfoList :: Lens' ListStreamsResponse [StreamInfo] Source #
An array of StreamInfo
objects.
lsrsNextToken :: 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.
lsrsResponseStatus :: Lens' ListStreamsResponse Int Source #
- - | The response status code.