Skip to content

DeliveryStreamDescription

Source code in docs_src/capo_firehose/types/delivery_stream_description.py
class DeliveryStreamDescription(TypedDict, closed=True):
    delivery_stream_name: "capo_firehose.types.delivery_stream_name.DeliveryStreamName"
    """<p>The name of the Firehose stream.</p>"""
    delivery_stream_arn: "capo_firehose.types.delivery_stream_arn.DeliveryStreamARN"
    """<p>The Amazon Resource Name (ARN) of the Firehose stream. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>"""
    delivery_stream_status: (
        "capo_firehose.types.delivery_stream_status.DeliveryStreamStatus"
    )
    """<p>The status of the Firehose stream. If the status of a Firehose stream is <code>CREATING_FAILED</code>, this status doesn't change, and you can't invoke <code>CreateDeliveryStream</code> again on it. However, you can invoke the <a>DeleteDeliveryStream</a> operation to delete it.</p>"""
    failure_description: NotRequired[
        "capo_firehose.types.failure_description.FailureDescription"
    ]
    """<p>Provides details in case one of the following operations fails due to an error related to KMS: <a>CreateDeliveryStream</a>, <a>DeleteDeliveryStream</a>, <a>StartDeliveryStreamEncryption</a>, <a>StopDeliveryStreamEncryption</a>.</p>"""
    delivery_stream_encryption_configuration: NotRequired[
        "capo_firehose.types.delivery_stream_encryption_configuration.DeliveryStreamEncryptionConfiguration"
    ]
    """<p>Indicates the server-side encryption (SSE) status for the Firehose stream.</p>"""
    delivery_stream_type: "capo_firehose.types.delivery_stream_type.DeliveryStreamType"
    """<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>"""
    version_id: "capo_firehose.types.delivery_stream_version_id.DeliveryStreamVersionId"
    """<p>Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.</p>"""
    create_timestamp: NotRequired["capo_firehose.types.timestamp.Timestamp"]
    """<p>The date and time that the Firehose stream was created.</p>"""
    last_update_timestamp: NotRequired["capo_firehose.types.timestamp.Timestamp"]
    """<p>The date and time that the Firehose stream was last updated.</p>"""
    source: NotRequired["capo_firehose.types.source_description.SourceDescription"]
    """<p>If the <code>DeliveryStreamType</code> parameter is <code>KinesisStreamAsSource</code>, a <a>SourceDescription</a> object describing the source Kinesis data stream.</p>"""
    destinations: (
        "capo_firehose.types.destination_description_list.DestinationDescriptionList"
    )
    """<p>The destinations.</p>"""
    has_more_destinations: "capo_firehose.types.boolean_object.BooleanObject"
    """<p>Indicates whether there are more destinations available to list.</p>"""

create_timestamp instance-attribute

create_timestamp: NotRequired[Timestamp]

The date and time that the Firehose stream was created.

delivery_stream_arn instance-attribute

delivery_stream_arn: DeliveryStreamARN

The Amazon Resource Name (ARN) of the Firehose stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

delivery_stream_encryption_configuration instance-attribute

delivery_stream_encryption_configuration: NotRequired[
    DeliveryStreamEncryptionConfiguration
]

Indicates the server-side encryption (SSE) status for the Firehose stream.

delivery_stream_name instance-attribute

delivery_stream_name: DeliveryStreamName

The name of the Firehose stream.

delivery_stream_status instance-attribute

delivery_stream_status: DeliveryStreamStatus

The status of the Firehose stream. If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

delivery_stream_type instance-attribute

delivery_stream_type: DeliveryStreamType

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.

destinations instance-attribute

The destinations.

failure_description instance-attribute

failure_description: NotRequired[FailureDescription]

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

has_more_destinations instance-attribute

has_more_destinations: BooleanObject

Indicates whether there are more destinations available to list.

last_update_timestamp instance-attribute

last_update_timestamp: NotRequired[Timestamp]

The date and time that the Firehose stream was last updated.

source instance-attribute

source: NotRequired[SourceDescription]

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

version_id instance-attribute

Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.