ParallelComputingService / Client / delete_queue

delete_queue#

ParallelComputingService.Client.delete_queue(**kwargs)#

Deletes a job queue. If the compute node group associated with this queue isn’t associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.

See also: AWS API Documentation

Request Syntax

response = client.delete_queue(
    clusterIdentifier='string',
    queueIdentifier='string',
    clientToken='string'
)
Parameters:

  • clusterIdentifier (string) –

    [REQUIRED]

    The name or ID of the cluster of the queue.

  • queueIdentifier (string) –

    [REQUIRED]

    The name or ID of the queue to delete.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions