get_stream `async` ¶

get_stream(
    cluster_identifier: ClusterId,
    stream_identifier: StreamId,
    *,
    config_overrides: Optional[AsyncDSQLClientConfig] = None,
) -> GetStreamOutput

Retrieves information about a stream.

Parameters:

cluster_identifier (ClusterId) –

The ID of the cluster containing the stream to retrieve.
stream_identifier (StreamId) –

The ID of the stream to retrieve.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input failed to satisfy the constraints specified by an Amazon Web Services service.
ResourceNotFoundException –

The resource could not be found.
UnknownServiceError –

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

Source code in docs_src/capo_dsql/_services/async_dsql.py

async def get_stream(
    self,
    cluster_identifier: "capo_dsql.types.cluster_id.ClusterId",
    stream_identifier: "capo_dsql.types.stream_id.StreamId",
    *,
    config_overrides: Optional[AsyncDSQLClientConfig] = None,
) -> "capo_dsql.types.get_stream_output.GetStreamOutput":
    """<p>Retrieves information about a stream.</p>

    Args:
        cluster_identifier: <p>The ID of the cluster containing the stream to retrieve.</p>
        stream_identifier: <p>The ID of the stream to retrieve.</p>

    Raises:
        capo_dsql.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_dsql.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_dsql.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_dsql.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_dsql.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_dsql.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dsql.types.get_stream_input.GetStreamInput]",
    ) -> AsyncOperationResponse[
        "capo_dsql.types.get_stream_output.GetStreamOutput"
    ]:
        import capo_dsql._operations.dsql.get_stream

        (
            output,
            http_response,
        ) = await capo_dsql._operations.dsql.get_stream.async_get_stream(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetStream")
    )
    input_: capo_dsql.types.get_stream_input.GetStreamInput = {
        "cluster_identifier": cluster_identifier,
        "stream_identifier": stream_identifier,
    }

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

get_stream async ¶

get_stream `async` ¶