/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / apis / ivs-2020-07-14.min.json
ivs-2020-07-14.min.json
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2020-07-14", 5 "endpointPrefix": "ivs", 6 "protocol": "rest-json", 7 "serviceAbbreviation": "Amazon IVS", 8 "serviceFullName": "Amazon Interactive Video Service", 9 "serviceId": "ivs", 10 "signatureVersion": "v4", 11 "signingName": "ivs", 12 "uid": "ivs-2020-07-14" 13 }, 14 "operations": { 15 "BatchGetChannel": { 16 "http": { 17 "requestUri": "/BatchGetChannel" 18 }, 19 "input": { 20 "type": "structure", 21 "required": [ 22 "arns" 23 ], 24 "members": { 25 "arns": { 26 "type": "list", 27 "member": {} 28 } 29 } 30 }, 31 "output": { 32 "type": "structure", 33 "members": { 34 "channels": { 35 "type": "list", 36 "member": { 37 "shape": "S6" 38 } 39 }, 40 "errors": { 41 "shape": "Sh" 42 } 43 } 44 } 45 }, 46 "BatchGetStreamKey": { 47 "http": { 48 "requestUri": "/BatchGetStreamKey" 49 }, 50 "input": { 51 "type": "structure", 52 "required": [ 53 "arns" 54 ], 55 "members": { 56 "arns": { 57 "type": "list", 58 "member": {} 59 } 60 } 61 }, 62 "output": { 63 "type": "structure", 64 "members": { 65 "streamKeys": { 66 "type": "list", 67 "member": { 68 "shape": "Sr" 69 } 70 }, 71 "errors": { 72 "shape": "Sh" 73 } 74 } 75 } 76 }, 77 "CreateChannel": { 78 "http": { 79 "requestUri": "/CreateChannel" 80 }, 81 "input": { 82 "type": "structure", 83 "members": { 84 "name": {}, 85 "latencyMode": {}, 86 "type": {}, 87 "authorized": { 88 "type": "boolean" 89 }, 90 "recordingConfigurationArn": {}, 91 "tags": { 92 "shape": "Se" 93 } 94 } 95 }, 96 "output": { 97 "type": "structure", 98 "members": { 99 "channel": { 100 "shape": "S6" 101 }, 102 "streamKey": { 103 "shape": "Sr" 104 } 105 } 106 } 107 }, 108 "CreateRecordingConfiguration": { 109 "http": { 110 "requestUri": "/CreateRecordingConfiguration" 111 }, 112 "input": { 113 "type": "structure", 114 "required": [ 115 "destinationConfiguration" 116 ], 117 "members": { 118 "name": {}, 119 "destinationConfiguration": { 120 "shape": "Sy" 121 }, 122 "tags": { 123 "shape": "Se" 124 } 125 } 126 }, 127 "output": { 128 "type": "structure", 129 "members": { 130 "recordingConfiguration": { 131 "shape": "S12" 132 } 133 } 134 } 135 }, 136 "CreateStreamKey": { 137 "http": { 138 "requestUri": "/CreateStreamKey" 139 }, 140 "input": { 141 "type": "structure", 142 "required": [ 143 "channelArn" 144 ], 145 "members": { 146 "channelArn": {}, 147 "tags": { 148 "shape": "Se" 149 } 150 } 151 }, 152 "output": { 153 "type": "structure", 154 "members": { 155 "streamKey": { 156 "shape": "Sr" 157 } 158 } 159 } 160 }, 161 "DeleteChannel": { 162 "http": { 163 "requestUri": "/DeleteChannel", 164 "responseCode": 204 165 }, 166 "input": { 167 "type": "structure", 168 "required": [ 169 "arn" 170 ], 171 "members": { 172 "arn": {} 173 } 174 } 175 }, 176 "DeletePlaybackKeyPair": { 177 "http": { 178 "requestUri": "/DeletePlaybackKeyPair" 179 }, 180 "input": { 181 "type": "structure", 182 "required": [ 183 "arn" 184 ], 185 "members": { 186 "arn": {} 187 } 188 }, 189 "output": { 190 "type": "structure", 191 "members": {} 192 } 193 }, 194 "DeleteRecordingConfiguration": { 195 "http": { 196 "requestUri": "/DeleteRecordingConfiguration" 197 }, 198 "input": { 199 "type": "structure", 200 "required": [ 201 "arn" 202 ], 203 "members": { 204 "arn": {} 205 } 206 } 207 }, 208 "DeleteStreamKey": { 209 "http": { 210 "requestUri": "/DeleteStreamKey", 211 "responseCode": 204 212 }, 213 "input": { 214 "type": "structure", 215 "required": [ 216 "arn" 217 ], 218 "members": { 219 "arn": {} 220 } 221 } 222 }, 223 "GetChannel": { 224 "http": { 225 "requestUri": "/GetChannel" 226 }, 227 "input": { 228 "type": "structure", 229 "required": [ 230 "arn" 231 ], 232 "members": { 233 "arn": {} 234 } 235 }, 236 "output": { 237 "type": "structure", 238 "members": { 239 "channel": { 240 "shape": "S6" 241 } 242 } 243 } 244 }, 245 "GetPlaybackKeyPair": { 246 "http": { 247 "requestUri": "/GetPlaybackKeyPair" 248 }, 249 "input": { 250 "type": "structure", 251 "required": [ 252 "arn" 253 ], 254 "members": { 255 "arn": {} 256 } 257 }, 258 "output": { 259 "type": "structure", 260 "members": { 261 "keyPair": { 262 "shape": "S1h" 263 } 264 } 265 } 266 }, 267 "GetRecordingConfiguration": { 268 "http": { 269 "requestUri": "/GetRecordingConfiguration" 270 }, 271 "input": { 272 "type": "structure", 273 "required": [ 274 "arn" 275 ], 276 "members": { 277 "arn": {} 278 } 279 }, 280 "output": { 281 "type": "structure", 282 "members": { 283 "recordingConfiguration": { 284 "shape": "S12" 285 } 286 } 287 } 288 }, 289 "GetStream": { 290 "http": { 291 "requestUri": "/GetStream" 292 }, 293 "input": { 294 "type": "structure", 295 "required": [ 296 "channelArn" 297 ], 298 "members": { 299 "channelArn": {} 300 } 301 }, 302 "output": { 303 "type": "structure", 304 "members": { 305 "stream": { 306 "type": "structure", 307 "members": { 308 "channelArn": {}, 309 "playbackUrl": {}, 310 "startTime": { 311 "shape": "S1p" 312 }, 313 "state": {}, 314 "health": {}, 315 "viewerCount": { 316 "type": "long" 317 } 318 } 319 } 320 } 321 } 322 }, 323 "GetStreamKey": { 324 "http": { 325 "requestUri": "/GetStreamKey" 326 }, 327 "input": { 328 "type": "structure", 329 "required": [ 330 "arn" 331 ], 332 "members": { 333 "arn": {} 334 } 335 }, 336 "output": { 337 "type": "structure", 338 "members": { 339 "streamKey": { 340 "shape": "Sr" 341 } 342 } 343 } 344 }, 345 "ImportPlaybackKeyPair": { 346 "http": { 347 "requestUri": "/ImportPlaybackKeyPair" 348 }, 349 "input": { 350 "type": "structure", 351 "required": [ 352 "publicKeyMaterial" 353 ], 354 "members": { 355 "publicKeyMaterial": {}, 356 "name": {}, 357 "tags": { 358 "shape": "Se" 359 } 360 } 361 }, 362 "output": { 363 "type": "structure", 364 "members": { 365 "keyPair": { 366 "shape": "S1h" 367 } 368 } 369 } 370 }, 371 "ListChannels": { 372 "http": { 373 "requestUri": "/ListChannels" 374 }, 375 "input": { 376 "type": "structure", 377 "members": { 378 "filterByName": {}, 379 "filterByRecordingConfigurationArn": {}, 380 "nextToken": {}, 381 "maxResults": { 382 "type": "integer" 383 } 384 } 385 }, 386 "output": { 387 "type": "structure", 388 "required": [ 389 "channels" 390 ], 391 "members": { 392 "channels": { 393 "type": "list", 394 "member": { 395 "type": "structure", 396 "members": { 397 "arn": {}, 398 "name": {}, 399 "latencyMode": {}, 400 "authorized": { 401 "type": "boolean" 402 }, 403 "recordingConfigurationArn": {}, 404 "tags": { 405 "shape": "Se" 406 } 407 } 408 } 409 }, 410 "nextToken": {} 411 } 412 } 413 }, 414 "ListPlaybackKeyPairs": { 415 "http": { 416 "requestUri": "/ListPlaybackKeyPairs" 417 }, 418 "input": { 419 "type": "structure", 420 "members": { 421 "nextToken": {}, 422 "maxResults": { 423 "type": "integer" 424 } 425 } 426 }, 427 "output": { 428 "type": "structure", 429 "required": [ 430 "keyPairs" 431 ], 432 "members": { 433 "keyPairs": { 434 "type": "list", 435 "member": { 436 "type": "structure", 437 "members": { 438 "arn": {}, 439 "name": {}, 440 "tags": { 441 "shape": "Se" 442 } 443 } 444 } 445 }, 446 "nextToken": {} 447 } 448 } 449 }, 450 "ListRecordingConfigurations": { 451 "http": { 452 "requestUri": "/ListRecordingConfigurations" 453 }, 454 "input": { 455 "type": "structure", 456 "members": { 457 "nextToken": {}, 458 "maxResults": { 459 "type": "integer" 460 } 461 } 462 }, 463 "output": { 464 "type": "structure", 465 "required": [ 466 "recordingConfigurations" 467 ], 468 "members": { 469 "recordingConfigurations": { 470 "type": "list", 471 "member": { 472 "type": "structure", 473 "required": [ 474 "arn", 475 "destinationConfiguration", 476 "state" 477 ], 478 "members": { 479 "arn": {}, 480 "name": {}, 481 "destinationConfiguration": { 482 "shape": "Sy" 483 }, 484 "state": {}, 485 "tags": { 486 "shape": "Se" 487 } 488 } 489 } 490 }, 491 "nextToken": {} 492 } 493 } 494 }, 495 "ListStreamKeys": { 496 "http": { 497 "requestUri": "/ListStreamKeys" 498 }, 499 "input": { 500 "type": "structure", 501 "required": [ 502 "channelArn" 503 ], 504 "members": { 505 "channelArn": {}, 506 "nextToken": {}, 507 "maxResults": { 508 "type": "integer" 509 } 510 } 511 }, 512 "output": { 513 "type": "structure", 514 "required": [ 515 "streamKeys" 516 ], 517 "members": { 518 "streamKeys": { 519 "type": "list", 520 "member": { 521 "type": "structure", 522 "members": { 523 "arn": {}, 524 "channelArn": {}, 525 "tags": { 526 "shape": "Se" 527 } 528 } 529 } 530 }, 531 "nextToken": {} 532 } 533 } 534 }, 535 "ListStreams": { 536 "http": { 537 "requestUri": "/ListStreams" 538 }, 539 "input": { 540 "type": "structure", 541 "members": { 542 "nextToken": {}, 543 "maxResults": { 544 "type": "integer" 545 } 546 } 547 }, 548 "output": { 549 "type": "structure", 550 "required": [ 551 "streams" 552 ], 553 "members": { 554 "streams": { 555 "type": "list", 556 "member": { 557 "type": "structure", 558 "members": { 559 "channelArn": {}, 560 "state": {}, 561 "health": {}, 562 "viewerCount": { 563 "type": "long" 564 }, 565 "startTime": { 566 "shape": "S1p" 567 } 568 } 569 } 570 }, 571 "nextToken": {} 572 } 573 } 574 }, 575 "ListTagsForResource": { 576 "http": { 577 "method": "GET", 578 "requestUri": "/tags/{resourceArn}" 579 }, 580 "input": { 581 "type": "structure", 582 "required": [ 583 "resourceArn" 584 ], 585 "members": { 586 "resourceArn": { 587 "location": "uri", 588 "locationName": "resourceArn" 589 }, 590 "nextToken": {}, 591 "maxResults": { 592 "type": "integer" 593 } 594 } 595 }, 596 "output": { 597 "type": "structure", 598 "required": [ 599 "tags" 600 ], 601 "members": { 602 "tags": { 603 "shape": "Se" 604 }, 605 "nextToken": {} 606 } 607 } 608 }, 609 "PutMetadata": { 610 "http": { 611 "requestUri": "/PutMetadata" 612 }, 613 "input": { 614 "type": "structure", 615 "required": [ 616 "channelArn", 617 "metadata" 618 ], 619 "members": { 620 "channelArn": {}, 621 "metadata": {} 622 } 623 } 624 }, 625 "StopStream": { 626 "http": { 627 "requestUri": "/StopStream" 628 }, 629 "input": { 630 "type": "structure", 631 "required": [ 632 "channelArn" 633 ], 634 "members": { 635 "channelArn": {} 636 } 637 }, 638 "output": { 639 "type": "structure", 640 "members": {} 641 } 642 }, 643 "TagResource": { 644 "http": { 645 "requestUri": "/tags/{resourceArn}" 646 }, 647 "input": { 648 "type": "structure", 649 "required": [ 650 "resourceArn", 651 "tags" 652 ], 653 "members": { 654 "resourceArn": { 655 "location": "uri", 656 "locationName": "resourceArn" 657 }, 658 "tags": { 659 "shape": "Se" 660 } 661 } 662 }, 663 "output": { 664 "type": "structure", 665 "members": {} 666 } 667 }, 668 "UntagResource": { 669 "http": { 670 "method": "DELETE", 671 "requestUri": "/tags/{resourceArn}" 672 }, 673 "input": { 674 "type": "structure", 675 "required": [ 676 "resourceArn", 677 "tagKeys" 678 ], 679 "members": { 680 "resourceArn": { 681 "location": "uri", 682 "locationName": "resourceArn" 683 }, 684 "tagKeys": { 685 "location": "querystring", 686 "locationName": "tagKeys", 687 "type": "list", 688 "member": {} 689 } 690 } 691 }, 692 "output": { 693 "type": "structure", 694 "members": {} 695 } 696 }, 697 "UpdateChannel": { 698 "http": { 699 "requestUri": "/UpdateChannel" 700 }, 701 "input": { 702 "type": "structure", 703 "required": [ 704 "arn" 705 ], 706 "members": { 707 "arn": {}, 708 "name": {}, 709 "latencyMode": {}, 710 "type": {}, 711 "authorized": { 712 "type": "boolean" 713 }, 714 "recordingConfigurationArn": {} 715 } 716 }, 717 "output": { 718 "type": "structure", 719 "members": { 720 "channel": { 721 "shape": "S6" 722 } 723 } 724 } 725 } 726 }, 727 "shapes": { 728 "S6": { 729 "type": "structure", 730 "members": { 731 "arn": {}, 732 "name": {}, 733 "latencyMode": {}, 734 "type": {}, 735 "recordingConfigurationArn": {}, 736 "ingestEndpoint": {}, 737 "playbackUrl": {}, 738 "authorized": { 739 "type": "boolean" 740 }, 741 "tags": { 742 "shape": "Se" 743 } 744 } 745 }, 746 "Se": { 747 "type": "map", 748 "key": {}, 749 "value": {} 750 }, 751 "Sh": { 752 "type": "list", 753 "member": { 754 "type": "structure", 755 "members": { 756 "arn": {}, 757 "code": {}, 758 "message": {} 759 } 760 } 761 }, 762 "Sr": { 763 "type": "structure", 764 "members": { 765 "arn": {}, 766 "value": {}, 767 "channelArn": {}, 768 "tags": { 769 "shape": "Se" 770 } 771 } 772 }, 773 "Sy": { 774 "type": "structure", 775 "members": { 776 "s3": { 777 "type": "structure", 778 "required": [ 779 "bucketName" 780 ], 781 "members": { 782 "bucketName": {} 783 } 784 } 785 } 786 }, 787 "S12": { 788 "type": "structure", 789 "required": [ 790 "arn", 791 "destinationConfiguration", 792 "state" 793 ], 794 "members": { 795 "arn": {}, 796 "name": {}, 797 "destinationConfiguration": { 798 "shape": "Sy" 799 }, 800 "state": {}, 801 "tags": { 802 "shape": "Se" 803 } 804 } 805 }, 806 "S1h": { 807 "type": "structure", 808 "members": { 809 "arn": {}, 810 "name": {}, 811 "fingerprint": {}, 812 "tags": { 813 "shape": "Se" 814 } 815 } 816 }, 817 "S1p": { 818 "type": "timestamp", 819 "timestampFormat": "iso8601" 820 } 821 } 822 }