Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
Parameters:
-
channel_name
(Optional[ChannelName], default:
None
)
–
The name of the signaling channel that you want to describe.
-
channel_arn
(Optional[ResourceARN], default:
None
)
–
The ARN of the signaling channel that you want to describe.
Raises:
Source code in docs_src/capo_kinesis_video/_services/async_kinesis_video.py
| async def describe_signaling_channel(
self,
*,
config_overrides: Optional[AsyncKinesisVideoClientConfig] = None,
channel_name: Optional[
"capo_kinesis_video.types.channel_name.ChannelName"
] = None,
channel_arn: Optional[
"capo_kinesis_video.types.resource_arn.ResourceARN"
] = None,
) -> "capo_kinesis_video.types.describe_signaling_channel_output.DescribeSignalingChannelOutput":
"""<p>Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.</p>
Args:
channel_name: <p>The name of the signaling channel that you want to describe.</p>
channel_arn: <p>The ARN of the signaling channel that you want to describe.</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.resource_not_found_exception.ResourceNotFoundException: <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
capo_kinesis_video.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_kinesis_video.types.describe_signaling_channel_input.DescribeSignalingChannelInput]",
) -> AsyncOperationResponse[
"capo_kinesis_video.types.describe_signaling_channel_output.DescribeSignalingChannelOutput"
]:
import capo_kinesis_video._operations.kinesis_video_20170930.describe_signaling_channel
(
output,
http_response,
) = await capo_kinesis_video._operations.kinesis_video_20170930.describe_signaling_channel.async_describe_signaling_channel(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeSignalingChannel")
)
input_: capo_kinesis_video.types.describe_signaling_channel_input.DescribeSignalingChannelInput = {}
if channel_name is not None:
input_["channel_name"] = channel_name
if channel_arn is not None:
input_["channel_arn"] = channel_arn
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|