Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteIngestConfiguration

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.

Request Syntax


POST /DeleteIngestConfiguration HTTP/1.1
Content-type: application/json

{
   "arn": "string",
   "force": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

ARN of the IngestConfiguration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+

Required: Yes

force

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.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

exceptionMessage: User does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

exceptionMessage: Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

PendingVerification

exceptionMessage: Your account is pending verification.

HTTP Status Code: 403

ResourceNotFoundException

exceptionMessage: Request references a resource which does not exist.

HTTP Status Code: 404

ValidationException

exceptionMessage: The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400