GetDefaultCreditSpecificationCommand

Suggest an Edit

Describes the default credit option for CPU usage of a burstable performance instance family.

For more information, see Burstable performance instances  in the Amazon EC2 User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, GetDefaultCreditSpecificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, GetDefaultCreditSpecificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // GetDefaultCreditSpecificationRequest
  DryRun: true || false,
  InstanceFamily: "t2" || "t3" || "t3a" || "t4g", // required
};
const command = new GetDefaultCreditSpecificationCommand(input);
const response = await client.send(command);
// { // GetDefaultCreditSpecificationResult
//   InstanceFamilyCreditSpecification: { // InstanceFamilyCreditSpecification
//     InstanceFamily: "t2" || "t3" || "t3a" || "t4g",
//     CpuCredits: "STRING_VALUE",
//   },
// };

GetDefaultCreditSpecificationCommand Input

See GetDefaultCreditSpecificationCommandInput for more details

Parameter
Type
Description
InstanceFamily
Required
UnlimitedSupportedInstanceFamily | undefined

The instance family.

DryRun
boolean | undefined

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

GetDefaultCreditSpecificationCommand Output

See GetDefaultCreditSpecificationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
InstanceFamilyCreditSpecification
InstanceFamilyCreditSpecification | undefined

The default credit option for CPU usage of the instance family.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.