Skip to content

EC2  >  Operations  >  modify_instance_capacity_reservation_attributes

modify_instance_capacity_reservation_attributes

Operation

modify_instance_capacity_reservation_attributes async 

modify_instance_capacity_reservation_attributes(input: ModifyInstanceCapacityReservationAttributesInput, plugins: list[Plugin] | None = None) -> ModifyInstanceCapacityReservationAttributesOutput

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, run in On-Demand Instance capacity, or only run in a Capacity Reservation.

Parameters:

Name Type Description Default
input ModifyInstanceCapacityReservationAttributesInput

An instance of ModifyInstanceCapacityReservationAttributesInput.

 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
ModifyInstanceCapacityReservationAttributesOutput

An instance of ModifyInstanceCapacityReservationAttributesOutput.

Input

ModifyInstanceCapacityReservationAttributesInput dataclass

Bases: _SerdeShape

Dataclass for ModifyInstanceCapacityReservationAttributesInput structure.

Attributes

capacity_reservation_specification class-attribute instance-attribute 
capacity_reservation_specification: CapacityReservationSpecification | None = ...

Information about the Capacity Reservation targeting option.

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.

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

The ID of the instance to be modified.

Output

ModifyInstanceCapacityReservationAttributesOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyInstanceCapacityReservationAttributesOutput 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 = ...

Returns true if the request succeeds; otherwise, it returns an error.