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'|'NONE',
        ],
        'thumbnailConfiguration': {
            'targetIntervalSeconds': 123,
            'storage': [
                'SEQUENTIAL'|'LATEST',
            ],
            'recordingMode': 'INTERVAL'|'DISABLED'
        },
        'recordingReconnectWindowSeconds': 123,
        'hlsConfiguration': {
            'targetSegmentDurationSeconds': 123
        },
        'recordParticipantReplicas': True|False
    }
)
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. To disable individual participant recording, set this to ""; other fields in this object will get reset to their defaults when sending "".

    • mediaTypes (list) –

      Types of media to be recorded. Default: AUDIO_VIDEO.

      • (string) –

    • thumbnailConfiguration (dict) –

      A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.

      • targetIntervalSeconds (integer) –

        The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.

      • storage (list) –

        Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

        • (string) –

      • recordingMode (string) –

        Thumbnail recording mode. Default: DISABLED.

    • recordingReconnectWindowSeconds (integer) –

      If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.

      The default value is 0, which disables merging.

    • hlsConfiguration (dict) –

      HLS configuration object for individual participant recording.

      • targetSegmentDurationSeconds (integer) –

        Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.

    • recordParticipantReplicas (boolean) –

      Optional field to disable replica participant recording. If this is set to false when a participant is a replica, replica participants are not recorded. Default: true.

Return type:

dict

Returns:

Response Syntax

{
    'stage': {
        'arn': 'string',
        'name': 'string',
        'activeSessionId': 'string',
        'tags': {
            'string': 'string'
        },
        'autoParticipantRecordingConfiguration': {
            'storageConfigurationArn': 'string',
            'mediaTypes': [
                'AUDIO_VIDEO'|'AUDIO_ONLY'|'NONE',
            ],
            'thumbnailConfiguration': {
                'targetIntervalSeconds': 123,
                'storage': [
                    'SEQUENTIAL'|'LATEST',
                ],
                'recordingMode': 'INTERVAL'|'DISABLED'
            },
            'recordingReconnectWindowSeconds': 123,
            'hlsConfiguration': {
                'targetSegmentDurationSeconds': 123
            },
            'recordParticipantReplicas': True|False
        },
        '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. To disable individual participant recording, set this to ""; other fields in this object will get reset to their defaults when sending "".

        • mediaTypes (list) –

          Types of media to be recorded. Default: AUDIO_VIDEO.

          • (string) –

        • thumbnailConfiguration (dict) –

          A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.

          • targetIntervalSeconds (integer) –

            The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.

          • storage (list) –

            Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

            • (string) –

          • recordingMode (string) –

            Thumbnail recording mode. Default: DISABLED.

        • recordingReconnectWindowSeconds (integer) –

          If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.

          The default value is 0, which disables merging.

        • hlsConfiguration (dict) –

          HLS configuration object for individual participant recording.

          • targetSegmentDurationSeconds (integer) –

            Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.

        • recordParticipantReplicas (boolean) –

          Optional field to disable replica participant recording. If this is set to false when a participant is a replica, replica participants are not recorded. Default: true.

      • 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

  • ivsrealtime.Client.exceptions.ResourceNotFoundException

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException

  • ivsrealtime.Client.exceptions.ServiceQuotaExceededException

  • ivsrealtime.Client.exceptions.ConflictException

  • ivsrealtime.Client.exceptions.PendingVerification