describe_stream async ¶

async def describe_stream(
    self,
    *,
    config_overrides: Optional[AsyncKinesisVideoClientConfig] = None,
    stream_name: Optional["capo_kinesis_video.types.stream_name.StreamName"] = None,
    stream_arn: Optional[
        "capo_kinesis_video.types.resource_arn.ResourceARN"
    ] = None,
) -> "capo_kinesis_video.types.describe_stream_output.DescribeStreamOutput":
    """<p>Returns the most current information about the specified stream. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>. </p>

    Args:
        stream_name: <p>The name of the stream.</p>
        stream_arn: <p>The Amazon Resource Name (ARN) of the stream.</p>

    Raises:
        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.not_authorized_exception.NotAuthorizedException: <p>The caller is not authorized to perform this operation.</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_stream_input.DescribeStreamInput]",
    ) -> AsyncOperationResponse[
        "capo_kinesis_video.types.describe_stream_output.DescribeStreamOutput"
    ]:
        import capo_kinesis_video._operations.kinesis_video_20170930.describe_stream

        (
            output,
            http_response,
        ) = await capo_kinesis_video._operations.kinesis_video_20170930.describe_stream.async_describe_stream(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeStream")
    )
    input_: capo_kinesis_video.types.describe_stream_input.DescribeStreamInput = {}
    if stream_name is not None:
        input_["stream_name"] = stream_name
    if stream_arn is not None:
        input_["stream_arn"] = stream_arn

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output