describe_stream `async` ¶

describe_stream(
    stream_id: StreamId, *, config_overrides: Optional[AsyncIoTClientConfig] = None
) -> DescribeStreamResponse

Gets information about a stream.

Requires permission to access the DescribeStream action.

Parameters:

stream_id (StreamId) –

The stream ID.

Raises:

InternalFailureException –

An unexpected error has occurred.
InvalidRequestException –

The request is not valid.
ResourceNotFoundException –

The specified resource does not exist.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The rate exceeds the limit.
UnauthorizedException –

You are not authorized to perform this operation.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iot/_services/async_io_t.py

async def describe_stream(
    self,
    stream_id: "capo_iot.types.stream_id.StreamId",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
) -> "capo_iot.types.describe_stream_response.DescribeStreamResponse":
    """<p>Gets information about a stream.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeStream</a> action.</p>

    Args:
        stream_id: <p>The stream ID.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.describe_stream_request.DescribeStreamRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.describe_stream_response.DescribeStreamResponse"
    ]:
        import capo_iot._operations.aws_iot_service.describe_stream

        (
            output,
            http_response,
        ) = await capo_iot._operations.aws_iot_service.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_iot.types.describe_stream_request.DescribeStreamRequest = {
        "stream_id": stream_id
    }

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

describe_stream async ¶

describe_stream `async` ¶