QueueAction
The action to perform on the queue. Specify one of the following actions:
cancel
- cancel the queued action specified by theToken
parameter. Use this option to cancel an action that has not started processing.changePriority
- change the priority of the queued action specified by theToken
parameter. To find the current priority of a queued action, useQueueAction=getStatus
.duplicate
- make a copy of the pending or running action specified by theToken
parameter, and add it to the queue. You cannot duplicate a completed action.getActionParameters
- returns the action parameters that were passed to the action specified by theToken
parameter, or all pending and running actions in the queue specified by theQueueName
parameter whenToken
is not set. You cannot retrieve the parameters passed to completed actions.getStatus
- get the status of the action specified by theToken
parameter, or the entire queue specified by theQueueName
parameter whenToken
is not set.pause
- pause the action specified by theToken
parameter (if the action supports pausing), or pause the queue specified by theQueueName
parameter whenToken
is not set. Pausing a queue pauses all running actions (if they support pausing) and prevents queued actions from starting. The number of actions that can run concurrently from each queue is set by the parameterMaximumThreads
. If you pause this number of actions (or paused the queue), the actions remaining in the queue are blocked and cannot start.progress
- return the progress of a running action (for example, 50% complete), and the progress of each stage if the action is divided into multiple stages.queueStatus
- return whether the queue is paused, and return the numbers of pending, running, and completed actions.resume
- resume the paused action specified by theToken
parameter, or resume the paused queue specified by theQueueName
parameter whenToken
is not set. Resuming a queue also resumes any paused actions. Resuming an action in a paused queue allows that action to resume but other actions do not start.stop
- stop the running action specified by theToken
parameter (if the action supports stopping). Use this option to stop an action that has started processing.
Actions: | QueueInfo |
Type: | String |
Default: | |
Example: | &QueueAction=getStatus
|
See Also: |