modify_capacity_reservation¶
Operation¶
async
¶
modify_capacity_reservation(input: ModifyCapacityReservationInput, plugins: list[Plugin] | None = None) -> ModifyCapacityReservationOutput
Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. For more information, see Modify an active Capacity Reservation.
The allowed modifications depend on the state of the Capacity Reservation:
-
assessingorscheduledstate - You can modify the tags only. -
pendingstate - You can't modify the Capacity Reservation in any way. -
activestate but still within the commitment duration - You can't decrease the instance count or set an end date that is within the commitment duration. All other modifications are allowed. -
activestate with no commitment duration or elapsed commitment duration - All modifications are allowed. -
expired,cancelled,unsupported, orfailedstate - You can't modify the Capacity Reservation in any way.
For a future-dated Capacity Reservation that has not yet been delivered,
pushing out the start date requires a quote generated by
CreateCapacityReservationDateChangeQuote. For more information, see
Modify an active Capacity
Reservation
in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyCapacityReservationInput
|
An instance of |
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 |
|---|---|
ModifyCapacityReservationOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyCapacityReservationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
accept: bool | None = ...
Reserved. Capacity Reservations you have created are accepted by default.
class-attribute
instance-attribute
¶
accept_modification_terms: bool | None = ...
Indicates that you accept the modification terms of the quote identified
by QuoteId. To apply a quoted modification, set this parameter to
true.
class-attribute
instance-attribute
¶
additional_info: str | None = ...
Reserved for future use.
class-attribute
instance-attribute
¶
capacity_reservation_id: str | None = ...
The ID of the Capacity Reservation.
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.
class-attribute
instance-attribute
¶
end_date: datetime | None = ...
The date and time at which the Capacity Reservation expires. When a
Capacity Reservation expires, the reserved capacity is released and you
can no longer launch instances into it. The Capacity Reservation's
state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited. Omit
EndDate if EndDateType is unlimited.
class-attribute
instance-attribute
¶
end_date_type: str | None = ...
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
-
unlimited- The Capacity Reservation remains active until you explicitly cancel it. Do not provide anEndDatevalue ifEndDateTypeisunlimited. -
limited- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDatevalue ifEndDateTypeislimited.
class-attribute
instance-attribute
¶
instance_count: int | None = ...
The number of instances for which to reserve capacity. The number of
instances can't be increased or decreased by more than 1000 in a
single request.
class-attribute
instance-attribute
¶
instance_match_criteria: str | None = ...
The matching criteria (instance eligibility) that you want to use in the
modified Capacity Reservation. If you change the instance eligibility of
an existing Capacity Reservation from targeted to open, any running
instances that match the attributes of the Capacity Reservation, have
the CapacityReservationPreference set to open, and are not yet
running in the Capacity Reservation, will automatically use the modified
Capacity Reservation.
To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).
class-attribute
instance-attribute
¶
quote_id: str | None = ...
The ID of the quote that describes the modification you want to apply.
Generate a quote by using CreateCapacityReservationDateChangeQuote.
The quote must be in the active state, and each quote can be used only
once.
class-attribute
instance-attribute
¶
start_date: datetime | None = ...
The new start date for the Capacity Reservation, in the ISO8601 format
in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). Applies to
future-dated Capacity Reservations only. Requires a quote from
CreateCapacityReservationDateChangeQuote; pass the quote ID in
QuoteId with AcceptModificationTerms set to true.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyCapacityReservationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
The configuration that the Capacity Reservation will have after the adjustment is applied.
class-attribute
instance-attribute
¶
adjustment_status: str | None = ...
The status of the requested modification. For a description of each
possible value, see the adjustmentStatus field of the
CapacityReservation data type.
class-attribute
instance-attribute
¶
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.