ivsrealtime / Client / update_stage
update_stage#
- ivsrealtime.Client.update_stage(**kwargs)#
Updates a stage’s configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_stage( arn='string', name='string', autoParticipantRecordingConfiguration={ 'storageConfigurationArn': 'string', 'mediaTypes': [ 'AUDIO_VIDEO'|'AUDIO_ONLY', ] } )
- Parameters:
arn (string) –
[REQUIRED]
ARN of the stage to be updated.
name (string) – Name of the stage to be updated.
autoParticipantRecordingConfiguration (dict) –
Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.
storageConfigurationArn (string) – [REQUIRED]
ARN of the StorageConfiguration resource to use for individual participant recording. Default:
""
(empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.mediaTypes (list) –
Types of media to be recorded. Default:
AUDIO_VIDEO
.(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'stage': { 'arn': 'string', 'name': 'string', 'activeSessionId': 'string', 'tags': { 'string': 'string' }, 'autoParticipantRecordingConfiguration': { 'storageConfigurationArn': 'string', 'mediaTypes': [ 'AUDIO_VIDEO'|'AUDIO_ONLY', ] }, 'endpoints': { 'events': 'string', 'whip': 'string', 'rtmp': 'string', 'rtmps': 'string' } } }
Response Structure
(dict) –
stage (dict) –
The updated stage.
arn (string) –
Stage ARN.
name (string) –
Stage name.
activeSessionId (string) –
ID of the active session within the stage.
tags (dict) –
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.(string) –
(string) –
autoParticipantRecordingConfiguration (dict) –
Configuration object for individual participant recording, attached to the stage.
storageConfigurationArn (string) –
ARN of the StorageConfiguration resource to use for individual participant recording. Default:
""
(empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.mediaTypes (list) –
Types of media to be recorded. Default:
AUDIO_VIDEO
.(string) –
endpoints (dict) –
Summary information about various endpoints for a stage.
events (string) –
Events endpoint.
whip (string) –
The endpoint to be used for IVS real-time streaming using the WHIP protocol.
rtmp (string) –
The endpoint to be used for IVS real-time streaming using the RTMP protocol.
rtmps (string) –
The endpoint to be used for IVS real-time streaming using the RTMPS protocol.
Exceptions