Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeDeliveryStreamCommand

Describes the specified Firehose stream and its status. For example, after your Firehose stream is created, call DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready for data to be sent to it.
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. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.
Example Syntax

Use a bare-bones client and the command you need to make an API call.
import { FirehoseClient, DescribeDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
// const { FirehoseClient, DescribeDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
const client = new FirehoseClient(config);
const input = { // DescribeDeliveryStreamInput
  DeliveryStreamName: "STRING_VALUE", // required
  Limit: Number("int"),
  ExclusiveStartDestinationId: "STRING_VALUE",
};
const command = new DescribeDeliveryStreamCommand(input);
const response = await client.send(command);
// { // DescribeDeliveryStreamOutput
//   DeliveryStreamDescription: { // DeliveryStreamDescription
//     DeliveryStreamName: "STRING_VALUE", // required
//     DeliveryStreamARN: "STRING_VALUE", // required
//     DeliveryStreamStatus: "CREATING" || "CREATING_FAILED" || "DELETING" || "DELETING_FAILED" || "ACTIVE", // required
//     FailureDescription: { // FailureDescription
//       Type: "VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND" || "VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED" || "RETIRE_KMS_GRANT_FAILED" || "CREATE_KMS_GRANT_FAILED" || "KMS_ACCESS_DENIED" || "DISABLED_KMS_KEY" || "INVALID_KMS_KEY" || "KMS_KEY_NOT_FOUND" || "KMS_OPT_IN_REQUIRED" || "CREATE_ENI_FAILED" || "DELETE_ENI_FAILED" || "SUBNET_NOT_FOUND" || "SECURITY_GROUP_NOT_FOUND" || "ENI_ACCESS_DENIED" || "SUBNET_ACCESS_DENIED" || "SECURITY_GROUP_ACCESS_DENIED" || "UNKNOWN_ERROR", // required
//       Details: "STRING_VALUE", // required
//     },
//     DeliveryStreamEncryptionConfiguration: { // DeliveryStreamEncryptionConfiguration
//       KeyARN: "STRING_VALUE",
//       KeyType: "AWS_OWNED_CMK" || "CUSTOMER_MANAGED_CMK",
//       Status: "ENABLED" || "ENABLING" || "ENABLING_FAILED" || "DISABLED" || "DISABLING" || "DISABLING_FAILED",
//       FailureDescription: {
//         Type: "VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND" || "VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED" || "RETIRE_KMS_GRANT_FAILED" || "CREATE_KMS_GRANT_FAILED" || "KMS_ACCESS_DENIED" || "DISABLED_KMS_KEY" || "INVALID_KMS_KEY" || "KMS_KEY_NOT_FOUND" || "KMS_OPT_IN_REQUIRED" || "CREATE_ENI_FAILED" || "DELETE_ENI_FAILED" || "SUBNET_NOT_FOUND" || "SECURITY_GROUP_NOT_FOUND" || "ENI_ACCESS_DENIED" || "SUBNET_ACCESS_DENIED" || "SECURITY_GROUP_ACCESS_DENIED" || "UNKNOWN_ERROR", // required
//         Details: "STRING_VALUE", // required
//       },
//     },
//     DeliveryStreamType: "DirectPut" || "KinesisStreamAsSource" || "MSKAsSource" || "DatabaseAsSource", // required
//     VersionId: "STRING_VALUE", // required
//     CreateTimestamp: new Date("TIMESTAMP"),
//     LastUpdateTimestamp: new Date("TIMESTAMP"),
//     Source: { // SourceDescription
//       DirectPutSourceDescription: { // DirectPutSourceDescription
//         ThroughputHintInMBs: Number("int"),
//       },
//       KinesisStreamSourceDescription: { // KinesisStreamSourceDescription
//         KinesisStreamARN: "STRING_VALUE",
//         RoleARN: "STRING_VALUE",
//         DeliveryStartTimestamp: new Date("TIMESTAMP"),
//       },
//       MSKSourceDescription: { // MSKSourceDescription
//         MSKClusterARN: "STRING_VALUE",
//         TopicName: "STRING_VALUE",
//         AuthenticationConfiguration: { // AuthenticationConfiguration
//           RoleARN: "STRING_VALUE", // required
//           Connectivity: "PUBLIC" || "PRIVATE", // required
//         },
//         DeliveryStartTimestamp: new Date("TIMESTAMP"),
//         ReadFromTimestamp: new Date("TIMESTAMP"),
//       },
//       DatabaseSourceDescription: { // DatabaseSourceDescription
//         Type: "MySQL" || "PostgreSQL",
//         Endpoint: "STRING_VALUE",
//         Port: Number("int"),
//         SSLMode: "Disabled" || "Enabled",
//         Databases: { // DatabaseList
//           Include: [ // DatabaseIncludeOrExcludeList
//             "STRING_VALUE",
//           ],
//           Exclude: [
//             "STRING_VALUE",
//           ],
//         },
//         Tables: { // DatabaseTableList
//           Include: [ // DatabaseTableIncludeOrExcludeList
//             "STRING_VALUE",
//           ],
//           Exclude: [
//             "STRING_VALUE",
//           ],
//         },
//         Columns: { // DatabaseColumnList
//           Include: [ // DatabaseColumnIncludeOrExcludeList
//             "STRING_VALUE",
//           ],
//           Exclude: [
//             "STRING_VALUE",
//           ],
//         },
//         SurrogateKeys: [
//           "STRING_VALUE",
//         ],
//         SnapshotWatermarkTable: "STRING_VALUE",
//         SnapshotInfo: [ // DatabaseSnapshotInfoList
//           { // DatabaseSnapshotInfo
//             Id: "STRING_VALUE", // required
//             Table: "STRING_VALUE", // required
//             RequestTimestamp: new Date("TIMESTAMP"), // required
//             RequestedBy: "USER" || "FIREHOSE", // required
//             Status: "IN_PROGRESS" || "COMPLETE" || "SUSPENDED", // required
//             FailureDescription: "<FailureDescription>",
//           },
//         ],
//         DatabaseSourceAuthenticationConfiguration: { // DatabaseSourceAuthenticationConfiguration
//           SecretsManagerConfiguration: { // SecretsManagerConfiguration
//             SecretARN: "STRING_VALUE",
//             RoleARN: "STRING_VALUE",
//             Enabled: true || false, // required
//           },
//         },
//         DatabaseSourceVPCConfiguration: { // DatabaseSourceVPCConfiguration
//           VpcEndpointServiceName: "STRING_VALUE", // required
//         },
//       },
//     },
//     Destinations: [ // DestinationDescriptionList // required
//       { // DestinationDescription
//         DestinationId: "STRING_VALUE", // required
//         S3DestinationDescription: { // S3DestinationDescription
//           RoleARN: "STRING_VALUE", // required
//           BucketARN: "STRING_VALUE", // required
//           Prefix: "STRING_VALUE",
//           ErrorOutputPrefix: "STRING_VALUE",
//           BufferingHints: { // BufferingHints
//             SizeInMBs: Number("int"),
//             IntervalInSeconds: Number("int"),
//           },
//           CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
//           EncryptionConfiguration: { // EncryptionConfiguration
//             NoEncryptionConfig: "NoEncryption",
//             KMSEncryptionConfig: { // KMSEncryptionConfig
//               AWSKMSKeyARN: "STRING_VALUE", // required
//             },
//           },
//           CloudWatchLoggingOptions: { // CloudWatchLoggingOptions
//             Enabled: true || false,
//             LogGroupName: "STRING_VALUE",
//             LogStreamName: "STRING_VALUE",
//           },
//         },
//         ExtendedS3DestinationDescription: { // ExtendedS3DestinationDescription
//           RoleARN: "STRING_VALUE", // required
//           BucketARN: "STRING_VALUE", // required
//           Prefix: "STRING_VALUE",
//           ErrorOutputPrefix: "STRING_VALUE",
//           BufferingHints: {
//             SizeInMBs: Number("int"),
//             IntervalInSeconds: Number("int"),
//           },
//           CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
//           EncryptionConfiguration: {
//             NoEncryptionConfig: "NoEncryption",
//             KMSEncryptionConfig: {
//               AWSKMSKeyARN: "STRING_VALUE", // required
//             },
//           },
//           CloudWatchLoggingOptions: {
//             Enabled: true || false,
//             LogGroupName: "STRING_VALUE",
//             LogStreamName: "STRING_VALUE",
//           },
//           ProcessingConfiguration: { // ProcessingConfiguration
//             Enabled: true || false,
//             Processors: [ // ProcessorList
//               { // Processor
//                 Type: "RecordDeAggregation" || "Decompression" || "CloudWatchLogProcessing" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
//                 Parameters: [ // ProcessorParameterList
//                   { // ProcessorParameter
//                     ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter" || "CompressionFormat" || "DataMessageExtraction", // required
//                     ParameterValue: "STRING_VALUE", // required
//                   },
//                 ],
//               },
//             ],
//           },
//           S3BackupMode: "Disabled" || "Enabled",
//           S3BackupDescription: {
//             RoleARN: "STRING_VALUE", // required
//             BucketARN: "STRING_VALUE", // required
//             Prefix: "STRING_VALUE",
//             ErrorOutputPrefix: "STRING_VALUE",
//             BufferingHints: {
//               SizeInMBs: Number("int"),
//               IntervalInSeconds: Number("int"),
//             },
//             CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
//             EncryptionConfiguration: {
//               NoEncryptionConfig: "NoEncryption",
//               KMSEncryptionConfig: {
//                 AWSKMSKeyARN: "STRING_VALUE", // required
//               },
//             },
//             CloudWatchLoggingOptions: {
//               Enabled: true || false,
//               LogGroupName: "STRING_VALUE",
//               LogStreamName: "STRING_VALUE",
//             },
//           },
//           DataFormatConversionConfiguration: { // DataFormatConversionConfiguration
//             SchemaConfiguration: { // SchemaConfiguration
//               RoleARN: "STRING_VALUE",
//               CatalogId: "STRING_VALUE",
//               DatabaseName: "STRING_VALUE",
//               TableName: "STRING_VALUE",
//               Region: "STRING_VALUE",
//               VersionId: "STRING_VALUE",
//             },
//             InputFormatConfiguration: { // InputFormatConfiguration
//               Deserializer: { // Deserializer
//                 OpenXJsonSerDe: { // OpenXJsonSerDe
//                   ConvertDotsInJsonKeysToUnderscores: true || false,
//                   CaseInsensitive: true || false,
//                   ColumnToJsonKeyMappings: { // ColumnToJsonKeyMappings
//                     "<keys>": "STRING_VALUE",
//                   },
//                 },
//                 HiveJsonSerDe: { // HiveJsonSerDe
//                   TimestampFormats: [ // ListOfNonEmptyStrings
//                     "STRING_VALUE",
//                   ],
//                 },
//               },
//             },
//             OutputFormatConfiguration: { // OutputFormatConfiguration
//               Serializer: { // Serializer
//                 ParquetSerDe: { // ParquetSerDe
//                   BlockSizeBytes: Number("int"),
//                   PageSizeBytes: Number("int"),
//                   Compression: "UNCOMPRESSED" || "GZIP" || "SNAPPY",
//                   EnableDictionaryCompression: true || false,
//                   MaxPaddingBytes: Number("int"),
//                   WriterVersion: "V1" || "V2",
//                 },
//                 OrcSerDe: { // OrcSerDe
//                   StripeSizeBytes: Number("int"),
//                   BlockSizeBytes: Number("int"),
//                   RowIndexStride: Number("int"),
//                   EnablePadding: true || false,
//                   PaddingTolerance: Number("double"),
//                   Compression: "NONE" || "ZLIB" || "SNAPPY",
//                   BloomFilterColumns: [ // ListOfNonEmptyStringsWithoutWhitespace
//                     "STRING_VALUE",
//                   ],
//                   BloomFilterFalsePositiveProbability: Number("double"),
//                   DictionaryKeyThreshold: Number("double"),
//                   FormatVersion: "V0_11" || "V0_12",
//                 },
//               },
//             },
//             Enabled: true || false,
//           },
//           DynamicPartitioningConfiguration: { // DynamicPartitioningConfiguration
//             RetryOptions: { // RetryOptions
//               DurationInSeconds: Number("int"),
//             },
//             Enabled: true || false,
//           },
//           FileExtension: "STRING_VALUE",
//           CustomTimeZone: "STRING_VALUE",
//         },
//         RedshiftDestinationDescription: { // RedshiftDestinationDescription
//           RoleARN: "STRING_VALUE", // required
//           ClusterJDBCURL: "STRING_VALUE", // required
//           CopyCommand: { // CopyCommand
//             DataTableName: "STRING_VALUE", // required
//             DataTableColumns: "STRING_VALUE",
//             CopyOptions: "STRING_VALUE",
//           },
//           Username: "STRING_VALUE",
//           RetryOptions: { // RedshiftRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3DestinationDescription: {
//             RoleARN: "STRING_VALUE", // required
//             BucketARN: "STRING_VALUE", // required
//             Prefix: "STRING_VALUE",
//             ErrorOutputPrefix: "STRING_VALUE",
//             BufferingHints: {
//               SizeInMBs: Number("int"),
//               IntervalInSeconds: Number("int"),
//             },
//             CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
//             EncryptionConfiguration: {
//               NoEncryptionConfig: "NoEncryption",
//               KMSEncryptionConfig: {
//                 AWSKMSKeyARN: "STRING_VALUE", // required
//               },
//             },
//             CloudWatchLoggingOptions: {
//               Enabled: true || false,
//               LogGroupName: "STRING_VALUE",
//               LogStreamName: "STRING_VALUE",
//             },
//           },
//           ProcessingConfiguration: {
//             Enabled: true || false,
//             Processors: [
//               {
//                 Type: "RecordDeAggregation" || "Decompression" || "CloudWatchLogProcessing" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
//                 Parameters: [
//                   {
//                     ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter" || "CompressionFormat" || "DataMessageExtraction", // required
//                     ParameterValue: "STRING_VALUE", // required
//                   },
//                 ],
//               },
//             ],
//           },
//           S3BackupMode: "Disabled" || "Enabled",
//           S3BackupDescription: {
//             RoleARN: "STRING_VALUE", // required
//             BucketARN: "STRING_VALUE", // required
//             Prefix: "STRING_VALUE",
//             ErrorOutputPrefix: "STRING_VALUE",
//             BufferingHints: {
//               SizeInMBs: Number("int"),
//               IntervalInSeconds: Number("int"),
//             },
//             CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
//             EncryptionConfiguration: {
//               NoEncryptionConfig: "NoEncryption",
//               KMSEncryptionConfig: {
//                 AWSKMSKeyARN: "STRING_VALUE", // required
//               },
//             },
//             CloudWatchLoggingOptions: {
//               Enabled: true || false,
//               LogGroupName: "STRING_VALUE",
//               LogStreamName: "STRING_VALUE",
//             },
//           },
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           SecretsManagerConfiguration: {
//             SecretARN: "STRING_VALUE",
//             RoleARN: "STRING_VALUE",
//             Enabled: true || false, // required
//           },
//         },
//         ElasticsearchDestinationDescription: { // ElasticsearchDestinationDescription
//           RoleARN: "STRING_VALUE",
//           DomainARN: "STRING_VALUE",
//           ClusterEndpoint: "STRING_VALUE",
//           IndexName: "STRING_VALUE",
//           TypeName: "STRING_VALUE",
//           IndexRotationPeriod: "NoRotation" || "OneHour" || "OneDay" || "OneWeek" || "OneMonth",
//           BufferingHints: { // ElasticsearchBufferingHints
//             IntervalInSeconds: Number("int"),
//             SizeInMBs: Number("int"),
//           },
//           RetryOptions: { // ElasticsearchRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3BackupMode: "FailedDocumentsOnly" || "AllDocuments",
//           S3DestinationDescription: {
//             RoleARN: "STRING_VALUE", // required
//             BucketARN: "STRING_VALUE", // required
//             Prefix: "STRING_VALUE",
//             ErrorOutputPrefix: "STRING_VALUE",
//             BufferingHints: "<BufferingHints>", // required
//             CompressionFormat: "UNCOMPRESSED" || "GZIP" || "ZIP" || "Snappy" || "HADOOP_SNAPPY", // required
//             EncryptionConfiguration: "<EncryptionConfiguration>", // required
//             CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           },
//           ProcessingConfiguration: {
//             Enabled: true || false,
//             Processors: [
//               {
//                 Type: "RecordDeAggregation" || "Decompression" || "CloudWatchLogProcessing" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
//                 Parameters: [
//                   {
//                     ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter" || "CompressionFormat" || "DataMessageExtraction", // required
//                     ParameterValue: "STRING_VALUE", // required
//                   },
//                 ],
//               },
//             ],
//           },
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           VpcConfigurationDescription: { // VpcConfigurationDescription
//             SubnetIds: [ // SubnetIdList // required
//               "STRING_VALUE",
//             ],
//             RoleARN: "STRING_VALUE", // required
//             SecurityGroupIds: [ // SecurityGroupIdList // required
//               "STRING_VALUE",
//             ],
//             VpcId: "STRING_VALUE", // required
//           },
//           DocumentIdOptions: { // DocumentIdOptions
//             DefaultDocumentIdFormat: "FIREHOSE_DEFAULT" || "NO_DOCUMENT_ID", // required
//           },
//         },
//         AmazonopensearchserviceDestinationDescription: { // AmazonopensearchserviceDestinationDescription
//           RoleARN: "STRING_VALUE",
//           DomainARN: "STRING_VALUE",
//           ClusterEndpoint: "STRING_VALUE",
//           IndexName: "STRING_VALUE",
//           TypeName: "STRING_VALUE",
//           IndexRotationPeriod: "NoRotation" || "OneHour" || "OneDay" || "OneWeek" || "OneMonth",
//           BufferingHints: { // AmazonopensearchserviceBufferingHints
//             IntervalInSeconds: Number("int"),
//             SizeInMBs: Number("int"),
//           },
//           RetryOptions: { // AmazonopensearchserviceRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3BackupMode: "FailedDocumentsOnly" || "AllDocuments",
//           S3DestinationDescription: "<S3DestinationDescription>",
//           ProcessingConfiguration: {
//             Enabled: true || false,
//             Processors: [
//               {
//                 Type: "RecordDeAggregation" || "Decompression" || "CloudWatchLogProcessing" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
//                 Parameters: [
//                   {
//                     ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter" || "CompressionFormat" || "DataMessageExtraction", // required
//                     ParameterValue: "STRING_VALUE", // required
//                   },
//                 ],
//               },
//             ],
//           },
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           VpcConfigurationDescription: {
//             SubnetIds: [ // required
//               "STRING_VALUE",
//             ],
//             RoleARN: "STRING_VALUE", // required
//             SecurityGroupIds: [ // required
//               "STRING_VALUE",
//             ],
//             VpcId: "STRING_VALUE", // required
//           },
//           DocumentIdOptions: {
//             DefaultDocumentIdFormat: "FIREHOSE_DEFAULT" || "NO_DOCUMENT_ID", // required
//           },
//         },
//         SplunkDestinationDescription: { // SplunkDestinationDescription
//           HECEndpoint: "STRING_VALUE",
//           HECEndpointType: "Raw" || "Event",
//           HECToken: "STRING_VALUE",
//           HECAcknowledgmentTimeoutInSeconds: Number("int"),
//           RetryOptions: { // SplunkRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3BackupMode: "FailedEventsOnly" || "AllEvents",
//           S3DestinationDescription: "<S3DestinationDescription>",
//           ProcessingConfiguration: {
//             Enabled: true || false,
//             Processors: [
//               {
//                 Type: "RecordDeAggregation" || "Decompression" || "CloudWatchLogProcessing" || "Lambda" || "MetadataExtraction" || "AppendDelimiterToRecord", // required
//                 Parameters: [
//                   {
//                     ParameterName: "LambdaArn" || "NumberOfRetries" || "MetadataExtractionQuery" || "JsonParsingEngine" || "RoleArn" || "BufferSizeInMBs" || "BufferIntervalInSeconds" || "SubRecordType" || "Delimiter" || "CompressionFormat" || "DataMessageExtraction", // required
//                     ParameterValue: "STRING_VALUE", // required
//                   },
//                 ],
//               },
//             ],
//           },
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           BufferingHints: { // SplunkBufferingHints
//             IntervalInSeconds: Number("int"),
//             SizeInMBs: Number("int"),
//           },
//           SecretsManagerConfiguration: {
//             SecretARN: "STRING_VALUE",
//             RoleARN: "STRING_VALUE",
//             Enabled: true || false, // required
//           },
//         },
//         HttpEndpointDestinationDescription: { // HttpEndpointDestinationDescription
//           EndpointConfiguration: { // HttpEndpointDescription
//             Url: "STRING_VALUE",
//             Name: "STRING_VALUE",
//           },
//           BufferingHints: { // HttpEndpointBufferingHints
//             SizeInMBs: Number("int"),
//             IntervalInSeconds: Number("int"),
//           },
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           RequestConfiguration: { // HttpEndpointRequestConfiguration
//             ContentEncoding: "NONE" || "GZIP",
//             CommonAttributes: [ // HttpEndpointCommonAttributesList
//               { // HttpEndpointCommonAttribute
//                 AttributeName: "STRING_VALUE", // required
//                 AttributeValue: "STRING_VALUE", // required
//               },
//             ],
//           },
//           ProcessingConfiguration: "<ProcessingConfiguration>",
//           RoleARN: "STRING_VALUE",
//           RetryOptions: { // HttpEndpointRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3BackupMode: "FailedDataOnly" || "AllData",
//           S3DestinationDescription: "<S3DestinationDescription>",
//           SecretsManagerConfiguration: {
//             SecretARN: "STRING_VALUE",
//             RoleARN: "STRING_VALUE",
//             Enabled: true || false, // required
//           },
//         },
//         SnowflakeDestinationDescription: { // SnowflakeDestinationDescription
//           AccountUrl: "STRING_VALUE",
//           User: "STRING_VALUE",
//           Database: "STRING_VALUE",
//           Schema: "STRING_VALUE",
//           Table: "STRING_VALUE",
//           SnowflakeRoleConfiguration: { // SnowflakeRoleConfiguration
//             Enabled: true || false,
//             SnowflakeRole: "STRING_VALUE",
//           },
//           DataLoadingOption: "JSON_MAPPING" || "VARIANT_CONTENT_MAPPING" || "VARIANT_CONTENT_AND_METADATA_MAPPING",
//           MetaDataColumnName: "STRING_VALUE",
//           ContentColumnName: "STRING_VALUE",
//           SnowflakeVpcConfiguration: { // SnowflakeVpcConfiguration
//             PrivateLinkVpceId: "STRING_VALUE", // required
//           },
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           ProcessingConfiguration: "<ProcessingConfiguration>",
//           RoleARN: "STRING_VALUE",
//           RetryOptions: { // SnowflakeRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3BackupMode: "FailedDataOnly" || "AllData",
//           S3DestinationDescription: "<S3DestinationDescription>",
//           SecretsManagerConfiguration: {
//             SecretARN: "STRING_VALUE",
//             RoleARN: "STRING_VALUE",
//             Enabled: true || false, // required
//           },
//           BufferingHints: { // SnowflakeBufferingHints
//             SizeInMBs: Number("int"),
//             IntervalInSeconds: Number("int"),
//           },
//         },
//         AmazonOpenSearchServerlessDestinationDescription: { // AmazonOpenSearchServerlessDestinationDescription
//           RoleARN: "STRING_VALUE",
//           CollectionEndpoint: "STRING_VALUE",
//           IndexName: "STRING_VALUE",
//           BufferingHints: { // AmazonOpenSearchServerlessBufferingHints
//             IntervalInSeconds: Number("int"),
//             SizeInMBs: Number("int"),
//           },
//           RetryOptions: { // AmazonOpenSearchServerlessRetryOptions
//             DurationInSeconds: Number("int"),
//           },
//           S3BackupMode: "FailedDocumentsOnly" || "AllDocuments",
//           S3DestinationDescription: "<S3DestinationDescription>",
//           ProcessingConfiguration: "<ProcessingConfiguration>",
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           VpcConfigurationDescription: {
//             SubnetIds: [ // required
//               "STRING_VALUE",
//             ],
//             RoleARN: "STRING_VALUE", // required
//             SecurityGroupIds: [ // required
//               "STRING_VALUE",
//             ],
//             VpcId: "STRING_VALUE", // required
//           },
//         },
//         IcebergDestinationDescription: { // IcebergDestinationDescription
//           DestinationTableConfigurationList: [ // DestinationTableConfigurationList
//             { // DestinationTableConfiguration
//               DestinationTableName: "STRING_VALUE", // required
//               DestinationDatabaseName: "STRING_VALUE", // required
//               UniqueKeys: [
//                 "STRING_VALUE",
//               ],
//               PartitionSpec: { // PartitionSpec
//                 Identity: [ // PartitionFields
//                   { // PartitionField
//                     SourceName: "STRING_VALUE", // required
//                   },
//                 ],
//               },
//               S3ErrorOutputPrefix: "STRING_VALUE",
//             },
//           ],
//           SchemaEvolutionConfiguration: { // SchemaEvolutionConfiguration
//             Enabled: true || false, // required
//           },
//           TableCreationConfiguration: { // TableCreationConfiguration
//             Enabled: true || false, // required
//           },
//           BufferingHints: "<BufferingHints>",
//           CloudWatchLoggingOptions: "<CloudWatchLoggingOptions>",
//           ProcessingConfiguration: "<ProcessingConfiguration>",
//           S3BackupMode: "FailedDataOnly" || "AllData",
//           RetryOptions: {
//             DurationInSeconds: Number("int"),
//           },
//           RoleARN: "STRING_VALUE",
//           AppendOnly: true || false,
//           CatalogConfiguration: { // CatalogConfiguration
//             CatalogARN: "STRING_VALUE",
//             WarehouseLocation: "STRING_VALUE",
//           },
//           S3DestinationDescription: "<S3DestinationDescription>",
//         },
//       },
//     ],
//     HasMoreDestinations: true || false, // required
//   },
// };
DescribeDeliveryStreamCommand Input

See DescribeDeliveryStreamCommandInput for more details
Parameter	Type	Description
`DeliveryStreamName` Required	`string \| undefined`	The name of the Firehose stream.
`ExclusiveStartDestinationId`	`string \| undefined`	The ID of the destination to start returning the destination information. Firehose supports one destination per Firehose stream.
`Limit`	`number \| undefined`	The limit on the number of destinations to return. You can have one destination per Firehose stream.
DescribeDeliveryStreamCommand Output

See DescribeDeliveryStreamCommandOutput for details
Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`DeliveryStreamDescription` Required	`DeliveryStreamDescription \| undefined`	Information about the Firehose stream.
Throws

Name	Fault	Details
ResourceNotFoundException	client	The specified resource could not be found.
FirehoseServiceException		Base exception class for all service exceptions from Firehose service.
Getting Started

References

DescribeDeliveryStreamCommand

Example Syntax

DescribeDeliveryStreamCommand Input

DescribeDeliveryStreamCommand Output

Throws

Table of Contents

Search
