Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateStage

Creates a new stage (and optionally participant tokens).

Request Syntax


POST /CreateStage HTTP/1.1
Content-type: application/json

{
   "autoParticipantRecordingConfiguration": { 
      "mediaTypes": [ "string" ],
      "storageConfigurationArn": "string",
      "thumbnailConfiguration": { 
         "recordingMode": "string",
         "storage": [ "string" ],
         "targetIntervalSeconds": number
      }
   },
   "name": "string",
   "participantTokenConfigurations": [ 
      { 
         "attributes": { 
            "string" : "string" 
         },
         "capabilities": [ "string" ],
         "duration": number,
         "userId": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

autoParticipantRecordingConfiguration

Configuration object for individual participant recording, to attach to the new stage.

Type: AutoParticipantRecordingConfiguration object

Required: No

name

Optional name that can be specified for the stage being created.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

participantTokenConfigurations

Array of participant token configuration objects to attach to the new stage.

Type: Array of ParticipantTokenConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "participantTokens": [ 
      { 
         "attributes": { 
            "string" : "string" 
         },
         "capabilities": [ "string" ],
         "duration": number,
         "expirationTime": "string",
         "participantId": "string",
         "token": "string",
         "userId": "string"
      }
   ],
   "stage": { 
      "activeSessionId": "string",
      "arn": "string",
      "autoParticipantRecordingConfiguration": { 
         "mediaTypes": [ "string" ],
         "storageConfigurationArn": "string",
         "thumbnailConfiguration": { 
            "recordingMode": "string",
            "storage": [ "string" ],
            "targetIntervalSeconds": number
         }
      },
      "endpoints": { 
         "events": "string",
         "rtmp": "string",
         "rtmps": "string",
         "whip": "string"
      },
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

participantTokens

Participant tokens attached to the stage. These correspond to the participants in the request.

Type: Array of ParticipantToken objects

stage

The stage that was created.

Type: Stage object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

PendingVerification

HTTP Status Code: 403

ServiceQuotaExceededException

HTTP Status Code: 402

ValidationException

HTTP Status Code: 400