ModifyCapacityReservation
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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- Accept
-
Reserved. Capacity Reservations you have created are accepted by default.
Type: Boolean
Required: No
- AdditionalInfo
-
Reserved for future use.
Type: String
Required: No
- CapacityReservationId
-
The ID of the Capacity Reservation.
Type: String
Required: Yes
- DryRun
-
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 isUnauthorizedOperation
.Type: Boolean
Required: No
- EndDate
-
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 ifEndDateType
islimited
. OmitEndDate
ifEndDateType
isunlimited
.Type: Timestamp
Required: No
- EndDateType
-
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 anEndDate
value ifEndDateType
isunlimited
. -
limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value ifEndDateType
islimited
.
Type: String
Valid Values:
unlimited | limited
Required: No
-
- InstanceCount
-
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.Type: Integer
Required: No
- InstanceMatchCriteria
-
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
toopen
, any running instances that match the attributes of the Capacity Reservation, have theCapacityReservationPreference
set toopen
, 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).
Type: String
Valid Values:
open | targeted
Required: No
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- return
-
Returns
true
if the request succeeds; otherwise, it returns an error.Type: Boolean
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: