Skip to content

EC2  >  Operations  >  modify_fleet

modify_fleet

Operation

modify_fleet async

modify_fleet(input: ModifyFleetInput, plugins: list[Plugin] | None = None) -> ModifyFleetOutput

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type maintain.

While the EC2 Fleet is being modified, it is in the modifying state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

Parameters:

Name Type Description Default
input ModifyFleetInput

An instance of ModifyFleetInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyFleetOutput

An instance of ModifyFleetOutput.

Input

ModifyFleetInput dataclass

Bases: _SerdeShape

Dataclass for ModifyFleetInput structure.

Attributes

context class-attribute instance-attribute
context: str | None = ...

Reserved.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

excess_capacity_termination_policy class-attribute instance-attribute
excess_capacity_termination_policy: str | None = ...

Indicates whether running instances should be terminated if the total 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 class-attribute instance-attribute
fleet_id: str | None = ...

The ID of the EC2 Fleet.

launch_template_configs class-attribute instance-attribute
launch_template_configs: list[FleetLaunchTemplateConfigRequest] | None = ...

The launch template and overrides.

target_capacity_specification class-attribute instance-attribute
target_capacity_specification: TargetCapacitySpecificationRequest | None = ...

The size of the EC2 Fleet.

Output

ModifyFleetOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyFleetOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_ class-attribute instance-attribute
return_: bool | None = ...

If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.