You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaConvert::Types::UpdateQueueRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

When making an API call, you may pass UpdateQueueRequest data as a hash:

{
  description: "__string",
  name: "__string", # required
  reservation_plan_settings: {
    commitment: "ONE_YEAR", # required, accepts ONE_YEAR
    renewal_type: "AUTO_RENEW", # required, accepts AUTO_RENEW, EXPIRE
    reserved_slots: 1, # required
  },
  status: "ACTIVE", # accepts ACTIVE, PAUSED
}

Modify a queue by sending a request with the queue name and any changes to the queue.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


18386
18387
18388
18389
18390
18391
18392
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 18386

class UpdateQueueRequest < Struct.new(
  :description,
  :name,
  :reservation_plan_settings,
  :status)
  include Aws::Structure
end

#name ⇒ String

The name of the queue that you are modifying.

Returns:

  • (String) 


18386
18387
18388
18389
18390
18391
18392
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 18386

class UpdateQueueRequest < Struct.new(
  :description,
  :name,
  :reservation_plan_settings,
  :status)
  include Aws::Structure
end

#reservation_plan_settings ⇒ Types::ReservationPlanSettings

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.

Returns:



18386
18387
18388
18389
18390
18391
18392
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 18386

class UpdateQueueRequest < Struct.new(
  :description,
  :name,
  :reservation_plan_settings,
  :status)
  include Aws::Structure
end

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

Returns:

  • (String) 


18386
18387
18388
18389
18390
18391
18392
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 18386

class UpdateQueueRequest < Struct.new(
  :description,
  :name,
  :reservation_plan_settings,
  :status)
  include Aws::Structure
end