Skip to content

EC2  >  Operations  >  move_capacity_reservation_instances

move_capacity_reservation_instances

Operation

move_capacity_reservation_instances async

move_capacity_reservation_instances(request: MoveCapacityReservationInstancesInput | MoveCapacityReservationInstancesInputDict, /, *, plugins: list[Plugin] | None = None) -> MoveCapacityReservationInstancesOutput
move_capacity_reservation_instances(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[MoveCapacityReservationInstancesInputDict]) -> MoveCapacityReservationInstancesOutput

Move available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be active, owned by your Amazon Web Services account, and share the following:

  • Instance type

  • Platform

  • Availability Zone

  • Tenancy

  • Placement group

  • Capacity Reservation end time - At specific time or Manually.

Parameters:

Name Type Description Default
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
MoveCapacityReservationInstancesOutput

An instance of MoveCapacityReservationInstancesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

MoveCapacityReservationInstancesInput dataclass

Bases: _SerdeShape

Dataclass for MoveCapacityReservationInstancesInput structure.

Attributes
client_token class-attribute instance-attribute
client_token: str | None = ...

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

This field is autopopulated if not provided.

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

The ID of the Capacity Reservation that you want to move capacity into.

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_count class-attribute instance-attribute
instance_count: int | None = ...

The number of instances that you want to move from the source Capacity Reservation.

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

The ID of the Capacity Reservation from which you want to move capacity.

Dictionaries

MoveCapacityReservationInstancesInputDict

Bases: TypedDict

Dictionary form of MoveCapacityReservationInstancesInput.

Attributes
client_token instance-attribute
client_token: str | None

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

This field is autopopulated if not provided.

destination_capacity_reservation_id instance-attribute
destination_capacity_reservation_id: Required[str]

The ID of the Capacity Reservation that you want to move capacity into.

dry_run 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_count instance-attribute
instance_count: Required[int]

The number of instances that you want to move from the source Capacity Reservation.

source_capacity_reservation_id instance-attribute
source_capacity_reservation_id: Required[str]

The ID of the Capacity Reservation from which you want to move capacity.

Output

MoveCapacityReservationInstancesOutput dataclass

Bases: _SerdeShape

Dataclass for MoveCapacityReservationInstancesOutput structure.

Attributes

destination_capacity_reservation class-attribute instance-attribute
destination_capacity_reservation: CapacityReservation | None = ...

Information about the destination Capacity Reservation.

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

The number of instances that were moved from the source Capacity Reservation to the destination Capacity Reservation.

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.

source_capacity_reservation class-attribute instance-attribute
source_capacity_reservation: CapacityReservation | None = ...

Information about the source Capacity Reservation.