queues

Creates, updates, deletes, gets or lists a queues resource.

Overview

Name	queues
Type	Resource
Id	aws.mediaconvert.queues

Fields

The following fields are returned by SELECT queries:

get_queue

Name	Datatype	Description
arn	string	An identifier for this resource that is unique within all of AWS.
concurrent_jobs	integer	The maximum number of jobs your queue can process concurrently.
created_at	string (date-time)	The timestamp in epoch seconds for when you created the queue.
description	string	An optional description that you create for each queue.
last_updated	string (date-time)	The timestamp in epoch seconds for when you most recently updated the queue.
maximum_concurrent_feeds	integer	Specify the maximum number of Elemental Inference feeds MediaConvert can process concurrently.
name	string	A name that you create for each queue. Each name must be unique within your account.
pricing_plan	string	Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. (ON_DEMAND, RESERVED)
progressing_jobs_count	integer	The estimated number of jobs with a PROGRESSING status.
reservation_plan	object	Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
service_overrides	array	A list of any service overrides applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
status	string	Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error. (ACTIVE, PAUSED)
submitted_jobs_count	integer	The estimated number of jobs with a SUBMITTED status.
type	string	Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues. (SYSTEM, CUSTOM)

list_queues

Name	Datatype	Description
arn	string	An identifier for this resource that is unique within all of AWS.
concurrent_jobs	integer	The maximum number of jobs your queue can process concurrently.
created_at	string (date-time)	The timestamp in epoch seconds for when you created the queue.
description	string	An optional description that you create for each queue.
last_updated	string (date-time)	The timestamp in epoch seconds for when you most recently updated the queue.
maximum_concurrent_feeds	integer	Specify the maximum number of Elemental Inference feeds MediaConvert can process concurrently.
name	string	A name that you create for each queue. Each name must be unique within your account.
pricing_plan	string	Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. (ON_DEMAND, RESERVED)
progressing_jobs_count	integer	The estimated number of jobs with a PROGRESSING status.
reservation_plan	object	Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
service_overrides	array	A list of any service overrides applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
status	string	Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error. (ACTIVE, PAUSED)
submitted_jobs_count	integer	The estimated number of jobs with a SUBMITTED status.
type	string	Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues. (SYSTEM, CUSTOM)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue	select	name, region		Retrieve the JSON for a specific queue.
list_queues	select	region	listBy, maxResults, nextToken, order	Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.
create_queue	insert	region		Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https:​//docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html
update_queue	update	name, region		Modify one of your existing queues.
delete_queue	delete	name, region		Permanently delete a queue you have created.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the queue that you want to delete.
region	string	AWS region (default: us-east-1)
listBy	string	Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.
maxResults	integer	Optional. Number of queues, up to twenty, that will be returned at one time.
nextToken	string	Use this string, provided with the response to a previous request, to request the next batch of queues.
order	string	Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

SELECT examples

get_queue

Retrieve the JSON for a specific queue.

SELECT
arn,
concurrent_jobs,
created_at,
description,
last_updated,
maximum_concurrent_feeds,
name,
pricing_plan,
progressing_jobs_count,
reservation_plan,
service_overrides,
status,
submitted_jobs_count,
type
FROM aws.mediaconvert.queues
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_queues

Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

SELECT
arn,
concurrent_jobs,
created_at,
description,
last_updated,
maximum_concurrent_feeds,
name,
pricing_plan,
progressing_jobs_count,
reservation_plan,
service_overrides,
status,
submitted_jobs_count,
type
FROM aws.mediaconvert.queues
WHERE region = '{{ region }}' -- required
AND listBy = '{{ listBy }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND order = '{{ order }}'
;

INSERT examples

create_queue

Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html

INSERT INTO aws.mediaconvert.queues (
ConcurrentJobs,
Description,
MaximumConcurrentFeeds,
Name,
PricingPlan,
ReservationPlanSettings,
Status,
Tags,
region
)
SELECT 
{{ ConcurrentJobs }},
'{{ Description }}',
{{ MaximumConcurrentFeeds }},
'{{ Name }}',
'{{ PricingPlan }}',
'{{ ReservationPlanSettings }}',
'{{ Status }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
queue
;

Manifest

# Description fields are for documentation purposes
- name: queues
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the queues resource.
  - name: ConcurrentJobs
    value: {{ ConcurrentJobs }}
  - name: Description
    value: "{{ Description }}"
  - name: MaximumConcurrentFeeds
    value: {{ MaximumConcurrentFeeds }}
  - name: Name
    value: "{{ Name }}"
  - name: PricingPlan
    value: "{{ PricingPlan }}"
    description: |
      Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.
    valid_values: ['ON_DEMAND', 'RESERVED']
  - name: ReservationPlanSettings
    description: |
      Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
    value:
      Commitment: "{{ Commitment }}"
      RenewalType: "{{ RenewalType }}"
      ReservedSlots: {{ ReservedSlots }}
  - name: Status
    value: "{{ Status }}"
    description: |
      Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error.
    valid_values: ['ACTIVE', 'PAUSED']
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_queue

Modify one of your existing queues.

UPDATE aws.mediaconvert.queues
SET 
ConcurrentJobs = {{ ConcurrentJobs }},
Description = '{{ Description }}',
MaximumConcurrentFeeds = {{ MaximumConcurrentFeeds }},
ReservationPlanSettings = '{{ ReservationPlanSettings }}',
Status = '{{ Status }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
queue;

DELETE examples

delete_queue

Permanently delete a queue you have created.

DELETE FROM aws.mediaconvert.queues
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;