Stage - Amazon IVS

Stage

Object specifying a stage.

Contents

arn

Stage ARN.

Type: String

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

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+

Required: Yes

activeSessionId

ID of the active session within the stage.

Type: String

Length Constraints: Fixed length of 16.

Pattern: st-[a-zA-Z0-9]+

Required: No

autoParticipantRecordingConfiguration

Configuration object for individual participant recording, attached to the stage.

Type: AutoParticipantRecordingConfiguration object

Required: No

endpoints

Summary information about various endpoints for a stage.

Type: StageEndpoints object

Required: No

name

Stage name.

Type: String

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

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

Required: No

tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: