| 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.ListSignalingChannels
Description
Returns an array of ChannelInfo objects. Each object describes a
signaling channel. To retrieve only those channels that satisfy a
specific condition, you can specify a ChannelNameCondition.
This operation returns paginated results.
Synopsis
- data ListSignalingChannels = ListSignalingChannels' {}
- newListSignalingChannels :: ListSignalingChannels
- listSignalingChannels_channelNameCondition :: Lens' ListSignalingChannels (Maybe ChannelNameCondition)
- listSignalingChannels_nextToken :: Lens' ListSignalingChannels (Maybe Text)
- listSignalingChannels_maxResults :: Lens' ListSignalingChannels (Maybe Natural)
- data ListSignalingChannelsResponse = ListSignalingChannelsResponse' {
- channelInfoList :: Maybe [ChannelInfo]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListSignalingChannelsResponse :: Int -> ListSignalingChannelsResponse
- listSignalingChannelsResponse_channelInfoList :: Lens' ListSignalingChannelsResponse (Maybe [ChannelInfo])
- listSignalingChannelsResponse_nextToken :: Lens' ListSignalingChannelsResponse (Maybe Text)
- listSignalingChannelsResponse_httpStatus :: Lens' ListSignalingChannelsResponse Int
Creating a Request
data ListSignalingChannels Source #
See: newListSignalingChannels smart constructor.
Constructors
| ListSignalingChannels' | |
Fields
| |
Instances
newListSignalingChannels :: ListSignalingChannels Source #
Create a value of ListSignalingChannels 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:channelNameCondition:ListSignalingChannels', listSignalingChannels_channelNameCondition - Optional: Returns only the channels that satisfy a specific condition.
$sel:nextToken:ListSignalingChannels', listSignalingChannels_nextToken - If you specify this parameter, when the result of a
ListSignalingChannels operation is truncated, the call returns the
NextToken in the response. To get another batch of channels, provide
this token in your next request.
$sel:maxResults:ListSignalingChannels', listSignalingChannels_maxResults - The maximum number of channels to return in the response. The default is
500.
Request Lenses
listSignalingChannels_channelNameCondition :: Lens' ListSignalingChannels (Maybe ChannelNameCondition) Source #
Optional: Returns only the channels that satisfy a specific condition.
listSignalingChannels_nextToken :: Lens' ListSignalingChannels (Maybe Text) Source #
If you specify this parameter, when the result of a
ListSignalingChannels operation is truncated, the call returns the
NextToken in the response. To get another batch of channels, provide
this token in your next request.
listSignalingChannels_maxResults :: Lens' ListSignalingChannels (Maybe Natural) Source #
The maximum number of channels to return in the response. The default is 500.
Destructuring the Response
data ListSignalingChannelsResponse Source #
See: newListSignalingChannelsResponse smart constructor.
Constructors
| ListSignalingChannelsResponse' | |
Fields
| |
Instances
newListSignalingChannelsResponse Source #
Create a value of ListSignalingChannelsResponse 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:channelInfoList:ListSignalingChannelsResponse', listSignalingChannelsResponse_channelInfoList - An array of ChannelInfo objects.
$sel:nextToken:ListSignalingChannels', listSignalingChannelsResponse_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:ListSignalingChannelsResponse', listSignalingChannelsResponse_httpStatus - The response's http status code.
Response Lenses
listSignalingChannelsResponse_channelInfoList :: Lens' ListSignalingChannelsResponse (Maybe [ChannelInfo]) Source #
An array of ChannelInfo objects.
listSignalingChannelsResponse_nextToken :: Lens' ListSignalingChannelsResponse (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.
listSignalingChannelsResponse_httpStatus :: Lens' ListSignalingChannelsResponse Int Source #
The response's http status code.