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

Class: Aws::MediaConvert::Types::Queue

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::Queue

Defined in:

gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #arn ⇒ String

  An identifier for this resource that is unique within all of AWS.

• #created_at ⇒ Time

  The timestamp in epoch seconds for when you created the queue.

• #description ⇒ String

  An optional description that you create for each queue.

• #last_updated ⇒ Time

  The timestamp in epoch seconds for when you most recently updated the queue.

• #name ⇒ String

  A name that you create for each queue.

• #pricing_plan ⇒ String

  Specifies whether the pricing plan for the queue is on-demand or reserved.

• #progressing_jobs_count ⇒ Integer

  The estimated number of jobs with a PROGRESSING status.

• #reservation_plan ⇒ Types::ReservationPlan

  Details about the pricing plan for your reserved queue.

• #status ⇒ String

  Queues can be ACTIVE or PAUSED.

• #submitted_jobs_count ⇒ Integer

  The estimated number of jobs with a SUBMITTED status.

• #type ⇒ String

  Specifies whether this on-demand queue is system or custom.

Instance Attribute Details

#arn ⇒ String

An identifier for this resource that is unique within all of AWS.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp in epoch seconds for when you created the queue.

Returns:

• (Time)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#description ⇒ String

An optional description that you create for each queue.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#last_updated ⇒ Time

The timestamp in epoch seconds for when you most recently updated the queue.

Returns:

• (Time)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#name ⇒ String

A name that you create for each queue. Each name must be unique within your account.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#progressing_jobs_count ⇒ Integer

The estimated number of jobs with a PROGRESSING status.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#reservation_plan ⇒ Types::ReservationPlan

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Returns:

• (Types::ReservationPlan)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

#submitted_jobs_count ⇒ Integer

The estimated number of jobs with a SUBMITTED status.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 14846

class Queue < Struct.new(
  :arn,
  :created_at,
  :description,
  :last_updated,
  :name,
  :pricing_plan,
  :progressing_jobs_count,
  :reservation_plan,
  :status,
  :submitted_jobs_count,
  :type)
  include Aws::Structure
end