ModifyInstanceCapacityReservationAttributes
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.
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.
- CapacityReservationSpecification
-
Information about the Capacity Reservation targeting option.
Type: CapacityReservationSpecification object
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
- InstanceId
-
The ID of the instance to be modified.
Type: String
Required: Yes
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 Amazon SDKs, see the following: