ivsrealtime / Client / delete_ingest_configuration

delete_ingest_configuration#

ivsrealtime.Client.delete_ingest_configuration(**kwargs)#

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 force is set to true.

See also: AWS API Documentation

Request Syntax

response = client.delete_ingest_configuration(
    arn='string',
    force=True|False
)
Parameters:

  • arn (string) –

    [REQUIRED]

    ARN of the IngestConfiguration.

  • force (boolean) – Optional field to force deletion of the IngestConfiguration. If this is set to true when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: false.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ivsrealtime.Client.exceptions.ResourceNotFoundException

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException

  • ivsrealtime.Client.exceptions.ConflictException

  • ivsrealtime.Client.exceptions.PendingVerification