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 |
Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
Synopsis
- data ListStreamSessions = ListStreamSessions' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- channelArn :: Text
- newListStreamSessions :: Text -> ListStreamSessions
- listStreamSessions_maxResults :: Lens' ListStreamSessions (Maybe Natural)
- listStreamSessions_nextToken :: Lens' ListStreamSessions (Maybe Text)
- listStreamSessions_channelArn :: Lens' ListStreamSessions Text
- data ListStreamSessionsResponse = ListStreamSessionsResponse' {}
- newListStreamSessionsResponse :: Int -> ListStreamSessionsResponse
- listStreamSessionsResponse_nextToken :: Lens' ListStreamSessionsResponse (Maybe Text)
- listStreamSessionsResponse_httpStatus :: Lens' ListStreamSessionsResponse Int
- listStreamSessionsResponse_streamSessions :: Lens' ListStreamSessionsResponse [StreamSessionSummary]
Creating a Request
data ListStreamSessions Source #
See: newListStreamSessions
smart constructor.
ListStreamSessions' | |
|
Instances
newListStreamSessions Source #
Create a value of ListStreamSessions
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:maxResults:ListStreamSessions'
, listStreamSessions_maxResults
- Maximum number of streams to return. Default: 100.
ListStreamSessions
, listStreamSessions_nextToken
- The first stream to retrieve. This is used for pagination; see the
nextToken
response field.
ListStreamSessions
, listStreamSessions_channelArn
- Channel ARN used to filter the list.
Request Lenses
listStreamSessions_maxResults :: Lens' ListStreamSessions (Maybe Natural) Source #
Maximum number of streams to return. Default: 100.
listStreamSessions_nextToken :: Lens' ListStreamSessions (Maybe Text) Source #
The first stream to retrieve. This is used for pagination; see the
nextToken
response field.
listStreamSessions_channelArn :: Lens' ListStreamSessions Text Source #
Channel ARN used to filter the list.
Destructuring the Response
data ListStreamSessionsResponse Source #
See: newListStreamSessionsResponse
smart constructor.
ListStreamSessionsResponse' | |
|
Instances
newListStreamSessionsResponse Source #
Create a value of ListStreamSessionsResponse
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:
ListStreamSessions
, listStreamSessionsResponse_nextToken
- If there are more streams than maxResults
, use nextToken
in the
request to get the next set.
$sel:httpStatus:ListStreamSessionsResponse'
, listStreamSessionsResponse_httpStatus
- The response's http status code.
$sel:streamSessions:ListStreamSessionsResponse'
, listStreamSessionsResponse_streamSessions
- List of stream sessions.
Response Lenses
listStreamSessionsResponse_nextToken :: Lens' ListStreamSessionsResponse (Maybe Text) Source #
If there are more streams than maxResults
, use nextToken
in the
request to get the next set.
listStreamSessionsResponse_httpStatus :: Lens' ListStreamSessionsResponse Int Source #
The response's http status code.
listStreamSessionsResponse_streamSessions :: Lens' ListStreamSessionsResponse [StreamSessionSummary] Source #
List of stream sessions.