kinesis-2013-12-02.min.json (12497B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2013-12-02", 5 "endpointPrefix": "kinesis", 6 "jsonVersion": "1.1", 7 "protocol": "json", 8 "serviceAbbreviation": "Kinesis", 9 "serviceFullName": "Amazon Kinesis", 10 "signatureVersion": "v4", 11 "targetPrefix": "Kinesis_20131202" 12 }, 13 "operations": { 14 "AddTagsToStream": { 15 "input": { 16 "type": "structure", 17 "required": [ 18 "StreamName", 19 "Tags" 20 ], 21 "members": { 22 "StreamName": {}, 23 "Tags": { 24 "type": "map", 25 "key": {}, 26 "value": {} 27 } 28 } 29 } 30 }, 31 "CreateStream": { 32 "input": { 33 "type": "structure", 34 "required": [ 35 "StreamName", 36 "ShardCount" 37 ], 38 "members": { 39 "StreamName": {}, 40 "ShardCount": { 41 "type": "integer" 42 } 43 } 44 } 45 }, 46 "DecreaseStreamRetentionPeriod": { 47 "input": { 48 "type": "structure", 49 "required": [ 50 "StreamName", 51 "RetentionPeriodHours" 52 ], 53 "members": { 54 "StreamName": {}, 55 "RetentionPeriodHours": { 56 "type": "integer" 57 } 58 } 59 } 60 }, 61 "DeleteStream": { 62 "input": { 63 "type": "structure", 64 "required": [ 65 "StreamName" 66 ], 67 "members": { 68 "StreamName": {} 69 } 70 } 71 }, 72 "DescribeLimits": { 73 "input": { 74 "type": "structure", 75 "members": {} 76 }, 77 "output": { 78 "type": "structure", 79 "required": [ 80 "ShardLimit", 81 "OpenShardCount" 82 ], 83 "members": { 84 "ShardLimit": { 85 "type": "integer" 86 }, 87 "OpenShardCount": { 88 "type": "integer" 89 } 90 } 91 } 92 }, 93 "DescribeStream": { 94 "input": { 95 "type": "structure", 96 "required": [ 97 "StreamName" 98 ], 99 "members": { 100 "StreamName": {}, 101 "Limit": { 102 "type": "integer" 103 }, 104 "ExclusiveStartShardId": {} 105 } 106 }, 107 "output": { 108 "type": "structure", 109 "required": [ 110 "StreamDescription" 111 ], 112 "members": { 113 "StreamDescription": { 114 "type": "structure", 115 "required": [ 116 "StreamName", 117 "StreamARN", 118 "StreamStatus", 119 "Shards", 120 "HasMoreShards", 121 "RetentionPeriodHours", 122 "StreamCreationTimestamp", 123 "EnhancedMonitoring" 124 ], 125 "members": { 126 "StreamName": {}, 127 "StreamARN": {}, 128 "StreamStatus": {}, 129 "Shards": { 130 "type": "list", 131 "member": { 132 "type": "structure", 133 "required": [ 134 "ShardId", 135 "HashKeyRange", 136 "SequenceNumberRange" 137 ], 138 "members": { 139 "ShardId": {}, 140 "ParentShardId": {}, 141 "AdjacentParentShardId": {}, 142 "HashKeyRange": { 143 "type": "structure", 144 "required": [ 145 "StartingHashKey", 146 "EndingHashKey" 147 ], 148 "members": { 149 "StartingHashKey": {}, 150 "EndingHashKey": {} 151 } 152 }, 153 "SequenceNumberRange": { 154 "type": "structure", 155 "required": [ 156 "StartingSequenceNumber" 157 ], 158 "members": { 159 "StartingSequenceNumber": {}, 160 "EndingSequenceNumber": {} 161 } 162 } 163 } 164 } 165 }, 166 "HasMoreShards": { 167 "type": "boolean" 168 }, 169 "RetentionPeriodHours": { 170 "type": "integer" 171 }, 172 "StreamCreationTimestamp": { 173 "type": "timestamp" 174 }, 175 "EnhancedMonitoring": { 176 "type": "list", 177 "member": { 178 "type": "structure", 179 "members": { 180 "ShardLevelMetrics": { 181 "shape": "Su" 182 } 183 } 184 } 185 } 186 } 187 } 188 } 189 } 190 }, 191 "DisableEnhancedMonitoring": { 192 "input": { 193 "type": "structure", 194 "required": [ 195 "StreamName", 196 "ShardLevelMetrics" 197 ], 198 "members": { 199 "StreamName": {}, 200 "ShardLevelMetrics": { 201 "shape": "Su" 202 } 203 } 204 }, 205 "output": { 206 "shape": "Sx" 207 } 208 }, 209 "EnableEnhancedMonitoring": { 210 "input": { 211 "type": "structure", 212 "required": [ 213 "StreamName", 214 "ShardLevelMetrics" 215 ], 216 "members": { 217 "StreamName": {}, 218 "ShardLevelMetrics": { 219 "shape": "Su" 220 } 221 } 222 }, 223 "output": { 224 "shape": "Sx" 225 } 226 }, 227 "GetRecords": { 228 "input": { 229 "type": "structure", 230 "required": [ 231 "ShardIterator" 232 ], 233 "members": { 234 "ShardIterator": {}, 235 "Limit": { 236 "type": "integer" 237 } 238 } 239 }, 240 "output": { 241 "type": "structure", 242 "required": [ 243 "Records" 244 ], 245 "members": { 246 "Records": { 247 "type": "list", 248 "member": { 249 "type": "structure", 250 "required": [ 251 "SequenceNumber", 252 "Data", 253 "PartitionKey" 254 ], 255 "members": { 256 "SequenceNumber": {}, 257 "ApproximateArrivalTimestamp": { 258 "type": "timestamp" 259 }, 260 "Data": { 261 "type": "blob" 262 }, 263 "PartitionKey": {} 264 } 265 } 266 }, 267 "NextShardIterator": {}, 268 "MillisBehindLatest": { 269 "type": "long" 270 } 271 } 272 } 273 }, 274 "GetShardIterator": { 275 "input": { 276 "type": "structure", 277 "required": [ 278 "StreamName", 279 "ShardId", 280 "ShardIteratorType" 281 ], 282 "members": { 283 "StreamName": {}, 284 "ShardId": {}, 285 "ShardIteratorType": {}, 286 "StartingSequenceNumber": {}, 287 "Timestamp": { 288 "type": "timestamp" 289 } 290 } 291 }, 292 "output": { 293 "type": "structure", 294 "members": { 295 "ShardIterator": {} 296 } 297 } 298 }, 299 "IncreaseStreamRetentionPeriod": { 300 "input": { 301 "type": "structure", 302 "required": [ 303 "StreamName", 304 "RetentionPeriodHours" 305 ], 306 "members": { 307 "StreamName": {}, 308 "RetentionPeriodHours": { 309 "type": "integer" 310 } 311 } 312 } 313 }, 314 "ListStreams": { 315 "input": { 316 "type": "structure", 317 "members": { 318 "Limit": { 319 "type": "integer" 320 }, 321 "ExclusiveStartStreamName": {} 322 } 323 }, 324 "output": { 325 "type": "structure", 326 "required": [ 327 "StreamNames", 328 "HasMoreStreams" 329 ], 330 "members": { 331 "StreamNames": { 332 "type": "list", 333 "member": {} 334 }, 335 "HasMoreStreams": { 336 "type": "boolean" 337 } 338 } 339 } 340 }, 341 "ListTagsForStream": { 342 "input": { 343 "type": "structure", 344 "required": [ 345 "StreamName" 346 ], 347 "members": { 348 "StreamName": {}, 349 "ExclusiveStartTagKey": {}, 350 "Limit": { 351 "type": "integer" 352 } 353 } 354 }, 355 "output": { 356 "type": "structure", 357 "required": [ 358 "Tags", 359 "HasMoreTags" 360 ], 361 "members": { 362 "Tags": { 363 "type": "list", 364 "member": { 365 "type": "structure", 366 "required": [ 367 "Key" 368 ], 369 "members": { 370 "Key": {}, 371 "Value": {} 372 } 373 } 374 }, 375 "HasMoreTags": { 376 "type": "boolean" 377 } 378 } 379 } 380 }, 381 "MergeShards": { 382 "input": { 383 "type": "structure", 384 "required": [ 385 "StreamName", 386 "ShardToMerge", 387 "AdjacentShardToMerge" 388 ], 389 "members": { 390 "StreamName": {}, 391 "ShardToMerge": {}, 392 "AdjacentShardToMerge": {} 393 } 394 } 395 }, 396 "PutRecord": { 397 "input": { 398 "type": "structure", 399 "required": [ 400 "StreamName", 401 "Data", 402 "PartitionKey" 403 ], 404 "members": { 405 "StreamName": {}, 406 "Data": { 407 "type": "blob" 408 }, 409 "PartitionKey": {}, 410 "ExplicitHashKey": {}, 411 "SequenceNumberForOrdering": {} 412 } 413 }, 414 "output": { 415 "type": "structure", 416 "required": [ 417 "ShardId", 418 "SequenceNumber" 419 ], 420 "members": { 421 "ShardId": {}, 422 "SequenceNumber": {} 423 } 424 } 425 }, 426 "PutRecords": { 427 "input": { 428 "type": "structure", 429 "required": [ 430 "Records", 431 "StreamName" 432 ], 433 "members": { 434 "Records": { 435 "type": "list", 436 "member": { 437 "type": "structure", 438 "required": [ 439 "Data", 440 "PartitionKey" 441 ], 442 "members": { 443 "Data": { 444 "type": "blob" 445 }, 446 "ExplicitHashKey": {}, 447 "PartitionKey": {} 448 } 449 } 450 }, 451 "StreamName": {} 452 } 453 }, 454 "output": { 455 "type": "structure", 456 "required": [ 457 "Records" 458 ], 459 "members": { 460 "FailedRecordCount": { 461 "type": "integer" 462 }, 463 "Records": { 464 "type": "list", 465 "member": { 466 "type": "structure", 467 "members": { 468 "SequenceNumber": {}, 469 "ShardId": {}, 470 "ErrorCode": {}, 471 "ErrorMessage": {} 472 } 473 } 474 } 475 } 476 } 477 }, 478 "RemoveTagsFromStream": { 479 "input": { 480 "type": "structure", 481 "required": [ 482 "StreamName", 483 "TagKeys" 484 ], 485 "members": { 486 "StreamName": {}, 487 "TagKeys": { 488 "type": "list", 489 "member": {} 490 } 491 } 492 } 493 }, 494 "SplitShard": { 495 "input": { 496 "type": "structure", 497 "required": [ 498 "StreamName", 499 "ShardToSplit", 500 "NewStartingHashKey" 501 ], 502 "members": { 503 "StreamName": {}, 504 "ShardToSplit": {}, 505 "NewStartingHashKey": {} 506 } 507 } 508 }, 509 "UpdateShardCount": { 510 "input": { 511 "type": "structure", 512 "required": [ 513 "StreamName", 514 "TargetShardCount", 515 "ScalingType" 516 ], 517 "members": { 518 "StreamName": {}, 519 "TargetShardCount": { 520 "type": "integer" 521 }, 522 "ScalingType": {} 523 } 524 }, 525 "output": { 526 "type": "structure", 527 "members": { 528 "StreamName": {}, 529 "CurrentShardCount": { 530 "type": "integer" 531 }, 532 "TargetShardCount": { 533 "type": "integer" 534 } 535 } 536 } 537 } 538 }, 539 "shapes": { 540 "Su": { 541 "type": "list", 542 "member": {} 543 }, 544 "Sx": { 545 "type": "structure", 546 "members": { 547 "StreamName": {}, 548 "CurrentShardLevelMetrics": { 549 "shape": "Su" 550 }, 551 "DesiredShardLevelMetrics": { 552 "shape": "Su" 553 } 554 } 555 } 556 } 557 }