Class: Aws::Outposts::Types::StartCapacityTaskOutput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_id ⇒ String

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

Returns:

  • (String) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_task_id ⇒ String

ID of the capacity task that you want to start.

Returns:

  • (String) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_task_status ⇒ String

Status of the specified capacity task.

Returns:

  • (String) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#completion_date ⇒ Time

Date that the specified capacity task ran successfully.

Returns:

  • (Time) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

Date that the specified capacity task was created.

Returns:

  • (Time) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

Returns:

  • (Boolean) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#failed ⇒ Types::CapacityTaskFailure

Reason that the specified capacity task failed.

Returns:



2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#instances_to_exclude ⇒ Types::InstancesToExclude

User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

Returns:



2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

Date that the specified capacity task was last modified.

Returns:

  • (Time) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#order_id ⇒ String

ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

Returns:

  • (String) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_id ⇒ String

ID of the Outpost associated with the capacity task.

Returns:

  • (String) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#requested_instance_pools ⇒ Array<Types::InstanceTypeCapacity>

List of the instance pools requested in the specified capacity task.

Returns:



2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end

#task_action_on_blocking_instances ⇒ String

User-specified option in case an instance is blocking the capacity task from running.

  • WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

  • FAIL_TASK - The capacity task fails.

Returns:

  • (String) 


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 2214

class StartCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_id,
  :asset_id,
  :requested_instance_pools,
  :instances_to_exclude,
  :dry_run,
  :capacity_task_status,
  :failed,
  :creation_date,
  :completion_date,
  :last_modified_date,
  :task_action_on_blocking_instances)
  SENSITIVE = []
  include Aws::Structure
end