Skip to content

delete_encoder_configuration

delete_encoder_configuration(
    arn: EncoderConfigurationArn,
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> DeleteEncoderConfigurationResponse

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Parameters:

Raises:

Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
def delete_encoder_configuration(
    self,
    arn: "capo_ivs_realtime.types.encoder_configuration_arn.EncoderConfigurationArn",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.delete_encoder_configuration_response.DeleteEncoderConfigurationResponse":
    """<p>Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.</p>

    Args:
        arn: <p>ARN of the EncoderConfiguration.</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.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</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.delete_encoder_configuration_request.DeleteEncoderConfigurationRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.delete_encoder_configuration_response.DeleteEncoderConfigurationResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.delete_encoder_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteEncoderConfiguration")
    )
    input_: capo_ivs_realtime.types.delete_encoder_configuration_request.DeleteEncoderConfigurationRequest = {
        "arn": arn
    }

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