Skip to content

GetCapacityTaskOutput

Source code in docs_src/capo_outposts/types/get_capacity_task_output.py
class GetCapacityTaskOutput(TypedDict, closed=True):
    capacity_task_id: NotRequired["capo_outposts.types.capacity_task_id.CapacityTaskId"]
    """<p>ID of the capacity task.</p>"""
    outpost_id: NotRequired["capo_outposts.types.outpost_id.OutpostId"]
    """<p>ID of the Outpost associated with the specified capacity task.</p>"""
    order_id: NotRequired["capo_outposts.types.order_id.OrderId"]
    """<p>ID of the Amazon Web Services Outposts order associated with the specified capacity task.</p>"""
    asset_id: NotRequired["capo_outposts.types.asset_id.AssetId"]
    """<p>The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.</p>"""
    requested_instance_pools: NotRequired[
        "capo_outposts.types.requested_instance_pools.RequestedInstancePools"
    ]
    """<p>List of instance pools requested in the capacity task.</p>"""
    instances_to_exclude: NotRequired[
        "capo_outposts.types.instances_to_exclude.InstancesToExclude"
    ]
    """<p>Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.</p>"""
    dry_run: "capo_outposts.types.dry_run.DryRun"
    """<p>Performs a dry run to determine if you are above or below instance capacity.</p>"""
    capacity_task_status: NotRequired[
        "capo_outposts.types.capacity_task_status.CapacityTaskStatus"
    ]
    """<p>Status of the capacity task.</p> <p>A capacity task can have one of the following statuses:</p> <ul> <li> <p> <code>REQUESTED</code> - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.</p> </li> <li> <p> <code>IN_PROGRESS</code> - The capacity task is running and cannot be cancelled.</p> </li> <li> <p> <code>FAILED</code> - The capacity task could not be completed.</p> </li> <li> <p> <code>COMPLETED</code> - The capacity task has completed successfully.</p> </li> <li> <p> <code>WAITING_FOR_EVACUATION</code> - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.</p> </li> <li> <p> <code>CANCELLATION_IN_PROGRESS</code> - The capacity task has been cancelled and is in the process of cleaning up resources.</p> </li> <li> <p> <code>CANCELLED</code> - The capacity task is cancelled.</p> </li> </ul>"""
    failed: NotRequired["capo_outposts.types.capacity_task_failure.CapacityTaskFailure"]
    """<p>Reason why the capacity task failed.</p>"""
    creation_date: NotRequired["capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"]
    """<p>The date the capacity task was created.</p>"""
    completion_date: NotRequired[
        "capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"
    ]
    """<p>The date the capacity task ran successfully.</p>"""
    last_modified_date: NotRequired[
        "capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"
    ]
    """<p>The date the capacity task was last modified.</p>"""
    task_action_on_blocking_instances: NotRequired[
        "capo_outposts.types.task_action_on_blocking_instances.TaskActionOnBlockingInstances"
    ]
    """<p>User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:</p> <ul> <li> <p> <code>WAIT_FOR_EVACUATION</code> - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.</p> </li> <li> <p> <code>FAIL_TASK</code> - The capacity task fails.</p> </li> </ul>"""

asset_id instance-attribute

asset_id: NotRequired[AssetId]

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

capacity_task_id instance-attribute

capacity_task_id: NotRequired[CapacityTaskId]

ID of the capacity task.

capacity_task_status instance-attribute

capacity_task_status: NotRequired[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.

completion_date instance-attribute

completion_date: NotRequired[ISO8601Timestamp]

The date the capacity task ran successfully.

creation_date instance-attribute

creation_date: NotRequired[ISO8601Timestamp]

The date the capacity task was created.

dry_run instance-attribute

dry_run: DryRun

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

failed instance-attribute

failed: NotRequired[CapacityTaskFailure]

Reason why the capacity task failed.

instances_to_exclude instance-attribute

instances_to_exclude: NotRequired[InstancesToExclude]

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

last_modified_date instance-attribute

last_modified_date: NotRequired[ISO8601Timestamp]

The date the capacity task was last modified.

order_id instance-attribute

order_id: NotRequired[OrderId]

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

outpost_id instance-attribute

outpost_id: NotRequired[OutpostId]

ID of the Outpost associated with the specified capacity task.

requested_instance_pools instance-attribute

requested_instance_pools: NotRequired[RequestedInstancePools]

List of instance pools requested in the capacity task.

task_action_on_blocking_instances instance-attribute

task_action_on_blocking_instances: NotRequired[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.