create_stage ¶

def create_stage(
    self,
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    name: Optional["capo_ivs_realtime.types.stage_name.StageName"] = None,
    participant_token_configurations: Optional[
        "capo_ivs_realtime.types.participant_token_configurations.ParticipantTokenConfigurations"
    ] = None,
    tags: Optional["capo_ivs_realtime.types.tags.Tags"] = None,
    auto_participant_recording_configuration: Optional[
        "capo_ivs_realtime.types.auto_participant_recording_configuration.AutoParticipantRecordingConfiguration"
    ] = None,
) -> "capo_ivs_realtime.types.create_stage_response.CreateStageResponse":
    """<p>Creates a new stage (and optionally participant tokens).</p>

    Args:
        name: <p>Optional name that can be specified for the stage being created.</p>
        participant_token_configurations: <p>Array of participant token configuration objects to attach to the new stage.</p>
        tags: <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> 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. </p>
        auto_participant_recording_configuration: <p>Configuration object for individual participant recording, to attach to the new stage.</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.pending_verification.PendingVerification: <p>Your account is pending verification.</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.create_stage_request.CreateStageRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.create_stage_response.CreateStageResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.create_stage

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

    def _redact_output(
        output: "capo_ivs_realtime.types.create_stage_response.CreateStageResponse",
    ) -> dict[str, Any]:
        import capo_ivs_realtime.types.create_stage_response

        return capo_ivs_realtime.types.create_stage_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateStage", redact_output=_redact_output),
    )
    input_: capo_ivs_realtime.types.create_stage_request.CreateStageRequest = {}
    if name is not None:
        input_["name"] = name
    if participant_token_configurations is not None:
        input_["participant_token_configurations"] = (
            participant_token_configurations
        )
    if tags is not None:
        input_["tags"] = tags
    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