DeadlineCloud / Client / delete_queue

delete_queue

DeadlineCloud.Client.delete_queue(**kwargs)

Deletes a queue.

Warning

You can’t recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.

See also: AWS API Documentation

Request Syntax

response = client.delete_queue(
    farmId='string',
    queueId='string'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The ID of the farm from which to remove the queue.

• queueId (string) –

  [REQUIRED]

  The queue ID of the queue to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ConflictException

• DeadlineCloud.Client.exceptions.ValidationException