MediaConvert / Client / update_queue

update_queue#

MediaConvert.Client.update_queue(**kwargs)#

Modify one of your existing queues.

See also: AWS API Documentation

Request Syntax

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

  • Description (string) – The new description for the queue, if you are changing it.

  • Name (string) – [REQUIRED] The name of the queue that you are modifying.

  • ReservationPlanSettings (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.

  • Status (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.

Return type:

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/working-with-queues.html.

      • Arn (string) – An identifier for this resource that is unique within all of AWS.

      • 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.

      • 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.

Exceptions

  • MediaConvert.Client.exceptions.BadRequestException

  • MediaConvert.Client.exceptions.InternalServerErrorException

  • MediaConvert.Client.exceptions.ForbiddenException

  • MediaConvert.Client.exceptions.NotFoundException

  • MediaConvert.Client.exceptions.TooManyRequestsException

  • MediaConvert.Client.exceptions.ConflictException