Skip to content

FleetData

Source code in docs_src/capo_ec2/types/fleet_data.py
class FleetData(TypedDict, closed=True):
    activity_status: NotRequired[
        "capo_ec2.types.fleet_activity_status.FleetActivityStatus"
    ]
    """<p>The progress of the EC2 Fleet.</p> <p>For fleets of type <code>instant</code>, the status is <code>fulfilled</code> after all requests are placed, regardless of whether target capacity is met (this is the only possible status for <code>instant</code> fleets).</p> <p>For fleets of type <code>request</code> or <code>maintain</code>, the status is <code>pending_fulfillment</code> after all requests are placed, <code>fulfilled</code> when the fleet size meets or exceeds target capacity, <code>pending_termination</code> while instances are terminating when fleet size is decreased, and <code>error</code> if there's an error.</p>"""
    create_time: NotRequired["capo_ec2.types.date_time.DateTime"]
    """<p>The creation date and time of the EC2 Fleet.</p>"""
    fleet_id: NotRequired["capo_ec2.types.fleet_id.FleetId"]
    """<p>The ID of the EC2 Fleet.</p>"""
    fleet_state: NotRequired["capo_ec2.types.fleet_state_code.FleetStateCode"]
    """<p>The state of the EC2 Fleet.</p>"""
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p> <p>Constraints: Maximum 64 ASCII characters</p>"""
    excess_capacity_termination_policy: NotRequired[
        "capo_ec2.types.fleet_excess_capacity_termination_policy.FleetExcessCapacityTerminationPolicy"
    ]
    """<p>Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p> <p>Supported only for fleets of type <code>maintain</code>.</p>"""
    fulfilled_capacity: NotRequired["capo_ec2.types.double.Double"]
    """<p>The number of units fulfilled by this request compared to the set target capacity.</p>"""
    fulfilled_on_demand_capacity: NotRequired["capo_ec2.types.double.Double"]
    """<p>The number of units fulfilled by this request compared to the set target On-Demand capacity.</p>"""
    launch_template_configs: NotRequired[
        "capo_ec2.types.fleet_launch_template_config_list.FleetLaunchTemplateConfigList"
    ]
    """<p>The launch template and overrides.</p>"""
    target_capacity_specification: NotRequired[
        "capo_ec2.types.target_capacity_specification.TargetCapacitySpecification"
    ]
    """<p>The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p>"""
    terminate_instances_with_expiration: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether running instances should be terminated when the EC2 Fleet expires. </p>"""
    type: NotRequired["capo_ec2.types.fleet_type.FleetType"]
    """<p>The type of request. Indicates whether the EC2 Fleet only <code>requests</code> the target capacity, or also attempts to <code>maintain</code> it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: <code>maintain</code>.</p>"""
    valid_from: NotRequired["capo_ec2.types.date_time.DateTime"]
    """<p>The start date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The default is to start fulfilling the request immediately. </p>"""
    valid_until: NotRequired["capo_ec2.types.date_time.DateTime"]
    """<p>The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. </p>"""
    replace_unhealthy_instances: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type <code>maintain</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks">EC2 Fleet health checks</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    spot_options: NotRequired["capo_ec2.types.spot_options.SpotOptions"]
    """<p>The configuration of Spot Instances in an EC2 Fleet.</p>"""
    on_demand_options: NotRequired["capo_ec2.types.on_demand_options.OnDemandOptions"]
    """<p>The allocation strategy of On-Demand Instances in an EC2 Fleet.</p>"""
    reserved_capacity_options: NotRequired[
        "capo_ec2.types.reserved_capacity_options.ReservedCapacityOptions"
    ]
    """<p>Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to <code>reserved-capacity</code>.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags for an EC2 Fleet resource.</p>"""
    errors: NotRequired[
        "capo_ec2.types.describe_fleets_error_set.DescribeFleetsErrorSet"
    ]
    """<p>Information about the instances that could not be launched by the fleet. Valid only when <b>Type</b> is set to <code>instant</code>.</p>"""
    instances: NotRequired[
        "capo_ec2.types.describe_fleets_instances_set.DescribeFleetsInstancesSet"
    ]
    """<p>Information about the instances that were launched by the fleet. Valid only when <b>Type</b> is set to <code>instant</code>.</p>"""
    context: NotRequired["capo_ec2.types.string.String"]
    """<p>Reserved.</p>"""

activity_status instance-attribute

activity_status: NotRequired[FleetActivityStatus]

The progress of the EC2 Fleet.

For fleets of type instant, the status is fulfilled after all requests are placed, regardless of whether target capacity is met (this is the only possible status for instant fleets).

For fleets of type request or maintain, the status is pending_fulfillment after all requests are placed, fulfilled when the fleet size meets or exceeds target capacity, pending_termination while instances are terminating when fleet size is decreased, and error if there's an error.

client_token instance-attribute

client_token: NotRequired[String]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Constraints: Maximum 64 ASCII characters

context instance-attribute

context: NotRequired[String]

Reserved.

create_time instance-attribute

create_time: NotRequired[DateTime]

The creation date and time of the EC2 Fleet.

errors instance-attribute

errors: NotRequired[DescribeFleetsErrorSet]

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

excess_capacity_termination_policy instance-attribute

excess_capacity_termination_policy: NotRequired[FleetExcessCapacityTerminationPolicy]

Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

Supported only for fleets of type maintain.

fleet_id instance-attribute

fleet_id: NotRequired[FleetId]

The ID of the EC2 Fleet.

fleet_state instance-attribute

fleet_state: NotRequired[FleetStateCode]

The state of the EC2 Fleet.

fulfilled_capacity instance-attribute

fulfilled_capacity: NotRequired[Double]

The number of units fulfilled by this request compared to the set target capacity.

fulfilled_on_demand_capacity instance-attribute

fulfilled_on_demand_capacity: NotRequired[Double]

The number of units fulfilled by this request compared to the set target On-Demand capacity.

instances instance-attribute

instances: NotRequired[DescribeFleetsInstancesSet]

Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

launch_template_configs instance-attribute

launch_template_configs: NotRequired[FleetLaunchTemplateConfigList]

The launch template and overrides.

on_demand_options instance-attribute

on_demand_options: NotRequired[OnDemandOptions]

The allocation strategy of On-Demand Instances in an EC2 Fleet.

replace_unhealthy_instances instance-attribute

replace_unhealthy_instances: NotRequired[Boolean]

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.

reserved_capacity_options instance-attribute

reserved_capacity_options: NotRequired[ReservedCapacityOptions]

Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to reserved-capacity.

spot_options instance-attribute

spot_options: NotRequired[SpotOptions]

The configuration of Spot Instances in an EC2 Fleet.

tags instance-attribute

tags: NotRequired[TagList]

The tags for an EC2 Fleet resource.

target_capacity_specification instance-attribute

target_capacity_specification: NotRequired[TargetCapacitySpecification]

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

terminate_instances_with_expiration instance-attribute

terminate_instances_with_expiration: NotRequired[Boolean]

Indicates whether running instances should be terminated when the EC2 Fleet expires.

type instance-attribute

type: NotRequired[FleetType]

The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.

valid_from instance-attribute

valid_from: NotRequired[DateTime]

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

valid_until instance-attribute

valid_until: NotRequired[DateTime]

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.