Class: Aws::Deadline::Types::ListQueuesRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#farm_idString

The farm ID of the queue.

Returns:

  • (String)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 5407

class ListQueuesRequest < Struct.new(
  :farm_id,
  :max_results,
  :next_token,
  :principal_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

  • (Integer)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 5407

class ListQueuesRequest < Struct.new(
  :farm_id,
  :max_results,
  :next_token,
  :principal_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next set of results, or null to start from the beginning.

Returns:

  • (String)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 5407

class ListQueuesRequest < Struct.new(
  :farm_id,
  :max_results,
  :next_token,
  :principal_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#principal_idString

The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.

Returns:

  • (String)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 5407

class ListQueuesRequest < Struct.new(
  :farm_id,
  :max_results,
  :next_token,
  :principal_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the queues listed.

  • ACTIVE–The queues are active.

  • SCHEDULING–The queues are scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

Returns:

  • (String)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 5407

class ListQueuesRequest < Struct.new(
  :farm_id,
  :max_results,
  :next_token,
  :principal_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end