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
  status: "ACTIVE", # accepts ACTIVE, PAUSED
}

Modify a queue by sending a request with the queue name and any of the following that you wish to change - description, status. You pause or activate a queue by changing its status between ACTIVE and PAUSED.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


13736
13737
13738
13739
13740
13741
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13736

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

#name ⇒ String

The name of the queue you are modifying.

Returns:

  • (String) 


13736
13737
13738
13739
13740
13741
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13736

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

#status ⇒ String

Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue will not begin. Jobs running when a queue is paused continue to run until they finish or error out.

Returns:

  • (String) 


13736
13737
13738
13739
13740
13741
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13736

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