Class: Aws::Deadline::Types::GetQueueResponse

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

Overview

Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.

See Also:

Constant Summary collapse

SENSITIVE = 
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_storage_profile_ids ⇒ Array<String>

The storage profile IDs for the queue.

Returns:

  • (Array<String>) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#blocked_reason ⇒ String

The reason the queue was blocked.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the resource was created.

Returns:

  • (Time) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#created_by ⇒ String

The user or system that created this resource.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#default_budget_action ⇒ String

The default action taken on a queue if a budget wasn't configured.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID for the queue.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#job_attachment_settings ⇒ Types::JobAttachmentSettings

The job attachment settings for the queue.

Returns:



4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#job_run_as_user ⇒ Types::JobRunAsUser

The jobs in the queue ran as this specified POSIX user.

Returns:



4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#queue_id ⇒ String

The queue ID.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#required_file_system_location_names ⇒ Array<String>

A list of the required file system location names in the queue.

Returns:

  • (Array<String>) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role ARN.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#scheduling_configuration ⇒ Types::SchedulingConfiguration

The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

Returns:



4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status ⇒ String

The status of the queue.

  • ACTIVE–The queue is active.

  • SCHEDULING–The queue is scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the resource was updated.

Returns:

  • (Time) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_by ⇒ String

The user or system that updated this resource.

Returns:

  • (String) 


4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4160

class GetQueueResponse < Struct.new(
  :farm_id,
  :queue_id,
  :display_name,
  :status,
  :default_budget_action,
  :blocked_reason,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :job_attachment_settings,
  :role_arn,
  :required_file_system_location_names,
  :allowed_storage_profile_ids,
  :job_run_as_user,
  :scheduling_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end