ModifyInstanceCreditSpecification
Modifies the credit option for CPU usage on a running or stopped burstable performance
instance. The credit options are standard
and
unlimited
.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
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.
- ClientToken
-
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
Type: String
Required: No
- DryRun
-
Checks whether you have the required permissions for the operation, 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
- InstanceCreditSpecification.N
-
Information about the credit option for CPU usage.
Type: Array of InstanceCreditSpecificationRequest objects
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- successfulInstanceCreditSpecificationSet
-
Information about the instances whose credit option for CPU usage was successfully modified.
Type: Array of SuccessfulInstanceCreditSpecificationItem objects
- unsuccessfulInstanceCreditSpecificationSet
-
Information about the instances whose credit option for CPU usage was not modified.
Type: Array of UnsuccessfulInstanceCreditSpecificationItem objects
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This request modifies the credit option for CPU usage of the specified
instance in the specified Region to unlimited
. Valid credit options
are standard
and unlimited
.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyInstanceCreditSpecification
&Region=us-east-1
&InstanceCreditSpecification.1.InstanceId=i-1234567890abcdef0
&InstanceCreditSpecification.1.CpuCredits=unlimited
&AUTHPARAMS
Sample Response
<ModifyInstanceCreditSpecificationResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>11111111-2222-3333-4444-5555EXAMPLE</requestId>
<unsuccessfulInstanceCreditSpecificationSet/>
<successfulInstanceCreditSpecificationSet>
<item>
<instanceId>i-1234567890abcdef0</instanceId>
</item>
</successfulInstanceCreditSpecificationSet>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: