1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2020-07-14",
- "endpointPrefix": "ivsrealtime",
- "jsonVersion": "1.1",
- "protocol": "rest-json",
- "serviceAbbreviation": "ivsrealtime",
- "serviceFullName": "Amazon Interactive Video Service RealTime",
- "serviceId": "IVS RealTime",
- "signatureVersion": "v4",
- "signingName": "ivs",
- "uid": "ivs-realtime-2020-07-14"
- },
- "operations": {
- "CreateEncoderConfiguration": {
- "http": {
- "requestUri": "/CreateEncoderConfiguration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "name": {},
- "tags": {
- "shape": "S3"
- },
- "video": {
- "shape": "S6"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "encoderConfiguration": {
- "shape": "Sc"
- }
- }
- }
- },
- "CreateParticipantToken": {
- "http": {
- "requestUri": "/CreateParticipantToken",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "stageArn"
- ],
- "members": {
- "attributes": {
- "shape": "Sf"
- },
- "capabilities": {
- "shape": "Sh"
- },
- "duration": {
- "type": "integer"
- },
- "stageArn": {},
- "userId": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "participantToken": {
- "shape": "Sn"
- }
- }
- }
- },
- "CreateStage": {
- "http": {
- "requestUri": "/CreateStage",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "name": {},
- "participantTokenConfigurations": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "attributes": {
- "shape": "Sf"
- },
- "capabilities": {
- "shape": "Sh"
- },
- "duration": {
- "type": "integer"
- },
- "userId": {}
- }
- }
- },
- "tags": {
- "shape": "S3"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "participantTokens": {
- "type": "list",
- "member": {
- "shape": "Sn"
- }
- },
- "stage": {
- "shape": "Sx"
- }
- }
- }
- },
- "CreateStorageConfiguration": {
- "http": {
- "requestUri": "/CreateStorageConfiguration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "s3"
- ],
- "members": {
- "name": {},
- "s3": {
- "shape": "S11"
- },
- "tags": {
- "shape": "S3"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "storageConfiguration": {
- "shape": "S14"
- }
- }
- }
- },
- "DeleteEncoderConfiguration": {
- "http": {
- "requestUri": "/DeleteEncoderConfiguration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "DeleteStage": {
- "http": {
- "requestUri": "/DeleteStage",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "DeleteStorageConfiguration": {
- "http": {
- "requestUri": "/DeleteStorageConfiguration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "DisconnectParticipant": {
- "http": {
- "requestUri": "/DisconnectParticipant",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "participantId",
- "stageArn"
- ],
- "members": {
- "participantId": {},
- "reason": {},
- "stageArn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "GetComposition": {
- "http": {
- "requestUri": "/GetComposition",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "composition": {
- "shape": "S1i"
- }
- }
- }
- },
- "GetEncoderConfiguration": {
- "http": {
- "requestUri": "/GetEncoderConfiguration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "encoderConfiguration": {
- "shape": "Sc"
- }
- }
- }
- },
- "GetParticipant": {
- "http": {
- "requestUri": "/GetParticipant",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "participantId",
- "sessionId",
- "stageArn"
- ],
- "members": {
- "participantId": {},
- "sessionId": {},
- "stageArn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "participant": {
- "type": "structure",
- "members": {
- "attributes": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "browserName": {},
- "browserVersion": {},
- "firstJoinTime": {
- "shape": "S1v"
- },
- "ispName": {},
- "osName": {},
- "osVersion": {},
- "participantId": {},
- "published": {
- "type": "boolean"
- },
- "sdkVersion": {},
- "state": {},
- "userId": {}
- }
- }
- }
- }
- },
- "GetStage": {
- "http": {
- "requestUri": "/GetStage",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "stage": {
- "shape": "Sx"
- }
- }
- }
- },
- "GetStageSession": {
- "http": {
- "requestUri": "/GetStageSession",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "sessionId",
- "stageArn"
- ],
- "members": {
- "sessionId": {},
- "stageArn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "stageSession": {
- "type": "structure",
- "members": {
- "endTime": {
- "shape": "S1v"
- },
- "sessionId": {},
- "startTime": {
- "shape": "S1v"
- }
- }
- }
- }
- }
- },
- "GetStorageConfiguration": {
- "http": {
- "requestUri": "/GetStorageConfiguration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "storageConfiguration": {
- "shape": "S14"
- }
- }
- }
- },
- "ListCompositions": {
- "http": {
- "requestUri": "/ListCompositions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "filterByEncoderConfigurationArn": {},
- "filterByStageArn": {},
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "compositions"
- ],
- "members": {
- "compositions": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "arn",
- "destinations",
- "stageArn",
- "state"
- ],
- "members": {
- "arn": {},
- "destinations": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "id",
- "state"
- ],
- "members": {
- "endTime": {
- "shape": "S1v"
- },
- "id": {},
- "startTime": {
- "shape": "S1v"
- },
- "state": {}
- }
- }
- },
- "endTime": {
- "shape": "S1v"
- },
- "stageArn": {},
- "startTime": {
- "shape": "S1v"
- },
- "state": {},
- "tags": {
- "shape": "S3"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListEncoderConfigurations": {
- "http": {
- "requestUri": "/ListEncoderConfigurations",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "encoderConfigurations"
- ],
- "members": {
- "encoderConfigurations": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {},
- "name": {},
- "tags": {
- "shape": "S3"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListParticipantEvents": {
- "http": {
- "requestUri": "/ListParticipantEvents",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "participantId",
- "sessionId",
- "stageArn"
- ],
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {},
- "participantId": {},
- "sessionId": {},
- "stageArn": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "events"
- ],
- "members": {
- "events": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "errorCode": {},
- "eventTime": {
- "shape": "S1v"
- },
- "name": {},
- "participantId": {},
- "remoteParticipantId": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListParticipants": {
- "http": {
- "requestUri": "/ListParticipants",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "sessionId",
- "stageArn"
- ],
- "members": {
- "filterByPublished": {
- "type": "boolean"
- },
- "filterByState": {},
- "filterByUserId": {},
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {},
- "sessionId": {},
- "stageArn": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "participants"
- ],
- "members": {
- "nextToken": {},
- "participants": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "firstJoinTime": {
- "shape": "S1v"
- },
- "participantId": {},
- "published": {
- "type": "boolean"
- },
- "state": {},
- "userId": {}
- }
- }
- }
- }
- }
- },
- "ListStageSessions": {
- "http": {
- "requestUri": "/ListStageSessions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "stageArn"
- ],
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {},
- "stageArn": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "stageSessions"
- ],
- "members": {
- "nextToken": {},
- "stageSessions": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "endTime": {
- "shape": "S1v"
- },
- "sessionId": {},
- "startTime": {
- "shape": "S1v"
- }
- }
- }
- }
- }
- }
- },
- "ListStages": {
- "http": {
- "requestUri": "/ListStages",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "stages"
- ],
- "members": {
- "nextToken": {},
- "stages": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "activeSessionId": {},
- "arn": {},
- "name": {},
- "tags": {
- "shape": "S3"
- }
- }
- }
- }
- }
- }
- },
- "ListStorageConfigurations": {
- "http": {
- "requestUri": "/ListStorageConfigurations",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "storageConfigurations"
- ],
- "members": {
- "nextToken": {},
- "storageConfigurations": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {},
- "name": {},
- "s3": {
- "shape": "S11"
- },
- "tags": {
- "shape": "S3"
- }
- }
- }
- }
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "tags"
- ],
- "members": {
- "tags": {
- "shape": "S3"
- }
- }
- }
- },
- "StartComposition": {
- "http": {
- "requestUri": "/StartComposition",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "destinations",
- "stageArn"
- ],
- "members": {
- "destinations": {
- "type": "list",
- "member": {
- "shape": "S1l"
- }
- },
- "idempotencyToken": {
- "idempotencyToken": true
- },
- "layout": {
- "shape": "S1x"
- },
- "stageArn": {},
- "tags": {
- "shape": "S3"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "composition": {
- "shape": "S1i"
- }
- }
- }
- },
- "StopComposition": {
- "http": {
- "requestUri": "/StopComposition",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "TagResource": {
- "http": {
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tags"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tags": {
- "shape": "S3"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tagKeys"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tagKeys": {
- "location": "querystring",
- "locationName": "tagKeys",
- "type": "list",
- "member": {}
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateStage": {
- "http": {
- "requestUri": "/UpdateStage",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {},
- "name": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "stage": {
- "shape": "Sx"
- }
- }
- }
- }
- },
- "shapes": {
- "S3": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "S6": {
- "type": "structure",
- "members": {
- "bitrate": {
- "type": "integer"
- },
- "framerate": {
- "type": "float"
- },
- "height": {
- "type": "integer"
- },
- "width": {
- "type": "integer"
- }
- }
- },
- "Sc": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {},
- "name": {},
- "tags": {
- "shape": "S3"
- },
- "video": {
- "shape": "S6"
- }
- }
- },
- "Sf": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "Sh": {
- "type": "list",
- "member": {}
- },
- "Sn": {
- "type": "structure",
- "members": {
- "attributes": {
- "shape": "Sf"
- },
- "capabilities": {
- "shape": "Sh"
- },
- "duration": {
- "type": "integer"
- },
- "expirationTime": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "participantId": {},
- "token": {
- "type": "string",
- "sensitive": true
- },
- "userId": {}
- }
- },
- "Sx": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "activeSessionId": {},
- "arn": {},
- "name": {},
- "tags": {
- "shape": "S3"
- }
- }
- },
- "S11": {
- "type": "structure",
- "required": [
- "bucketName"
- ],
- "members": {
- "bucketName": {}
- }
- },
- "S14": {
- "type": "structure",
- "required": [
- "arn"
- ],
- "members": {
- "arn": {},
- "name": {},
- "s3": {
- "shape": "S11"
- },
- "tags": {
- "shape": "S3"
- }
- }
- },
- "S1i": {
- "type": "structure",
- "required": [
- "arn",
- "destinations",
- "layout",
- "stageArn",
- "state"
- ],
- "members": {
- "arn": {},
- "destinations": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "configuration",
- "id",
- "state"
- ],
- "members": {
- "configuration": {
- "shape": "S1l"
- },
- "detail": {
- "type": "structure",
- "members": {
- "s3": {
- "type": "structure",
- "required": [
- "recordingPrefix"
- ],
- "members": {
- "recordingPrefix": {}
- }
- }
- }
- },
- "endTime": {
- "shape": "S1v"
- },
- "id": {},
- "startTime": {
- "shape": "S1v"
- },
- "state": {}
- }
- }
- },
- "endTime": {
- "shape": "S1v"
- },
- "layout": {
- "shape": "S1x"
- },
- "stageArn": {},
- "startTime": {
- "shape": "S1v"
- },
- "state": {},
- "tags": {
- "shape": "S3"
- }
- }
- },
- "S1l": {
- "type": "structure",
- "members": {
- "channel": {
- "type": "structure",
- "required": [
- "channelArn"
- ],
- "members": {
- "channelArn": {},
- "encoderConfigurationArn": {}
- }
- },
- "name": {},
- "s3": {
- "type": "structure",
- "required": [
- "encoderConfigurationArns",
- "storageConfigurationArn"
- ],
- "members": {
- "encoderConfigurationArns": {
- "type": "list",
- "member": {}
- },
- "recordingConfiguration": {
- "type": "structure",
- "members": {
- "format": {}
- }
- },
- "storageConfigurationArn": {}
- }
- }
- }
- },
- "S1v": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "S1x": {
- "type": "structure",
- "members": {
- "grid": {
- "type": "structure",
- "members": {
- "featuredParticipantAttribute": {},
- "gridGap": {
- "type": "integer"
- },
- "omitStoppedVideo": {
- "type": "boolean"
- },
- "videoAspectRatio": {},
- "videoFillMode": {}
- }
- },
- "pip": {
- "type": "structure",
- "members": {
- "featuredParticipantAttribute": {},
- "gridGap": {
- "type": "integer"
- },
- "omitStoppedVideo": {
- "type": "boolean"
- },
- "pipBehavior": {},
- "pipHeight": {
- "type": "integer"
- },
- "pipOffset": {
- "type": "integer"
- },
- "pipParticipantAttribute": {},
- "pipPosition": {},
- "pipWidth": {
- "type": "integer"
- },
- "videoFillMode": {}
- }
- }
- }
- }
- }
- }
|