AWS API Changes

2018/09/21 - AWS Elemental MediaConvert - 4 updated api methods

Changes To offer lower prices for predictable, non-urgent workloads, we propose the concept of Reserved Transcode pricing. Reserved Transcode pricing Reserved Transcoding pricing would offer the customer access to a fixed parallel processing capacity for a fixed monthly rate. This capacity would be stated in terms of number of Reserved Transcode Slots (RTSs). One RTS would be able to process one job at a time for a fixed monthly fee.

CreateQueue (updated)

Link ¶
Changes (request, response)
Request

{'PricingPlan': 'ON_DEMAND | RESERVED',
 'ReservationPlanSettings': {'Commitment': 'ONE_YEAR',
                             'RenewalType': 'AUTO_RENEW | EXPIRE',
                             'ReservedSlots': 'integer'}}

Response

{'Queue': {'PricingPlan': 'ON_DEMAND | RESERVED',
           'ReservationPlan': {'Commitment': 'ONE_YEAR',
                               'ExpiresAt': 'timestamp',
                               'PurchasedAt': 'timestamp',
                               'RenewalType': 'AUTO_RENEW | EXPIRE',
                               'ReservedSlots': 'integer',
                               'Status': 'ACTIVE | EXPIRED'}}}

Create a new transcoding queue. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

See also: AWS API Documentation

Request Syntax

client.create_queue(
    Description='string',
    Name='string',
    PricingPlan='ON_DEMAND'|'RESERVED',
    ReservationPlanSettings={
        'Commitment': 'ONE_YEAR',
        'RenewalType': 'AUTO_RENEW'|'EXPIRE',
        'ReservedSlots': 123
    },
    Tags={
        'string': 'string'
    }
)

type Description

string

param Description

Optional. A description of the queue that you are creating.

type Name

string

param Name

[REQUIRED] The name of the queue that you are creating.

type PricingPlan

string

param PricingPlan

Optional; default is on-demand. Specifies whether the pricing plan for the queue is on-demand or reserved. The pricing plan for the queue determines whether you pay on-demand or reserved pricing for the transcoding jobs you run through the queue. For reserved queue pricing, you must set up a contract. You can create a reserved queue contract through the AWS Elemental MediaConvert console.

type ReservationPlanSettings

dict

param ReservationPlanSettings

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 time that you commit to when you set up a pricing plan contract for a reserved queue.
RenewalType (string) -- [REQUIRED] Specifies whether the pricing plan contract for your reserved queue automatically renews (AUTO_RENEW) or expires (EXPIRE) at the end of the contract period.
ReservedSlots (integer) -- [REQUIRED] Specifies the number of reserved transcode slots (RTSs) 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. To increase this number, create a replacement contract through the AWS Elemental MediaConvert console.

type Tags

dict

param Tags

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) --

rtype

dict

returns

Response Syntax

{
    'Queue': {
        'Arn': 'string',
        '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'
        },
        '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/about-resource-allocation-and-job-prioritization.html.
  - Arn (string) -- An identifier for this resource that is unique within all of AWS.
  - CreatedAt (datetime) -- The time stamp in epoch seconds for queue creation.
  - Description (string) -- An optional description that you create for each queue.
  - LastUpdated (datetime) -- The time stamp in epoch seconds when the queue was last updated.
  - 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. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
  - 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 time that you commit to when you set up a pricing plan contract for a reserved queue.
    - ExpiresAt (datetime) -- The time stamp, in epoch seconds, for when the pricing plan for this reserved queue expires.
    - PurchasedAt (datetime) -- The time stamp in epoch seconds when the reserved queue's reservation plan was created.
    - RenewalType (string) -- Specifies whether the pricing plan contract for your reserved queue automatically renews (AUTO_RENEW) or expires (EXPIRE) at the end of the contract period.
    - ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTSs) 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. To increase this number, create a replacement contract through the AWS Elemental MediaConvert console.
    - Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
  - 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 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.

GetQueue (updated)

Link ¶
Changes (response)

{'Queue': {'PricingPlan': 'ON_DEMAND | RESERVED',
           'ReservationPlan': {'Commitment': 'ONE_YEAR',
                               'ExpiresAt': 'timestamp',
                               'PurchasedAt': 'timestamp',
                               'RenewalType': 'AUTO_RENEW | EXPIRE',
                               'ReservedSlots': 'integer',
                               'Status': 'ACTIVE | EXPIRED'}}}

Retrieve the JSON for a specific queue.

See also: AWS API Documentation

Request Syntax

client.get_queue(
    Name='string'
)

type Name

string

param Name

[REQUIRED] The name of the queue that you want information about.

rtype

dict

returns

Response Syntax

{
    'Queue': {
        'Arn': 'string',
        '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'
        },
        '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/about-resource-allocation-and-job-prioritization.html.
  - Arn (string) -- An identifier for this resource that is unique within all of AWS.
  - CreatedAt (datetime) -- The time stamp in epoch seconds for queue creation.
  - Description (string) -- An optional description that you create for each queue.
  - LastUpdated (datetime) -- The time stamp in epoch seconds when the queue was last updated.
  - 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. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
  - 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 time that you commit to when you set up a pricing plan contract for a reserved queue.
    - ExpiresAt (datetime) -- The time stamp, in epoch seconds, for when the pricing plan for this reserved queue expires.
    - PurchasedAt (datetime) -- The time stamp in epoch seconds when the reserved queue's reservation plan was created.
    - RenewalType (string) -- Specifies whether the pricing plan contract for your reserved queue automatically renews (AUTO_RENEW) or expires (EXPIRE) at the end of the contract period.
    - ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTSs) 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. To increase this number, create a replacement contract through the AWS Elemental MediaConvert console.
    - Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
  - 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 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.

ListQueues (updated)

Link ¶
Changes (response)

{'Queues': {'PricingPlan': 'ON_DEMAND | RESERVED',
            'ReservationPlan': {'Commitment': 'ONE_YEAR',
                                'ExpiresAt': 'timestamp',
                                'PurchasedAt': 'timestamp',
                                'RenewalType': 'AUTO_RENEW | EXPIRE',
                                'ReservedSlots': 'integer',
                                'Status': 'ACTIVE | EXPIRED'}}}

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'
)

type ListBy

string

param ListBy

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.

type MaxResults

integer

param MaxResults

Optional. Number of queues, up to twenty, that will be returned at one time.

type NextToken

string

param NextToken

Use this string, provided with the response to a previous request, to request the next batch of queues.

type Order

string

param Order

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'Queues': [
        {
            'Arn': 'string',
            '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'
            },
            'Status': 'ACTIVE'|'PAUSED',
            'SubmittedJobsCount': 123,
            'Type': 'SYSTEM'|'CUSTOM'
        },
    ]
}

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/about-resource-allocation-and-job-prioritization.html.
    - Arn (string) -- An identifier for this resource that is unique within all of AWS.
    - CreatedAt (datetime) -- The time stamp in epoch seconds for queue creation.
    - Description (string) -- An optional description that you create for each queue.
    - LastUpdated (datetime) -- The time stamp in epoch seconds when the queue was last updated.
    - 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. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
    - 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 time that you commit to when you set up a pricing plan contract for a reserved queue.
      - ExpiresAt (datetime) -- The time stamp, in epoch seconds, for when the pricing plan for this reserved queue expires.
      - PurchasedAt (datetime) -- The time stamp in epoch seconds when the reserved queue's reservation plan was created.
      - RenewalType (string) -- Specifies whether the pricing plan contract for your reserved queue automatically renews (AUTO_RENEW) or expires (EXPIRE) at the end of the contract period.
      - ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTSs) 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. To increase this number, create a replacement contract through the AWS Elemental MediaConvert console.
      - Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
    - 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 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.

UpdateQueue (updated)

Link ¶
Changes (request, response)
Request

{'ReservationPlanSettings': {'Commitment': 'ONE_YEAR',
                             'RenewalType': 'AUTO_RENEW | EXPIRE',
                             'ReservedSlots': 'integer'}}

Response

{'Queue': {'PricingPlan': 'ON_DEMAND | RESERVED',
           'ReservationPlan': {'Commitment': 'ONE_YEAR',
                               'ExpiresAt': 'timestamp',
                               'PurchasedAt': 'timestamp',
                               'RenewalType': 'AUTO_RENEW | EXPIRE',
                               'ReservedSlots': 'integer',
                               'Status': 'ACTIVE | EXPIRED'}}}

Modify one of your existing queues.

See also: AWS API Documentation

Request Syntax

client.update_queue(
    Description='string',
    Name='string',
    ReservationPlanSettings={
        'Commitment': 'ONE_YEAR',
        'RenewalType': 'AUTO_RENEW'|'EXPIRE',
        'ReservedSlots': 123
    },
    Status='ACTIVE'|'PAUSED'
)

type Description

string

param Description

The new description for the queue, if you are changing it.

type Name

string

param Name

[REQUIRED] The name of the queue that you are modifying.

type ReservationPlanSettings

dict

param ReservationPlanSettings

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 time that you commit to when you set up a pricing plan contract for a reserved queue.
RenewalType (string) -- [REQUIRED] Specifies whether the pricing plan contract for your reserved queue automatically renews (AUTO_RENEW) or expires (EXPIRE) at the end of the contract period.
ReservedSlots (integer) -- [REQUIRED] Specifies the number of reserved transcode slots (RTSs) 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. To increase this number, create a replacement contract through the AWS Elemental MediaConvert console.

type Status

string

param Status

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.

rtype

dict

returns

Response Syntax

{
    'Queue': {
        'Arn': 'string',
        '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'
        },
        '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/about-resource-allocation-and-job-prioritization.html.
  - Arn (string) -- An identifier for this resource that is unique within all of AWS.
  - CreatedAt (datetime) -- The time stamp in epoch seconds for queue creation.
  - Description (string) -- An optional description that you create for each queue.
  - LastUpdated (datetime) -- The time stamp in epoch seconds when the queue was last updated.
  - 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. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
  - 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 time that you commit to when you set up a pricing plan contract for a reserved queue.
    - ExpiresAt (datetime) -- The time stamp, in epoch seconds, for when the pricing plan for this reserved queue expires.
    - PurchasedAt (datetime) -- The time stamp in epoch seconds when the reserved queue's reservation plan was created.
    - RenewalType (string) -- Specifies whether the pricing plan contract for your reserved queue automatically renews (AUTO_RENEW) or expires (EXPIRE) at the end of the contract period.
    - ReservedSlots (integer) -- Specifies the number of reserved transcode slots (RTSs) 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. To increase this number, create a replacement contract through the AWS Elemental MediaConvert console.
    - Status (string) -- Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
  - 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 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.