update_stage ¶

def update_stage(
    self,
    arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    name: Optional["capo_ivs_realtime.types.stage_name.StageName"] = None,
    auto_participant_recording_configuration: Optional[
        "capo_ivs_realtime.types.auto_participant_recording_configuration.AutoParticipantRecordingConfiguration"
    ] = None,
) -> "capo_ivs_realtime.types.update_stage_response.UpdateStageResponse":
    """<p>Updates a stage’s configuration.</p>

    Args:
        arn: <p>ARN of the stage to be updated.</p>
        name: <p>Name of the stage to be updated.</p>
        auto_participant_recording_configuration: <p>Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.</p>

    Raises:
        capo_ivs_realtime.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs_realtime.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_ivs_realtime.errors.pending_verification.PendingVerification: <p>Your account is pending verification.</p>
        capo_ivs_realtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_ivs_realtime.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_ivs_realtime.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs_realtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ivs_realtime.types.update_stage_request.UpdateStageRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.update_stage_response.UpdateStageResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.update_stage

        output, http_response = (
            capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.update_stage.update_stage(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateStage")
    )
    input_: capo_ivs_realtime.types.update_stage_request.UpdateStageRequest = {
        "arn": arn
    }
    if name is not None:
        input_["name"] = name
    if auto_participant_recording_configuration is not None:
        input_["auto_participant_recording_configuration"] = (
            auto_participant_recording_configuration
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output