2024/11/20 - AWS Elemental MediaConvert - 4 updated api methods
Changes This release adds the ability to reconfigure concurrent job settings for existing queues and create queues with custom concurrent job settings.
{'ConcurrentJobs': 'integer'}
Response {'Queue': {'ConcurrentJobs': 'integer',
'ServiceOverrides': [{'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'}]}}
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
See also: AWS API Documentation
Request Syntax
client.create_queue(
ConcurrentJobs=123,
Description='string',
Name='string',
PricingPlan='ON_DEMAND'|'RESERVED',
ReservationPlanSettings={
'Commitment': 'ONE_YEAR',
'RenewalType': 'AUTO_RENEW'|'EXPIRE',
'ReservedSlots': 123
},
Status='ACTIVE'|'PAUSED',
Tags={
'string': 'string'
}
)
integer
Specify the maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead.
string
Optional. A description of the queue that you are creating.
string
[REQUIRED] The name of the queue that you are creating.
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. When you use the API to create a queue, the default is on-demand.
dict
Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
Commitment (string) -- [REQUIRED] The length of the term of your reserved queue pricing plan commitment.
RenewalType (string) -- [REQUIRED] Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment.
ReservedSlots (integer) -- [REQUIRED] Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.
string
Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.
dict
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
(string) --
(string) --
dict
Response Syntax
{
'Queue': {
'Arn': 'string',
'ConcurrentJobs': 123,
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'LastUpdated': datetime(2015, 1, 1),
'Name': 'string',
'PricingPlan': 'ON_DEMAND'|'RESERVED',
'ProgressingJobsCount': 123,
'ReservationPlan': {
'Commitment': 'ONE_YEAR',
'ExpiresAt': datetime(2015, 1, 1),
'PurchasedAt': datetime(2015, 1, 1),
'RenewalType': 'AUTO_RENEW'|'EXPIRE',
'ReservedSlots': 123,
'Status': 'ACTIVE'|'EXPIRED'
},
'ServiceOverrides': [
{
'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'
},
],
'Status': 'ACTIVE'|'PAUSED',
'SubmittedJobsCount': 123,
'Type': 'SYSTEM'|'CUSTOM'
}
}
Response Structure
(dict) --
Queue (dict) -- You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
Arn (string) -- An identifier for this resource that is unique within all of AWS.
ConcurrentJobs (integer) -- The maximum number of jobs your queue can process concurrently.
CreatedAt (datetime) -- The timestamp in epoch seconds for when you created the queue.
Description (string) -- An optional description that you create for each queue.
LastUpdated (datetime) -- The timestamp in epoch seconds for when you most recently updated the queue.
Name (string) -- A name that you create for each queue. Each name must be unique within your account.
PricingPlan (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.
ProgressingJobsCount (integer) -- The estimated number of jobs with a PROGRESSING status.
ReservationPlan (dict) -- Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
Commitment (string) -- The length of the term of your reserved queue pricing plan commitment.
ExpiresAt (datetime) -- The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.
PurchasedAt (datetime) -- The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.
RenewalType (string) -- Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.
ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.
Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
ServiceOverrides (list) -- 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.
(dict) -- A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
Message (string) -- Details about the service override that MediaConvert has applied.
Name (string) -- The name of the setting that MediaConvert has applied an override to.
OverrideValue (string) -- The current value of the service override that MediaConvert has applied.
Value (string) -- The value of the setting that you configured, prior to any overrides that MediaConvert has applied.
Status (string) -- Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
SubmittedJobsCount (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.
{'Queue': {'ConcurrentJobs': 'integer',
'ServiceOverrides': [{'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'}]}}
Retrieve the JSON for a specific queue.
See also: AWS API Documentation
Request Syntax
client.get_queue(
Name='string'
)
string
[REQUIRED] The name of the queue that you want information about.
dict
Response Syntax
{
'Queue': {
'Arn': 'string',
'ConcurrentJobs': 123,
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'LastUpdated': datetime(2015, 1, 1),
'Name': 'string',
'PricingPlan': 'ON_DEMAND'|'RESERVED',
'ProgressingJobsCount': 123,
'ReservationPlan': {
'Commitment': 'ONE_YEAR',
'ExpiresAt': datetime(2015, 1, 1),
'PurchasedAt': datetime(2015, 1, 1),
'RenewalType': 'AUTO_RENEW'|'EXPIRE',
'ReservedSlots': 123,
'Status': 'ACTIVE'|'EXPIRED'
},
'ServiceOverrides': [
{
'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'
},
],
'Status': 'ACTIVE'|'PAUSED',
'SubmittedJobsCount': 123,
'Type': 'SYSTEM'|'CUSTOM'
}
}
Response Structure
(dict) --
Queue (dict) -- You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
Arn (string) -- An identifier for this resource that is unique within all of AWS.
ConcurrentJobs (integer) -- The maximum number of jobs your queue can process concurrently.
CreatedAt (datetime) -- The timestamp in epoch seconds for when you created the queue.
Description (string) -- An optional description that you create for each queue.
LastUpdated (datetime) -- The timestamp in epoch seconds for when you most recently updated the queue.
Name (string) -- A name that you create for each queue. Each name must be unique within your account.
PricingPlan (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.
ProgressingJobsCount (integer) -- The estimated number of jobs with a PROGRESSING status.
ReservationPlan (dict) -- Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
Commitment (string) -- The length of the term of your reserved queue pricing plan commitment.
ExpiresAt (datetime) -- The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.
PurchasedAt (datetime) -- The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.
RenewalType (string) -- Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.
ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.
Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
ServiceOverrides (list) -- 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.
(dict) -- A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
Message (string) -- Details about the service override that MediaConvert has applied.
Name (string) -- The name of the setting that MediaConvert has applied an override to.
OverrideValue (string) -- The current value of the service override that MediaConvert has applied.
Value (string) -- The value of the setting that you configured, prior to any overrides that MediaConvert has applied.
Status (string) -- Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
SubmittedJobsCount (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.
{'Queues': {'ConcurrentJobs': 'integer',
'ServiceOverrides': [{'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'}]},
'TotalConcurrentJobs': 'integer',
'UnallocatedConcurrentJobs': 'integer'}
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.
See also: AWS API Documentation
Request Syntax
client.list_queues(
ListBy='NAME'|'CREATION_DATE',
MaxResults=123,
NextToken='string',
Order='ASCENDING'|'DESCENDING'
)
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.
integer
Optional. Number of queues, up to twenty, that will be returned at one time.
string
Use this string, provided with the response to a previous request, to request the next batch of queues.
string
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
dict
Response Syntax
{
'NextToken': 'string',
'Queues': [
{
'Arn': 'string',
'ConcurrentJobs': 123,
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'LastUpdated': datetime(2015, 1, 1),
'Name': 'string',
'PricingPlan': 'ON_DEMAND'|'RESERVED',
'ProgressingJobsCount': 123,
'ReservationPlan': {
'Commitment': 'ONE_YEAR',
'ExpiresAt': datetime(2015, 1, 1),
'PurchasedAt': datetime(2015, 1, 1),
'RenewalType': 'AUTO_RENEW'|'EXPIRE',
'ReservedSlots': 123,
'Status': 'ACTIVE'|'EXPIRED'
},
'ServiceOverrides': [
{
'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'
},
],
'Status': 'ACTIVE'|'PAUSED',
'SubmittedJobsCount': 123,
'Type': 'SYSTEM'|'CUSTOM'
},
],
'TotalConcurrentJobs': 123,
'UnallocatedConcurrentJobs': 123
}
Response Structure
(dict) --
NextToken (string) -- Use this string to request the next batch of queues.
Queues (list) -- List of queues.
(dict) -- You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
Arn (string) -- An identifier for this resource that is unique within all of AWS.
ConcurrentJobs (integer) -- The maximum number of jobs your queue can process concurrently.
CreatedAt (datetime) -- The timestamp in epoch seconds for when you created the queue.
Description (string) -- An optional description that you create for each queue.
LastUpdated (datetime) -- The timestamp in epoch seconds for when you most recently updated the queue.
Name (string) -- A name that you create for each queue. Each name must be unique within your account.
PricingPlan (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.
ProgressingJobsCount (integer) -- The estimated number of jobs with a PROGRESSING status.
ReservationPlan (dict) -- Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
Commitment (string) -- The length of the term of your reserved queue pricing plan commitment.
ExpiresAt (datetime) -- The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.
PurchasedAt (datetime) -- The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.
RenewalType (string) -- Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.
ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.
Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
ServiceOverrides (list) -- 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.
(dict) -- A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
Message (string) -- Details about the service override that MediaConvert has applied.
Name (string) -- The name of the setting that MediaConvert has applied an override to.
OverrideValue (string) -- The current value of the service override that MediaConvert has applied.
Value (string) -- The value of the setting that you configured, prior to any overrides that MediaConvert has applied.
Status (string) -- Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
SubmittedJobsCount (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.
TotalConcurrentJobs (integer) -- The maximum number of jobs that MediaConvert can process at one time, across all of your on-demand queues in the current AWS Region.
UnallocatedConcurrentJobs (integer) -- The remaining number of concurrent jobs that are not associated with a queue and are available to allocate to a queue. You can allocate these jobs when you create or update a queue.
{'ConcurrentJobs': 'integer'}
Response {'Queue': {'ConcurrentJobs': 'integer',
'ServiceOverrides': [{'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'}]}}
Modify one of your existing queues.
See also: AWS API Documentation
Request Syntax
client.update_queue(
ConcurrentJobs=123,
Description='string',
Name='string',
ReservationPlanSettings={
'Commitment': 'ONE_YEAR',
'RenewalType': 'AUTO_RENEW'|'EXPIRE',
'ReservedSlots': 123
},
Status='ACTIVE'|'PAUSED'
)
integer
Specify the maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, update your reservation plan instead in order to increase your yearly commitment.
string
The new description for the queue, if you are changing it.
string
[REQUIRED] The name of the queue that you are modifying.
dict
The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.
Commitment (string) -- [REQUIRED] The length of the term of your reserved queue pricing plan commitment.
RenewalType (string) -- [REQUIRED] Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment.
ReservedSlots (integer) -- [REQUIRED] Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.
string
Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
dict
Response Syntax
{
'Queue': {
'Arn': 'string',
'ConcurrentJobs': 123,
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'LastUpdated': datetime(2015, 1, 1),
'Name': 'string',
'PricingPlan': 'ON_DEMAND'|'RESERVED',
'ProgressingJobsCount': 123,
'ReservationPlan': {
'Commitment': 'ONE_YEAR',
'ExpiresAt': datetime(2015, 1, 1),
'PurchasedAt': datetime(2015, 1, 1),
'RenewalType': 'AUTO_RENEW'|'EXPIRE',
'ReservedSlots': 123,
'Status': 'ACTIVE'|'EXPIRED'
},
'ServiceOverrides': [
{
'Message': 'string',
'Name': 'string',
'OverrideValue': 'string',
'Value': 'string'
},
],
'Status': 'ACTIVE'|'PAUSED',
'SubmittedJobsCount': 123,
'Type': 'SYSTEM'|'CUSTOM'
}
}
Response Structure
(dict) --
Queue (dict) -- You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
Arn (string) -- An identifier for this resource that is unique within all of AWS.
ConcurrentJobs (integer) -- The maximum number of jobs your queue can process concurrently.
CreatedAt (datetime) -- The timestamp in epoch seconds for when you created the queue.
Description (string) -- An optional description that you create for each queue.
LastUpdated (datetime) -- The timestamp in epoch seconds for when you most recently updated the queue.
Name (string) -- A name that you create for each queue. Each name must be unique within your account.
PricingPlan (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.
ProgressingJobsCount (integer) -- The estimated number of jobs with a PROGRESSING status.
ReservationPlan (dict) -- Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
Commitment (string) -- The length of the term of your reserved queue pricing plan commitment.
ExpiresAt (datetime) -- The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.
PurchasedAt (datetime) -- The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.
RenewalType (string) -- Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.
ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.
Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
ServiceOverrides (list) -- 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.
(dict) -- A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
Message (string) -- Details about the service override that MediaConvert has applied.
Name (string) -- The name of the setting that MediaConvert has applied an override to.
OverrideValue (string) -- The current value of the service override that MediaConvert has applied.
Value (string) -- The value of the setting that you configured, prior to any overrides that MediaConvert has applied.
Status (string) -- Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
SubmittedJobsCount (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.