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

DescribeDeliveryStream

Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it.

Request Syntax

{
   "DeliveryStreamName": "string",
   "ExclusiveStartDestinationId": "string",
   "Limit": number
}

Request Parameters

The request accepts the following data in JSON format.

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

ExclusiveStartDestinationId

The ID of the destination to start returning the destination information. Currently, Kinesis Firehose supports one destination per delivery stream.

Type: String

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

Required: No

Limit

The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No

Response Syntax

{
   "DeliveryStreamDescription": { 
      "CreateTimestamp": number,
      "DeliveryStreamARN": "string",
      "DeliveryStreamName": "string",
      "DeliveryStreamStatus": "string",
      "DeliveryStreamType": "string",
      "Destinations": [ 
         { 
            "DestinationId": "string",
            "ElasticsearchDestinationDescription": { 
               "BufferingHints": { 
                  "IntervalInSeconds": number,
                  "SizeInMBs": number
               },
               "CloudWatchLoggingOptions": { 
                  "Enabled": boolean,
                  "LogGroupName": "string",
                  "LogStreamName": "string"
               },
               "DomainARN": "string",
               "IndexName": "string",
               "IndexRotationPeriod": "string",
               "ProcessingConfiguration": { 
                  "Enabled": boolean,
                  "Processors": [ 
                     { 
                        "Parameters": [ 
                           { 
                              "ParameterName": "string",
                              "ParameterValue": "string"
                           }
                        ],
                        "Type": "string"
                     }
                  ]
               },
               "RetryOptions": { 
                  "DurationInSeconds": number
               },
               "RoleARN": "string",
               "S3BackupMode": "string",
               "S3DestinationDescription": { 
                  "BucketARN": "string",
                  "BufferingHints": { 
                     "IntervalInSeconds": number,
                     "SizeInMBs": number
                  },
                  "CloudWatchLoggingOptions": { 
                     "Enabled": boolean,
                     "LogGroupName": "string",
                     "LogStreamName": "string"
                  },
                  "CompressionFormat": "string",
                  "EncryptionConfiguration": { 
                     "KMSEncryptionConfig": { 
                        "AWSKMSKeyARN": "string"
                     },
                     "NoEncryptionConfig": "string"
                  },
                  "Prefix": "string",
                  "RoleARN": "string"
               },
               "TypeName": "string"
            },
            "ExtendedS3DestinationDescription": { 
               "BucketARN": "string",
               "BufferingHints": { 
                  "IntervalInSeconds": number,
                  "SizeInMBs": number
               },
               "CloudWatchLoggingOptions": { 
                  "Enabled": boolean,
                  "LogGroupName": "string",
                  "LogStreamName": "string"
               },
               "CompressionFormat": "string",
               "EncryptionConfiguration": { 
                  "KMSEncryptionConfig": { 
                     "AWSKMSKeyARN": "string"
                  },
                  "NoEncryptionConfig": "string"
               },
               "Prefix": "string",
               "ProcessingConfiguration": { 
                  "Enabled": boolean,
                  "Processors": [ 
                     { 
                        "Parameters": [ 
                           { 
                              "ParameterName": "string",
                              "ParameterValue": "string"
                           }
                        ],
                        "Type": "string"
                     }
                  ]
               },
               "RoleARN": "string",
               "S3BackupDescription": { 
                  "BucketARN": "string",
                  "BufferingHints": { 
                     "IntervalInSeconds": number,
                     "SizeInMBs": number
                  },
                  "CloudWatchLoggingOptions": { 
                     "Enabled": boolean,
                     "LogGroupName": "string",
                     "LogStreamName": "string"
                  },
                  "CompressionFormat": "string",
                  "EncryptionConfiguration": { 
                     "KMSEncryptionConfig": { 
                        "AWSKMSKeyARN": "string"
                     },
                     "NoEncryptionConfig": "string"
                  },
                  "Prefix": "string",
                  "RoleARN": "string"
               },
               "S3BackupMode": "string"
            },
            "RedshiftDestinationDescription": { 
               "CloudWatchLoggingOptions": { 
                  "Enabled": boolean,
                  "LogGroupName": "string",
                  "LogStreamName": "string"
               },
               "ClusterJDBCURL": "string",
               "CopyCommand": { 
                  "CopyOptions": "string",
                  "DataTableColumns": "string",
                  "DataTableName": "string"
               },
               "ProcessingConfiguration": { 
                  "Enabled": boolean,
                  "Processors": [ 
                     { 
                        "Parameters": [ 
                           { 
                              "ParameterName": "string",
                              "ParameterValue": "string"
                           }
                        ],
                        "Type": "string"
                     }
                  ]
               },
               "RetryOptions": { 
                  "DurationInSeconds": number
               },
               "RoleARN": "string",
               "S3BackupDescription": { 
                  "BucketARN": "string",
                  "BufferingHints": { 
                     "IntervalInSeconds": number,
                     "SizeInMBs": number
                  },
                  "CloudWatchLoggingOptions": { 
                     "Enabled": boolean,
                     "LogGroupName": "string",
                     "LogStreamName": "string"
                  },
                  "CompressionFormat": "string",
                  "EncryptionConfiguration": { 
                     "KMSEncryptionConfig": { 
                        "AWSKMSKeyARN": "string"
                     },
                     "NoEncryptionConfig": "string"
                  },
                  "Prefix": "string",
                  "RoleARN": "string"
               },
               "S3BackupMode": "string",
               "S3DestinationDescription": { 
                  "BucketARN": "string",
                  "BufferingHints": { 
                     "IntervalInSeconds": number,
                     "SizeInMBs": number
                  },
                  "CloudWatchLoggingOptions": { 
                     "Enabled": boolean,
                     "LogGroupName": "string",
                     "LogStreamName": "string"
                  },
                  "CompressionFormat": "string",
                  "EncryptionConfiguration": { 
                     "KMSEncryptionConfig": { 
                        "AWSKMSKeyARN": "string"
                     },
                     "NoEncryptionConfig": "string"
                  },
                  "Prefix": "string",
                  "RoleARN": "string"
               },
               "Username": "string"
            },
            "S3DestinationDescription": { 
               "BucketARN": "string",
               "BufferingHints": { 
                  "IntervalInSeconds": number,
                  "SizeInMBs": number
               },
               "CloudWatchLoggingOptions": { 
                  "Enabled": boolean,
                  "LogGroupName": "string",
                  "LogStreamName": "string"
               },
               "CompressionFormat": "string",
               "EncryptionConfiguration": { 
                  "KMSEncryptionConfig": { 
                     "AWSKMSKeyARN": "string"
                  },
                  "NoEncryptionConfig": "string"
               },
               "Prefix": "string",
               "RoleARN": "string"
            }
         }
      ],
      "HasMoreDestinations": boolean,
      "LastUpdateTimestamp": number,
      "Source": { 
         "KinesisStreamSourceDescription": { 
            "DeliveryStartTimestamp": number,
            "KinesisStreamARN": "string",
            "RoleARN": "string"
         }
      },
      "VersionId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DeliveryStreamDescription

Information about the delivery stream.

Type: DeliveryStreamDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 400

See Also

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