delete_ingest_configuration ¶

def delete_ingest_configuration(
    self,
    arn: "capo_ivs_realtime.types.ingest_configuration_arn.IngestConfigurationArn",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    force: Optional["capo_ivs_realtime.types.boolean.Boolean"] = None,
) -> "capo_ivs_realtime.types.delete_ingest_configuration_response.DeleteIngestConfigurationResponse":
    """<p>Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless <code>force</code> is set to <code>true</code>.</p>

    Args:
        arn: <p>ARN of the IngestConfiguration.</p>
        force: <p>Optional field to force deletion of the IngestConfiguration. If this is set to <code>true</code> when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: <code>false</code>.</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_ingest_configuration_request.DeleteIngestConfigurationRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.delete_ingest_configuration_response.DeleteIngestConfigurationResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.delete_ingest_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIngestConfiguration")
    )
    input_: capo_ivs_realtime.types.delete_ingest_configuration_request.DeleteIngestConfigurationRequest = {
        "arn": arn
    }
    if force is not None:
        input_["force"] = force

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