list_delivery_streams `async` ¶

list_delivery_streams(
    *,
    config_overrides: Optional[AsyncFirehoseClientConfig] = None,
    limit: Optional[ListDeliveryStreamsInputLimit] = None,
    delivery_stream_type: Optional[DeliveryStreamType] = None,
    exclusive_start_delivery_stream_name: Optional[DeliveryStreamName] = None,
) -> ListDeliveryStreamsOutput

Lists your Firehose streams in alphabetical order of their names.

The number of Firehose streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of Firehose streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more Firehose streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last Firehose stream returned in the last call.

Parameters:

limit (Optional[ListDeliveryStreamsInputLimit], default: None ) –

The maximum number of Firehose streams to list. The default value is 10.
delivery_stream_type (Optional[DeliveryStreamType], default: None ) –
The Firehose stream type. This can be one of the following values:
- DirectPut: Provider applications access the Firehose stream directly.
- KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
This parameter is optional. If this parameter is omitted, Firehose streams of all types are returned.
exclusive_start_delivery_stream_name (Optional[DeliveryStreamName], default: None ) –

The list of Firehose streams returned by this call to ListDeliveryStreams will start with the Firehose stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

Raises:

UnknownServiceError –

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

Source code in docs_src/capo_firehose/_services/async_firehose.py

async def list_delivery_streams(
    self,
    *,
    config_overrides: Optional[AsyncFirehoseClientConfig] = None,
    limit: Optional[
        "capo_firehose.types.list_delivery_streams_input_limit.ListDeliveryStreamsInputLimit"
    ] = None,
    delivery_stream_type: Optional[
        "capo_firehose.types.delivery_stream_type.DeliveryStreamType"
    ] = None,
    exclusive_start_delivery_stream_name: Optional[
        "capo_firehose.types.delivery_stream_name.DeliveryStreamName"
    ] = None,
) -> "capo_firehose.types.list_delivery_streams_output.ListDeliveryStreamsOutput":
    """<p>Lists your Firehose streams in alphabetical order of their names.</p> <p>The number of Firehose streams might be too large to return using a single call to <code>ListDeliveryStreams</code>. You can limit the number of Firehose streams returned, using the <code>Limit</code> parameter. To determine whether there are more delivery streams to list, check the value of <code>HasMoreDeliveryStreams</code> in the output. If there are more Firehose streams to list, you can request them by calling this operation again and setting the <code>ExclusiveStartDeliveryStreamName</code> parameter to the name of the last Firehose stream returned in the last call.</p>

    Args:
        limit: <p>The maximum number of Firehose streams to list. The default value is 10.</p>
        delivery_stream_type: <p>The Firehose stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the Firehose stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The Firehose stream uses a Kinesis data stream as a source.</p> </li> </ul> <p>This parameter is optional. If this parameter is omitted, Firehose streams of all types are returned.</p>
        exclusive_start_delivery_stream_name: <p>The list of Firehose streams returned by this call to <code>ListDeliveryStreams</code> will start with the Firehose stream whose name comes alphabetically immediately after the name you specify in <code>ExclusiveStartDeliveryStreamName</code>.</p>

    Raises:
        capo_firehose.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_firehose.types.list_delivery_streams_input.ListDeliveryStreamsInput]",
    ) -> AsyncOperationResponse[
        "capo_firehose.types.list_delivery_streams_output.ListDeliveryStreamsOutput"
    ]:
        import capo_firehose._operations.firehose_20150804.list_delivery_streams

        (
            output,
            http_response,
        ) = await capo_firehose._operations.firehose_20150804.list_delivery_streams.async_list_delivery_streams(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDeliveryStreams")
    )
    input_: capo_firehose.types.list_delivery_streams_input.ListDeliveryStreamsInput = {}
    if limit is not None:
        input_["limit"] = limit
    if delivery_stream_type is not None:
        input_["delivery_stream_type"] = delivery_stream_type
    if exclusive_start_delivery_stream_name is not None:
        input_["exclusive_start_delivery_stream_name"] = (
            exclusive_start_delivery_stream_name
        )

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

list_delivery_streams async ¶

list_delivery_streams `async` ¶