firehose-2015-08-04.min.json (13406B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2015-08-04", 5 "endpointPrefix": "firehose", 6 "jsonVersion": "1.1", 7 "protocol": "json", 8 "serviceAbbreviation": "Firehose", 9 "serviceFullName": "Amazon Kinesis Firehose", 10 "signatureVersion": "v4", 11 "targetPrefix": "Firehose_20150804" 12 }, 13 "operations": { 14 "CreateDeliveryStream": { 15 "input": { 16 "type": "structure", 17 "required": [ 18 "DeliveryStreamName" 19 ], 20 "members": { 21 "DeliveryStreamName": {}, 22 "S3DestinationConfiguration": { 23 "shape": "S3" 24 }, 25 "RedshiftDestinationConfiguration": { 26 "type": "structure", 27 "required": [ 28 "RoleARN", 29 "ClusterJDBCURL", 30 "CopyCommand", 31 "Username", 32 "Password", 33 "S3Configuration" 34 ], 35 "members": { 36 "RoleARN": {}, 37 "ClusterJDBCURL": {}, 38 "CopyCommand": { 39 "shape": "Sl" 40 }, 41 "Username": { 42 "shape": "Sp" 43 }, 44 "Password": { 45 "shape": "Sq" 46 }, 47 "RetryOptions": { 48 "shape": "Sr" 49 }, 50 "S3Configuration": { 51 "shape": "S3" 52 }, 53 "CloudWatchLoggingOptions": { 54 "shape": "Sf" 55 } 56 } 57 }, 58 "ElasticsearchDestinationConfiguration": { 59 "type": "structure", 60 "required": [ 61 "RoleARN", 62 "DomainARN", 63 "IndexName", 64 "TypeName", 65 "S3Configuration" 66 ], 67 "members": { 68 "RoleARN": {}, 69 "DomainARN": {}, 70 "IndexName": {}, 71 "TypeName": {}, 72 "IndexRotationPeriod": {}, 73 "BufferingHints": { 74 "shape": "Sy" 75 }, 76 "RetryOptions": { 77 "shape": "S11" 78 }, 79 "S3BackupMode": {}, 80 "S3Configuration": { 81 "shape": "S3" 82 }, 83 "CloudWatchLoggingOptions": { 84 "shape": "Sf" 85 } 86 } 87 } 88 } 89 }, 90 "output": { 91 "type": "structure", 92 "members": { 93 "DeliveryStreamARN": {} 94 } 95 } 96 }, 97 "DeleteDeliveryStream": { 98 "input": { 99 "type": "structure", 100 "required": [ 101 "DeliveryStreamName" 102 ], 103 "members": { 104 "DeliveryStreamName": {} 105 } 106 }, 107 "output": { 108 "type": "structure", 109 "members": {} 110 } 111 }, 112 "DescribeDeliveryStream": { 113 "input": { 114 "type": "structure", 115 "required": [ 116 "DeliveryStreamName" 117 ], 118 "members": { 119 "DeliveryStreamName": {}, 120 "Limit": { 121 "type": "integer" 122 }, 123 "ExclusiveStartDestinationId": {} 124 } 125 }, 126 "output": { 127 "type": "structure", 128 "required": [ 129 "DeliveryStreamDescription" 130 ], 131 "members": { 132 "DeliveryStreamDescription": { 133 "type": "structure", 134 "required": [ 135 "DeliveryStreamName", 136 "DeliveryStreamARN", 137 "DeliveryStreamStatus", 138 "VersionId", 139 "Destinations", 140 "HasMoreDestinations" 141 ], 142 "members": { 143 "DeliveryStreamName": {}, 144 "DeliveryStreamARN": {}, 145 "DeliveryStreamStatus": {}, 146 "VersionId": {}, 147 "CreateTimestamp": { 148 "type": "timestamp" 149 }, 150 "LastUpdateTimestamp": { 151 "type": "timestamp" 152 }, 153 "Destinations": { 154 "type": "list", 155 "member": { 156 "type": "structure", 157 "required": [ 158 "DestinationId" 159 ], 160 "members": { 161 "DestinationId": {}, 162 "S3DestinationDescription": { 163 "shape": "S1i" 164 }, 165 "RedshiftDestinationDescription": { 166 "type": "structure", 167 "required": [ 168 "RoleARN", 169 "ClusterJDBCURL", 170 "CopyCommand", 171 "Username", 172 "S3DestinationDescription" 173 ], 174 "members": { 175 "RoleARN": {}, 176 "ClusterJDBCURL": {}, 177 "CopyCommand": { 178 "shape": "Sl" 179 }, 180 "Username": { 181 "shape": "Sp" 182 }, 183 "RetryOptions": { 184 "shape": "Sr" 185 }, 186 "S3DestinationDescription": { 187 "shape": "S1i" 188 }, 189 "CloudWatchLoggingOptions": { 190 "shape": "Sf" 191 } 192 } 193 }, 194 "ElasticsearchDestinationDescription": { 195 "type": "structure", 196 "members": { 197 "RoleARN": {}, 198 "DomainARN": {}, 199 "IndexName": {}, 200 "TypeName": {}, 201 "IndexRotationPeriod": {}, 202 "BufferingHints": { 203 "shape": "Sy" 204 }, 205 "RetryOptions": { 206 "shape": "S11" 207 }, 208 "S3BackupMode": {}, 209 "S3DestinationDescription": { 210 "shape": "S1i" 211 }, 212 "CloudWatchLoggingOptions": { 213 "shape": "Sf" 214 } 215 } 216 } 217 } 218 } 219 }, 220 "HasMoreDestinations": { 221 "type": "boolean" 222 } 223 } 224 } 225 } 226 } 227 }, 228 "ListDeliveryStreams": { 229 "input": { 230 "type": "structure", 231 "members": { 232 "Limit": { 233 "type": "integer" 234 }, 235 "ExclusiveStartDeliveryStreamName": {} 236 } 237 }, 238 "output": { 239 "type": "structure", 240 "required": [ 241 "DeliveryStreamNames", 242 "HasMoreDeliveryStreams" 243 ], 244 "members": { 245 "DeliveryStreamNames": { 246 "type": "list", 247 "member": {} 248 }, 249 "HasMoreDeliveryStreams": { 250 "type": "boolean" 251 } 252 } 253 } 254 }, 255 "PutRecord": { 256 "input": { 257 "type": "structure", 258 "required": [ 259 "DeliveryStreamName", 260 "Record" 261 ], 262 "members": { 263 "DeliveryStreamName": {}, 264 "Record": { 265 "shape": "S1q" 266 } 267 } 268 }, 269 "output": { 270 "type": "structure", 271 "required": [ 272 "RecordId" 273 ], 274 "members": { 275 "RecordId": {} 276 } 277 } 278 }, 279 "PutRecordBatch": { 280 "input": { 281 "type": "structure", 282 "required": [ 283 "DeliveryStreamName", 284 "Records" 285 ], 286 "members": { 287 "DeliveryStreamName": {}, 288 "Records": { 289 "type": "list", 290 "member": { 291 "shape": "S1q" 292 } 293 } 294 } 295 }, 296 "output": { 297 "type": "structure", 298 "required": [ 299 "FailedPutCount", 300 "RequestResponses" 301 ], 302 "members": { 303 "FailedPutCount": { 304 "type": "integer" 305 }, 306 "RequestResponses": { 307 "type": "list", 308 "member": { 309 "type": "structure", 310 "members": { 311 "RecordId": {}, 312 "ErrorCode": {}, 313 "ErrorMessage": {} 314 } 315 } 316 } 317 } 318 } 319 }, 320 "UpdateDestination": { 321 "input": { 322 "type": "structure", 323 "required": [ 324 "DeliveryStreamName", 325 "CurrentDeliveryStreamVersionId", 326 "DestinationId" 327 ], 328 "members": { 329 "DeliveryStreamName": {}, 330 "CurrentDeliveryStreamVersionId": {}, 331 "DestinationId": {}, 332 "S3DestinationUpdate": { 333 "shape": "S23" 334 }, 335 "RedshiftDestinationUpdate": { 336 "type": "structure", 337 "members": { 338 "RoleARN": {}, 339 "ClusterJDBCURL": {}, 340 "CopyCommand": { 341 "shape": "Sl" 342 }, 343 "Username": { 344 "shape": "Sp" 345 }, 346 "Password": { 347 "shape": "Sq" 348 }, 349 "RetryOptions": { 350 "shape": "Sr" 351 }, 352 "S3Update": { 353 "shape": "S23" 354 }, 355 "CloudWatchLoggingOptions": { 356 "shape": "Sf" 357 } 358 } 359 }, 360 "ElasticsearchDestinationUpdate": { 361 "type": "structure", 362 "members": { 363 "RoleARN": {}, 364 "DomainARN": {}, 365 "IndexName": {}, 366 "TypeName": {}, 367 "IndexRotationPeriod": {}, 368 "BufferingHints": { 369 "shape": "Sy" 370 }, 371 "RetryOptions": { 372 "shape": "S11" 373 }, 374 "S3Update": { 375 "shape": "S23" 376 }, 377 "CloudWatchLoggingOptions": { 378 "shape": "Sf" 379 } 380 } 381 } 382 } 383 }, 384 "output": { 385 "type": "structure", 386 "members": {} 387 } 388 } 389 }, 390 "shapes": { 391 "S3": { 392 "type": "structure", 393 "required": [ 394 "RoleARN", 395 "BucketARN" 396 ], 397 "members": { 398 "RoleARN": {}, 399 "BucketARN": {}, 400 "Prefix": {}, 401 "BufferingHints": { 402 "shape": "S7" 403 }, 404 "CompressionFormat": {}, 405 "EncryptionConfiguration": { 406 "shape": "Sb" 407 }, 408 "CloudWatchLoggingOptions": { 409 "shape": "Sf" 410 } 411 } 412 }, 413 "S7": { 414 "type": "structure", 415 "members": { 416 "SizeInMBs": { 417 "type": "integer" 418 }, 419 "IntervalInSeconds": { 420 "type": "integer" 421 } 422 } 423 }, 424 "Sb": { 425 "type": "structure", 426 "members": { 427 "NoEncryptionConfig": {}, 428 "KMSEncryptionConfig": { 429 "type": "structure", 430 "required": [ 431 "AWSKMSKeyARN" 432 ], 433 "members": { 434 "AWSKMSKeyARN": {} 435 } 436 } 437 } 438 }, 439 "Sf": { 440 "type": "structure", 441 "members": { 442 "Enabled": { 443 "type": "boolean" 444 }, 445 "LogGroupName": {}, 446 "LogStreamName": {} 447 } 448 }, 449 "Sl": { 450 "type": "structure", 451 "required": [ 452 "DataTableName" 453 ], 454 "members": { 455 "DataTableName": {}, 456 "DataTableColumns": {}, 457 "CopyOptions": {} 458 } 459 }, 460 "Sp": { 461 "type": "string", 462 "sensitive": true 463 }, 464 "Sq": { 465 "type": "string", 466 "sensitive": true 467 }, 468 "Sr": { 469 "type": "structure", 470 "members": { 471 "DurationInSeconds": { 472 "type": "integer" 473 } 474 } 475 }, 476 "Sy": { 477 "type": "structure", 478 "members": { 479 "IntervalInSeconds": { 480 "type": "integer" 481 }, 482 "SizeInMBs": { 483 "type": "integer" 484 } 485 } 486 }, 487 "S11": { 488 "type": "structure", 489 "members": { 490 "DurationInSeconds": { 491 "type": "integer" 492 } 493 } 494 }, 495 "S1i": { 496 "type": "structure", 497 "required": [ 498 "RoleARN", 499 "BucketARN", 500 "BufferingHints", 501 "CompressionFormat", 502 "EncryptionConfiguration" 503 ], 504 "members": { 505 "RoleARN": {}, 506 "BucketARN": {}, 507 "Prefix": {}, 508 "BufferingHints": { 509 "shape": "S7" 510 }, 511 "CompressionFormat": {}, 512 "EncryptionConfiguration": { 513 "shape": "Sb" 514 }, 515 "CloudWatchLoggingOptions": { 516 "shape": "Sf" 517 } 518 } 519 }, 520 "S1q": { 521 "type": "structure", 522 "required": [ 523 "Data" 524 ], 525 "members": { 526 "Data": { 527 "type": "blob" 528 } 529 } 530 }, 531 "S23": { 532 "type": "structure", 533 "members": { 534 "RoleARN": {}, 535 "BucketARN": {}, 536 "Prefix": {}, 537 "BufferingHints": { 538 "shape": "S7" 539 }, 540 "CompressionFormat": {}, 541 "EncryptionConfiguration": { 542 "shape": "Sb" 543 }, 544 "CloudWatchLoggingOptions": { 545 "shape": "Sf" 546 } 547 } 548 } 549 } 550 }