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.
Parameters:
-
max_results
(Optional[ListStreamsInputLimit], default:
None
)
–
The maximum number of channels to return in the response. The default is 500.
-
next_token
(Optional[NextToken], default:
None
)
–
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.
-
channel_name_condition
(Optional[ChannelNameCondition], default:
None
)
–
Optional: Returns only the channels that satisfy a specific condition.
Raises:
Source code in docs_src/capo_kinesis_video/_services/kinesis_video.py
| def list_signaling_channels(
self,
*,
config_overrides: Optional[KinesisVideoClientConfig] = None,
max_results: Optional[
"capo_kinesis_video.types.list_streams_input_limit.ListStreamsInputLimit"
] = None,
next_token: Optional["capo_kinesis_video.types.next_token.NextToken"] = None,
channel_name_condition: Optional[
"capo_kinesis_video.types.channel_name_condition.ChannelNameCondition"
] = None,
) -> "capo_kinesis_video.types.list_signaling_channels_output.ListSignalingChannelsOutput":
"""<p>Returns an array of <code>ChannelInfo</code> objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a <code>ChannelNameCondition</code>.</p>
Args:
max_results: <p>The maximum number of channels to return in the response. The default is 500.</p>
next_token: <p>If you specify this parameter, when the result of a <code>ListSignalingChannels</code> operation is truncated, the call returns the <code>NextToken</code> in the response. To get another batch of channels, provide this token in your next request.</p>
channel_name_condition: <p>Optional: Returns only the channels that satisfy a specific condition.</p>
Raises:
capo_kinesis_video.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to perform this operation.</p>
capo_kinesis_video.errors.client_limit_exceeded_exception.ClientLimitExceededException: <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.</p>
capo_kinesis_video.errors.invalid_argument_exception.InvalidArgumentException: <p>The value for this input parameter is invalid.</p>
capo_kinesis_video.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kinesis_video.types.list_signaling_channels_input.ListSignalingChannelsInput]",
) -> OperationResponse[
"capo_kinesis_video.types.list_signaling_channels_output.ListSignalingChannelsOutput"
]:
import capo_kinesis_video._operations.kinesis_video_20170930.list_signaling_channels
output, http_response = (
capo_kinesis_video._operations.kinesis_video_20170930.list_signaling_channels.list_signaling_channels(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSignalingChannels")
)
input_: capo_kinesis_video.types.list_signaling_channels_input.ListSignalingChannelsInput = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if channel_name_condition is not None:
input_["channel_name_condition"] = channel_name_condition
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|