Struct GetCapacityTaskOutput

#[non_exhaustive]
pub struct GetCapacityTaskOutput {

    pub capacity_task_id: Option<String>,
    pub outpost_id: Option<String>,
    pub order_id: Option<String>,
    pub asset_id: Option<String>,
    pub requested_instance_pools: Option<Vec<InstanceTypeCapacity>>,
    pub instances_to_exclude: Option<InstancesToExclude>,
    pub dry_run: bool,
    pub capacity_task_status: Option<CapacityTaskStatus>,
    pub failed: Option<CapacityTaskFailure>,
    pub creation_date: Option<DateTime>,
    pub completion_date: Option<DateTime>,
    pub last_modified_date: Option<DateTime>,
    pub task_action_on_blocking_instances: Option<TaskActionOnBlockingInstances>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

capacity_task_id: Option<String>

ID of the capacity task.

outpost_id: Option<String>

ID of the Outpost associated with the specified capacity task.

order_id: Option<String>

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

asset_id: Option<String>

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

requested_instance_pools: Option<Vec<InstanceTypeCapacity>>

List of instance pools requested in the capacity task.

instances_to_exclude: Option<InstancesToExclude>

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

dry_run: bool

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

capacity_task_status: Option<CapacityTaskStatus>

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.

• FAILED - The capacity task could not be completed.

• COMPLETED - The capacity task has completed successfully.

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

• CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

• CANCELLED - The capacity task is cancelled.

failed: Option<CapacityTaskFailure>

Reason why the capacity task failed.

creation_date: Option<DateTime>

The date the capacity task was created.

completion_date: Option<DateTime>

The date the capacity task ran successfully.

last_modified_date: Option<DateTime>

The date the capacity task was last modified.

task_action_on_blocking_instances: Option<TaskActionOnBlockingInstances>

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.

Implementations

impl GetCapacityTaskOutput

pub fn capacity_task_id(&self) -> Option<&str>

ID of the capacity task.

pub fn outpost_id(&self) -> Option<&str>

ID of the Outpost associated with the specified capacity task.

pub fn order_id(&self) -> Option<&str>

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

pub fn asset_id(&self) -> Option<&str>

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

pub fn requested_instance_pools(&self) -> &[InstanceTypeCapacity]

List of instance pools requested in the capacity task.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .requested_instance_pools.is_none().

pub fn instances_to_exclude(&self) -> Option<&InstancesToExclude>

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

pub fn dry_run(&self) -> bool

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

pub fn capacity_task_status(&self) -> Option<&CapacityTaskStatus>

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.

• FAILED - The capacity task could not be completed.

• COMPLETED - The capacity task has completed successfully.

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

• CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

• CANCELLED - The capacity task is cancelled.

pub fn failed(&self) -> Option<&CapacityTaskFailure>

Reason why the capacity task failed.

pub fn creation_date(&self) -> Option<&DateTime>

The date the capacity task was created.

pub fn completion_date(&self) -> Option<&DateTime>

The date the capacity task ran successfully.

pub fn last_modified_date(&self) -> Option<&DateTime>

The date the capacity task was last modified.

pub fn task_action_on_blocking_instances( &self, ) -> Option<&TaskActionOnBlockingInstances>

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.

impl GetCapacityTaskOutput

pub fn builder() -> GetCapacityTaskOutputBuilder

Creates a new builder-style object to manufacture GetCapacityTaskOutput.

Trait Implementations

impl Clone for GetCapacityTaskOutput

fn clone(&self) -> GetCapacityTaskOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetCapacityTaskOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetCapacityTaskOutput

fn eq(&self, other: &GetCapacityTaskOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetCapacityTaskOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetCapacityTaskOutput