ebook img

Amazon Kinesis Firehose API Reference PDF

201 Pages·2017·1.06 MB·English
by  
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Amazon Kinesis Firehose API Reference

Amazon Kinesis Data Firehose API Reference API Version 2015-08-04 Amazon Kinesis Data Firehose API Reference Amazon Kinesis Data Firehose: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Kinesis Data Firehose API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 2 CreateDeliveryStream................................................................................................................. 3 Request Syntax.................................................................................................................. 4 Request Parameters.......................................................................................................... 12 Response Syntax.............................................................................................................. 14 Response Elements........................................................................................................... 14 Errors.............................................................................................................................. 14 Examples......................................................................................................................... 15 See Also.......................................................................................................................... 15 DeleteDeliveryStream................................................................................................................ 17 Request Syntax................................................................................................................ 17 Request Parameters.......................................................................................................... 17 Response Elements........................................................................................................... 17 Errors.............................................................................................................................. 18 Examples......................................................................................................................... 18 See Also.......................................................................................................................... 18 DescribeDeliveryStream............................................................................................................. 20 Request Syntax................................................................................................................ 20 Request Parameters.......................................................................................................... 20 Response Syntax.............................................................................................................. 21 Response Elements........................................................................................................... 29 Errors.............................................................................................................................. 29 Examples......................................................................................................................... 29 See Also.......................................................................................................................... 31 ListDeliveryStreams.................................................................................................................. 32 Request Syntax................................................................................................................ 32 Request Parameters.......................................................................................................... 32 Response Syntax.............................................................................................................. 33 Response Elements........................................................................................................... 33 Errors.............................................................................................................................. 33 Examples......................................................................................................................... 33 See Also.......................................................................................................................... 34 ListTagsForDeliveryStream......................................................................................................... 35 Request Syntax................................................................................................................ 35 Request Parameters.......................................................................................................... 35 Response Syntax.............................................................................................................. 35 Response Elements........................................................................................................... 36 Errors.............................................................................................................................. 36 Examples......................................................................................................................... 36 See Also.......................................................................................................................... 37 PutRecord ................................................................................................................................ 38 Request Syntax................................................................................................................ 38 Request Parameters.......................................................................................................... 38 Response Syntax.............................................................................................................. 39 Response Elements........................................................................................................... 39 Errors.............................................................................................................................. 39 Examples......................................................................................................................... 40 See Also.......................................................................................................................... 40 PutRecordBatch........................................................................................................................ 42 Request Syntax................................................................................................................ 42 Request Parameters.......................................................................................................... 43 Response Syntax.............................................................................................................. 43 Response Elements........................................................................................................... 43 API Version 2015-08-04 iii Amazon Kinesis Data Firehose API Reference Errors.............................................................................................................................. 44 Examples......................................................................................................................... 44 See Also.......................................................................................................................... 45 StartDeliveryStreamEncryption.................................................................................................. 47 Request Syntax................................................................................................................ 47 Request Parameters.......................................................................................................... 47 Response Elements........................................................................................................... 48 Errors.............................................................................................................................. 48 Examples......................................................................................................................... 48 See Also.......................................................................................................................... 49 StopDeliveryStreamEncryption................................................................................................... 50 Request Syntax................................................................................................................ 50 Request Parameters.......................................................................................................... 50 Response Elements........................................................................................................... 50 Errors.............................................................................................................................. 50 Examples......................................................................................................................... 51 See Also.......................................................................................................................... 51 TagDeliveryStream.................................................................................................................... 53 Request Syntax................................................................................................................ 53 Request Parameters.......................................................................................................... 53 Response Elements........................................................................................................... 53 Errors.............................................................................................................................. 53 Examples......................................................................................................................... 54 See Also.......................................................................................................................... 55 UntagDeliveryStream................................................................................................................ 56 Request Syntax................................................................................................................ 56 Request Parameters.......................................................................................................... 56 Response Elements........................................................................................................... 56 Errors.............................................................................................................................. 56 Examples......................................................................................................................... 57 See Also.......................................................................................................................... 57 UpdateDestination.................................................................................................................... 59 Request Syntax................................................................................................................ 59 Request Parameters.......................................................................................................... 67 Response Elements........................................................................................................... 68 Errors.............................................................................................................................. 68 Examples......................................................................................................................... 69 See Also.......................................................................................................................... 70 Data Types...................................................................................................................................... 71 AmazonOpenSearchServerlessBufferingHints............................................................................... 73 Contents......................................................................................................................... 73 See Also.......................................................................................................................... 73 AmazonOpenSearchServerlessDestinationConfiguration................................................................ 74 Contents......................................................................................................................... 74 See Also.......................................................................................................................... 75 AmazonOpenSearchServerlessDestinationDescription.................................................................... 76 Contents......................................................................................................................... 76 See Also.......................................................................................................................... 77 AmazonOpenSearchServerlessDestinationUpdate......................................................................... 78 Contents......................................................................................................................... 78 See Also.......................................................................................................................... 79 AmazonOpenSearchServerlessRetryOptions................................................................................. 80 Contents......................................................................................................................... 80 See Also.......................................................................................................................... 80 AmazonopensearchserviceBufferingHints..................................................................................... 81 Contents......................................................................................................................... 81 See Also.......................................................................................................................... 81 API Version 2015-08-04 iv Amazon Kinesis Data Firehose API Reference AmazonopensearchserviceDestinationConfiguration...................................................................... 82 Contents......................................................................................................................... 82 See Also.......................................................................................................................... 84 AmazonopensearchserviceDestinationDescription......................................................................... 85 Contents......................................................................................................................... 85 See Also.......................................................................................................................... 87 AmazonopensearchserviceDestinationUpdate............................................................................... 88 Contents......................................................................................................................... 88 See Also.......................................................................................................................... 90 AmazonopensearchserviceRetryOptions....................................................................................... 91 Contents......................................................................................................................... 91 See Also.......................................................................................................................... 91 BufferingHints.......................................................................................................................... 92 Contents......................................................................................................................... 92 See Also.......................................................................................................................... 92 CloudWatchLoggingOptions....................................................................................................... 93 Contents......................................................................................................................... 93 See Also.......................................................................................................................... 93 CopyCommand......................................................................................................................... 94 Contents......................................................................................................................... 94 See Also.......................................................................................................................... 95 DataFormatConversionConfiguration........................................................................................... 96 Contents......................................................................................................................... 96 See Also.......................................................................................................................... 96 DeliveryStreamDescription......................................................................................................... 97 Contents......................................................................................................................... 97 See Also.......................................................................................................................... 99 DeliveryStreamEncryptionConfiguration.................................................................................... 100 Contents........................................................................................................................ 100 See Also........................................................................................................................ 100 DeliveryStreamEncryptionConfigurationInput............................................................................. 102 Contents........................................................................................................................ 102 See Also........................................................................................................................ 102 Deserializer............................................................................................................................ 104 Contents........................................................................................................................ 104 See Also........................................................................................................................ 104 DestinationDescription............................................................................................................ 105 Contents........................................................................................................................ 105 See Also........................................................................................................................ 106 DynamicPartitioningConfiguration............................................................................................ 107 Contents........................................................................................................................ 107 See Also........................................................................................................................ 107 ElasticsearchBufferingHints...................................................................................................... 108 Contents........................................................................................................................ 108 See Also........................................................................................................................ 108 ElasticsearchDestinationConfiguration....................................................................................... 109 Contents........................................................................................................................ 109 See Also........................................................................................................................ 111 ElasticsearchDestinationDescription........................................................................................... 112 Contents........................................................................................................................ 112 See Also........................................................................................................................ 114 ElasticsearchDestinationUpdate................................................................................................ 115 Contents........................................................................................................................ 115 See Also........................................................................................................................ 117 ElasticsearchRetryOptions........................................................................................................ 118 Contents........................................................................................................................ 118 See Also........................................................................................................................ 118 API Version 2015-08-04 v Amazon Kinesis Data Firehose API Reference EncryptionConfiguration.......................................................................................................... 119 Contents........................................................................................................................ 119 See Also........................................................................................................................ 119 ExtendedS3DestinationConfiguration........................................................................................ 120 Contents........................................................................................................................ 120 See Also........................................................................................................................ 122 ExtendedS3DestinationDescription............................................................................................ 123 Contents........................................................................................................................ 123 See Also........................................................................................................................ 125 ExtendedS3DestinationUpdate................................................................................................. 126 Contents........................................................................................................................ 126 See Also........................................................................................................................ 128 FailureDescription................................................................................................................... 129 Contents........................................................................................................................ 129 See Also........................................................................................................................ 129 HiveJsonSerDe....................................................................................................................... 130 Contents........................................................................................................................ 130 See Also........................................................................................................................ 130 HttpEndpointBufferingHints..................................................................................................... 131 Contents........................................................................................................................ 131 See Also........................................................................................................................ 131 HttpEndpointCommonAttribute................................................................................................ 132 Contents........................................................................................................................ 132 See Also........................................................................................................................ 132 HttpEndpointConfiguration...................................................................................................... 133 Contents........................................................................................................................ 133 See Also........................................................................................................................ 133 HttpEndpointDescription......................................................................................................... 134 Contents........................................................................................................................ 134 See Also........................................................................................................................ 134 HttpEndpointDestinationConfiguration...................................................................................... 135 Contents........................................................................................................................ 135 See Also........................................................................................................................ 136 HttpEndpointDestinationDescription......................................................................................... 137 Contents........................................................................................................................ 137 See Also........................................................................................................................ 138 HttpEndpointDestinationUpdate............................................................................................... 139 Contents........................................................................................................................ 139 See Also........................................................................................................................ 140 HttpEndpointRequestConfiguration........................................................................................... 141 Contents........................................................................................................................ 141 See Also........................................................................................................................ 141 HttpEndpointRetryOptions....................................................................................................... 142 Contents........................................................................................................................ 142 See Also........................................................................................................................ 142 InputFormatConfiguration....................................................................................................... 143 Contents........................................................................................................................ 143 See Also........................................................................................................................ 143 KinesisStreamSourceConfiguration............................................................................................ 144 Contents........................................................................................................................ 144 See Also........................................................................................................................ 144 KinesisStreamSourceDescription............................................................................................... 145 Contents........................................................................................................................ 145 See Also........................................................................................................................ 145 KMSEncryptionConfig .............................................................................................................. 146 Contents........................................................................................................................ 146 See Also........................................................................................................................ 146 API Version 2015-08-04 vi Amazon Kinesis Data Firehose API Reference OpenXJsonSerDe.................................................................................................................... 147 Contents........................................................................................................................ 147 See Also........................................................................................................................ 147 OrcSerDe............................................................................................................................... 149 Contents........................................................................................................................ 149 See Also........................................................................................................................ 150 OutputFormatConfiguration..................................................................................................... 152 Contents........................................................................................................................ 152 See Also........................................................................................................................ 152 ParquetSerDe......................................................................................................................... 153 Contents........................................................................................................................ 153 See Also........................................................................................................................ 154 ProcessingConfiguration.......................................................................................................... 155 Contents........................................................................................................................ 155 See Also........................................................................................................................ 155 Processor............................................................................................................................... 156 Contents........................................................................................................................ 156 See Also........................................................................................................................ 156 ProcessorParameter................................................................................................................ 157 Contents........................................................................................................................ 157 See Also........................................................................................................................ 157 PutRecordBatchResponseEntry................................................................................................. 158 Contents........................................................................................................................ 158 See Also........................................................................................................................ 158 Record ................................................................................................................................... 159 Contents........................................................................................................................ 159 See Also........................................................................................................................ 159 RedshiftDestinationConfiguration............................................................................................. 160 Contents........................................................................................................................ 160 See Also........................................................................................................................ 161 RedshiftDestinationDescription................................................................................................. 163 Contents........................................................................................................................ 163 See Also........................................................................................................................ 164 RedshiftDestinationUpdate...................................................................................................... 165 Contents........................................................................................................................ 165 See Also........................................................................................................................ 166 RedshiftRetryOptions.............................................................................................................. 168 Contents........................................................................................................................ 168 See Also........................................................................................................................ 168 RetryOptions.......................................................................................................................... 169 Contents........................................................................................................................ 169 See Also........................................................................................................................ 169 S3DestinationConfiguration..................................................................................................... 170 Contents........................................................................................................................ 170 See Also........................................................................................................................ 171 S3DestinationDescription......................................................................................................... 172 Contents........................................................................................................................ 172 See Also........................................................................................................................ 173 S3DestinationUpdate.............................................................................................................. 174 Contents........................................................................................................................ 174 See Also........................................................................................................................ 175 SchemaConfiguration.............................................................................................................. 176 Contents........................................................................................................................ 176 See Also........................................................................................................................ 177 Serializer............................................................................................................................... 178 Contents........................................................................................................................ 178 See Also........................................................................................................................ 178 API Version 2015-08-04 vii Amazon Kinesis Data Firehose API Reference SourceDescription................................................................................................................... 179 Contents........................................................................................................................ 179 See Also........................................................................................................................ 179 SplunkDestinationConfiguration............................................................................................... 180 Contents........................................................................................................................ 180 See Also........................................................................................................................ 181 SplunkDestinationDescription................................................................................................... 182 Contents........................................................................................................................ 182 See Also........................................................................................................................ 183 SplunkDestinationUpdate........................................................................................................ 184 Contents........................................................................................................................ 184 See Also........................................................................................................................ 185 SplunkRetryOptions................................................................................................................ 186 Contents........................................................................................................................ 186 See Also........................................................................................................................ 186 Tag ....................................................................................................................................... 187 Contents........................................................................................................................ 187 See Also........................................................................................................................ 187 VpcConfiguration.................................................................................................................... 188 Contents........................................................................................................................ 188 See Also........................................................................................................................ 189 VpcConfigurationDescription.................................................................................................... 190 Contents........................................................................................................................ 190 See Also........................................................................................................................ 191 Common Errors.............................................................................................................................. 192 API Version 2015-08-04 viii Amazon Kinesis Data Firehose API Reference Welcome Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations. This document was last published on January 2, 2023. API Version 2015-08-04 1 Amazon Kinesis Data Firehose API Reference Actions The following actions are supported: • CreateDeliveryStream (p. 3) • DeleteDeliveryStream (p. 17) • DescribeDeliveryStream (p. 20) • ListDeliveryStreams (p. 32) • ListTagsForDeliveryStream (p. 35) • PutRecord (p. 38) • PutRecordBatch (p. 42) • StartDeliveryStreamEncryption (p. 47) • StopDeliveryStreamEncryption (p. 50) • TagDeliveryStream (p. 53) • UntagDeliveryStream (p. 56) • UpdateDestination (p. 59) API Version 2015-08-04 2

Description:
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.