Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeInstanceCreditSpecifications

Describes the credit option for CPU usage of one or more of your T2 instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns only the T2 instances with the unlimited credit option. 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 T2 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 T2 Instances in the Amazon Elastic Compute Cloud 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.

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.

Type: Boolean

Required: No

Filter.N

One or more filters.

  • instance-id - The ID of the instance.

Type: Array of Filter objects

Required: No

InstanceId.N

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

Type: Array of strings

Required: No

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

Type: Integer

Required: No

NextToken

The token to retrieve the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

instanceCreditSpecificationSet

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

Type: Array of InstanceCreditSpecification objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This request describes the current credit option for CPU usage of the specified instance.

Sample Request

https://ec2.amazonaws.com/?Action=DescribeInstanceCreditSpecifications &InstanceId.1=i-1234567890abcdef0 &AUTHPARAMS

Sample Response

<DescribeInstanceCreditSpecificationsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>1b234b5c-d6ef-7gh8-90i1-j2345678901</requestId> <instanceCreditSpecificationSet> <item> <cpuCredits>unlimited</cpuCredits> <instanceId>i-1234567890abcdef0</instanceId> </item> </instanceCreditSpecificationSet> </DescribeInstanceCreditSpecificationsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: