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

Class: Aws::MediaConvert::Types::ListQueuesRequest

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 ListQueuesRequest data as a hash:

{
  list_by: "NAME", # accepts NAME, CREATION_DATE
  max_results: 1,
  next_token: "__string",
  order: "ASCENDING", # accepts ASCENDING, DESCENDING
}

You can send list queues requests with an empty body. You can optionally specify the maximum number, up to twenty, of queues to be returned.

Instance Attribute Summary collapse

Instance Attribute Details

#list_byString

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.

Returns:

  • (String)


8196
8197
8198
8199
8200
8201
8202
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8196

class ListQueuesRequest < Struct.new(
  :list_by,
  :max_results,
  :next_token,
  :order)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


8196
8197
8198
8199
8200
8201
8202
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8196

class ListQueuesRequest < Struct.new(
  :list_by,
  :max_results,
  :next_token,
  :order)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


8196
8197
8198
8199
8200
8201
8202
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8196

class ListQueuesRequest < Struct.new(
  :list_by,
  :max_results,
  :next_token,
  :order)
  include Aws::Structure
end

#orderString

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

Returns:

  • (String)


8196
8197
8198
8199
8200
8201
8202
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8196

class ListQueuesRequest < Struct.new(
  :list_by,
  :max_results,
  :next_token,
  :order)
  include Aws::Structure
end