describe_instance_credit_specifications¶
Operation¶
describe_instance_credit_specifications
async
¶
describe_instance_credit_specifications(request: DescribeInstanceCreditSpecificationsInput | DescribeInstanceCreditSpecificationsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeInstanceCreditSpecificationsOutput
describe_instance_credit_specifications(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceCreditSpecificationsInputDict]) -> DescribeInstanceCreditSpecificationsOutput
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 a burstable performance instance, Amazon EC2
returns the standard credit option.
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeInstanceCreditSpecificationsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeInstanceCreditSpecificationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceCreditSpecificationsInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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
class-attribute
instance-attribute
¶
The filters.
instance-id- The ID of the instance.
instance_ids
class-attribute
instance-attribute
¶
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
Dictionaries¶
DescribeInstanceCreditSpecificationsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeInstanceCreditSpecificationsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
instance-id- The ID of the instance.
instance_ids
instance-attribute
¶
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
max_results
instance-attribute
¶
max_results: int | None
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.
Output¶
DescribeInstanceCreditSpecificationsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceCreditSpecificationsOutput structure.
Attributes¶
instance_credit_specifications
class-attribute
instance-attribute
¶
instance_credit_specifications: list[InstanceCreditSpecification] | None = ...
Information about the credit option for CPU usage of an instance.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.