Skip to content

delete_stage

delete_stage(
    arn: StageArn, *, config_overrides: Optional[IVSRealTimeClientConfig] = None
) -> DeleteStageResponse

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

Parameters:

  • arn (StageArn) –

    ARN of the stage to be deleted.

Raises:

Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
def delete_stage(
    self,
    arn: "capo_ivs_realtime.types.stage_arn.StageArn",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.delete_stage_response.DeleteStageResponse":
    """<p>Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the <code>stageArn</code> from the associated <a>IngestConfiguration</a>, if there are participants using the IngestConfiguration to publish to the stage.</p>

    Args:
        arn: <p>ARN of the stage to be deleted.</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.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.delete_stage_request.DeleteStageRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.delete_stage_response.DeleteStageResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.delete_stage

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteStage")
    )
    input_: capo_ivs_realtime.types.delete_stage_request.DeleteStageRequest = {
        "arn": arn
    }

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