/AWS1/CL_FRH=>DESCRIBEDELIVERYSTREAM()
¶
About DescribeDeliveryStream¶
Describes the specified delivery stream and its status. For example, after your
delivery stream is created, call DescribeDeliveryStream
to see whether the
delivery stream is ACTIVE
and therefore ready for data to be sent to it.
If the status of a delivery 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.
If the status is DELETING_FAILED
, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DELIVERYSTREAMNAME
TYPE /AWS1/FRHDELIVERYSTREAMNAME
/AWS1/FRHDELIVERYSTREAMNAME
¶
The name of the delivery stream.
Optional arguments:¶
IV_LIMIT
TYPE /AWS1/FRHDSCDELIVERYSTRMINPLMT
/AWS1/FRHDSCDELIVERYSTRMINPLMT
¶
The limit on the number of destinations to return. You can have one destination per delivery stream.
IV_EXCLUSIVESTARTDSTID
TYPE /AWS1/FRHDESTINATIONID
/AWS1/FRHDESTINATIONID
¶
The ID of the destination to start returning the destination information. Firehose supports one destination per delivery stream.