DescribeInstanceCreditSpecificationsCommand

Suggest an Edit

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

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, DescribeInstanceCreditSpecificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeInstanceCreditSpecificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeInstanceCreditSpecificationsRequest
  DryRun: true || false,
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  InstanceIds: [ // InstanceIdStringList
    "STRING_VALUE",
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeInstanceCreditSpecificationsCommand(input);
const response = await client.send(command);
// { // DescribeInstanceCreditSpecificationsResult
//   InstanceCreditSpecifications: [ // InstanceCreditSpecificationList
//     { // InstanceCreditSpecification
//       InstanceId: "STRING_VALUE",
//       CpuCredits: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeInstanceCreditSpecificationsCommand Input

See DescribeInstanceCreditSpecificationsCommandInput for more details

Parameter
Type
Description
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.

Filters
Filter[] | undefined

The filters.

  • instance-id - The ID of the instance.

InstanceIds
string[] | undefined

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

MaxResults
number | undefined

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination .

You cannot specify this parameter and the instance IDs parameter in the same call.

NextToken
string | undefined

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

DescribeInstanceCreditSpecificationsCommand Output

See DescribeInstanceCreditSpecificationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
InstanceCreditSpecifications
InstanceCreditSpecification[] | undefined

Information about the credit option for CPU usage of an instance.

NextToken
string | undefined

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Throws

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