Skip to content

EC2  >  Operations  >  create_capacity_reservation_by_splitting

create_capacity_reservation_by_splitting

Operation

create_capacity_reservation_by_splitting async

create_capacity_reservation_by_splitting(request: CreateCapacityReservationBySplittingInput | CreateCapacityReservationBySplittingInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateCapacityReservationBySplittingOutput
create_capacity_reservation_by_splitting(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCapacityReservationBySplittingInputDict]) -> CreateCapacityReservationBySplittingOutput

Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be active and owned by your Amazon Web Services account.

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
CreateCapacityReservationBySplittingOutput

An instance of CreateCapacityReservationBySplittingOutput.

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

CreateCapacityReservationBySplittingInput dataclass

Bases: _SerdeShape

Dataclass for CreateCapacityReservationBySplittingInput 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.

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 to split 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 split the capacity.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the new Capacity Reservation.

Dictionaries

CreateCapacityReservationBySplittingInputDict

Bases: TypedDict

Dictionary form of CreateCapacityReservationBySplittingInput.

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.

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 to split 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 split the capacity.

tag_specifications instance-attribute
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None

The tags to apply to the new Capacity Reservation.

Output

CreateCapacityReservationBySplittingOutput dataclass

Bases: _SerdeShape

Dataclass for CreateCapacityReservationBySplittingOutput 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 in the new Capacity Reservation. The number of instances in the source Capacity Reservation was reduced by this amount.

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.