Skip to content

StartCapacityTaskInput

Source code in docs_src/capo_outposts/types/start_capacity_task_input.py
class StartCapacityTaskInput(TypedDict, closed=True):
    outpost_identifier: "capo_outposts.types.outpost_identifier.OutpostIdentifier"
    """<p>The ID or ARN of the Outposts associated with the specified capacity task.</p>"""
    order_id: NotRequired["capo_outposts.types.order_id.OrderId"]
    """<p>The ID of the Amazon Web Services Outposts order associated with the specified capacity task.</p>"""
    asset_id: NotRequired["capo_outposts.types.asset_id_input.AssetIdInput"]
    """<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>"""
    instance_pools: (
        "capo_outposts.types.requested_instance_pools.RequestedInstancePools"
    )
    """<p>The instance pools specified in the capacity task.</p>"""
    instances_to_exclude: NotRequired[
        "capo_outposts.types.instances_to_exclude.InstancesToExclude"
    ]
    """<p>List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.</p>"""
    dry_run: "capo_outposts.types.dry_run.DryRun"
    """<p>You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.</p>"""
    task_action_on_blocking_instances: NotRequired[
        "capo_outposts.types.task_action_on_blocking_instances.TaskActionOnBlockingInstances"
    ]
    """<p>Specify one of the following options in case an instance is blocking the capacity task from running.</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[AssetIdInput]

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

dry_run instance-attribute

dry_run: DryRun

You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

instance_pools instance-attribute

instance_pools: RequestedInstancePools

The instance pools specified in the capacity task.

instances_to_exclude instance-attribute

instances_to_exclude: NotRequired[InstancesToExclude]

List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

order_id instance-attribute

order_id: NotRequired[OrderId]

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

outpost_identifier instance-attribute

outpost_identifier: OutpostIdentifier

The ID or ARN of the Outposts associated with the specified capacity task.

task_action_on_blocking_instances instance-attribute

task_action_on_blocking_instances: NotRequired[TaskActionOnBlockingInstances]

Specify one of the following options 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.