Skip to content

EC2  >  Operations  >  modify_spot_fleet_request

modify_spot_fleet_request

Operation

modify_spot_fleet_request async

modify_spot_fleet_request(input: ModifySpotFleetRequestInput, plugins: list[Plugin] | None = None) -> ModifySpotFleetRequestOutput

Modifies the specified Spot Fleet request.

You can only modify a Spot Fleet request of type maintain.

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

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

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot 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 Spot Fleet for now, but will use it again later, you can set the target capacity to 0.

Parameters:

Name Type Description Default
input ModifySpotFleetRequestInput

An instance of ModifySpotFleetRequestInput.

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
ModifySpotFleetRequestOutput

An instance of ModifySpotFleetRequestOutput.

Input

ModifySpotFleetRequestInput dataclass

Bases: _SerdeShape

Contains the parameters for ModifySpotFleetRequest.

Attributes

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

Reserved.

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

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

Supported only for fleets of type maintain.

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

The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.

on_demand_target_capacity class-attribute instance-attribute
on_demand_target_capacity: int | None = ...

The number of On-Demand Instances in the fleet.

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

The ID of the Spot Fleet request.

target_capacity class-attribute instance-attribute
target_capacity: int | None = ...

The size of the fleet.

Output

ModifySpotFleetRequestOutput dataclass

Bases: _SerdeShape

Contains the output of ModifySpotFleetRequest.

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.