list_streams `async` ¶

list_streams(
    cluster_identifier: ClusterId,
    *,
    config_overrides: Optional[AsyncDSQLClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListStreamsOutput

Retrieves information about a list of streams for a cluster.

Parameters:

cluster_identifier (ClusterId) –

The ID of the cluster for which to list streams.
max_results (Optional[MaxResults], default: None ) –

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.
next_token (Optional[NextToken], default: None ) –

If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.

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 list_streams(
    self,
    cluster_identifier: "capo_dsql.types.cluster_id.ClusterId",
    *,
    config_overrides: Optional[AsyncDSQLClientConfig] = None,
    max_results: Optional["capo_dsql.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_dsql.types.next_token.NextToken"] = None,
) -> "capo_dsql.types.list_streams_output.ListStreamsOutput":
    """<p>Retrieves information about a list of streams for a cluster.</p>

    Args:
        cluster_identifier: <p>The ID of the cluster for which to list streams.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.</p>
        next_token: <p>If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.</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.list_streams_input.ListStreamsInput]",
    ) -> AsyncOperationResponse[
        "capo_dsql.types.list_streams_output.ListStreamsOutput"
    ]:
        import capo_dsql._operations.dsql.list_streams

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListStreams")
    )
    input_: capo_dsql.types.list_streams_input.ListStreamsInput = {
        "cluster_identifier": cluster_identifier
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_streams async ¶

list_streams `async` ¶