| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IVS.ListStreams
Description
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
This operation returns paginated results.
Synopsis
- data ListStreams = ListStreams' {}
- newListStreams :: ListStreams
- listStreams_filterBy :: Lens' ListStreams (Maybe StreamFilters)
- listStreams_maxResults :: Lens' ListStreams (Maybe Natural)
- listStreams_nextToken :: Lens' ListStreams (Maybe Text)
- data ListStreamsResponse = ListStreamsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- streams :: [StreamSummary]
- newListStreamsResponse :: Int -> ListStreamsResponse
- listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text)
- listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int
- listStreamsResponse_streams :: Lens' ListStreamsResponse [StreamSummary]
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:filterBy:ListStreams', listStreams_filterBy - Filters the stream list to match the specified criterion.
$sel:maxResults:ListStreams', listStreams_maxResults - Maximum number of streams to return. Default: 100.
ListStreams, listStreams_nextToken - The first stream to retrieve. This is used for pagination; see the
nextToken response field.
Request Lenses
listStreams_filterBy :: Lens' ListStreams (Maybe StreamFilters) Source #
Filters the stream list to match the specified criterion.
listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #
Maximum number of streams to return. Default: 100.
listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #
The first stream to retrieve. This is used for pagination; see the
nextToken response field.
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:
ListStreams, listStreamsResponse_nextToken - If there are more streams than maxResults, use nextToken in the
request to get the next set.
$sel:httpStatus:ListStreamsResponse', listStreamsResponse_httpStatus - The response's http status code.
$sel:streams:ListStreamsResponse', listStreamsResponse_streams - List of streams.
Response Lenses
listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #
If there are more streams than maxResults, use nextToken in the
request to get the next set.
listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #
The response's http status code.
listStreamsResponse_streams :: Lens' ListStreamsResponse [StreamSummary] Source #
List of streams.