Class: Aws::Outposts::Types::GetCapacityTaskOutput

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

#capacity_task_id ⇒ String

ID of the capacity task.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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 capacity task.

A capacity task can have one of the following statuses:

  • REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

  • IN_PROGRESS - The capacity task is running and cannot be cancelled.

  • WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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

The date the capacity task ran successfully.

Returns:

  • (Time) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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

The date the capacity task was created.

Returns:

  • (Time) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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

Performs a dry run to determine if you are above or below instance capacity.

Returns:

  • (Boolean) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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 why the capacity task failed.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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

Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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

The date the capacity task was last modified.

Returns:

  • (Time) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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 associated with the specified capacity task.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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 specified capacity task.

Returns:

  • (String) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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 instance pools requested in the capacity task.

Returns:



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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. Shows one of the following options:

  • 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) 


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/types.rb', line 779

class GetCapacityTaskOutput < Struct.new(
  :capacity_task_id,
  :outpost_id,
  :order_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