Skip to content

Modify Instance Credit Specification

ec2_modify_instance_credit_specification R Documentation

Modifies the credit option for CPU usage on a running or stopped burstable performance instance

Description

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.

Usage

ec2_modify_instance_credit_specification(DryRun, ClientToken,
  InstanceCreditSpecifications)

Arguments

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 is UnauthorizedOperation.

ClientToken

A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

InstanceCreditSpecifications

[required] Information about the credit option for CPU usage.

Value

A list with the following syntax:

list(
  SuccessfulInstanceCreditSpecifications = list(
    list(
      InstanceId = "string"
    )
  ),
  UnsuccessfulInstanceCreditSpecifications = list(
    list(
      InstanceId = "string",
      Error = list(
        Code = "InvalidInstanceID.Malformed"|"InvalidInstanceID.NotFound"|"IncorrectInstanceState"|"InstanceCreditSpecification.NotSupported",
        Message = "string"
      )
    )
  )
)

Request syntax

svc$modify_instance_credit_specification(
  DryRun = TRUE|FALSE,
  ClientToken = "string",
  InstanceCreditSpecifications = list(
    list(
      InstanceId = "string",
      CpuCredits = "string"
    )
  )
)