Menu
Amazon Kinesis Firehose API Reference
API Reference (API Version 2015-08-04)

DeliveryStreamDescription

Contains information about a delivery stream.

Contents

CreateTimestamp

The date and time that the delivery stream was created.

Type: Timestamp

Required: No

DeliveryStreamARN

The Amazon Resource Name (ARN) of the delivery stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: Yes

DeliveryStreamName

The name of the delivery stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

DeliveryStreamStatus

The status of the delivery stream.

Type: String

Valid Values: CREATING | DELETING | ACTIVE

Required: Yes

DeliveryStreamType

The delivery stream type. This can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.

  • KinesisStreamAsSource: The delivery stream uses a Kinesis stream as a source.

Type: String

Valid Values: DirectPut | KinesisStreamAsSource

Required: Yes

Destinations

The destinations.

Type: Array of DestinationDescription objects

Required: Yes

HasMoreDestinations

Indicates whether there are more destinations available to list.

Type: Boolean

Required: Yes

LastUpdateTimestamp

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

Type: Timestamp

Required: No

Source

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

Type: SourceDescription object

Required: No

VersionId

Each time the destination is updated for a delivery 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [0-9]+

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: