Skip to content

describe_reserved_instances

Operation

describe_reserved_instances

describe_reserved_instances(request: DescribeReservedInstancesInput | DescribeReservedInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedInstancesInputDict]) -> DescribeReservedInstancesOutput

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.

Note

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Parameters:

Name Type Description Default
request DescribeReservedInstancesInput | DescribeReservedInstancesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeReservedInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeReservedInstancesOutput

An instance of DescribeReservedInstancesOutput.

describe_reserved_instances async

describe_reserved_instances(request: DescribeReservedInstancesInput | DescribeReservedInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedInstancesInputDict]) -> DescribeReservedInstancesOutput

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.

Note

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Parameters:

Name Type Description Default
request DescribeReservedInstancesInput | DescribeReservedInstancesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeReservedInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeReservedInstancesOutput

An instance of DescribeReservedInstancesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeReservedInstancesInputDict

Bases: TypedDict

Dictionary form of DescribeReservedInstancesInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • availability-zone-id - The ID of the Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:``<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

offering_class instance-attribute
offering_class: str | None

Describes whether the Reserved Instance is Standard or Convertible.

offering_type instance-attribute
offering_type: str | None

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

reserved_instances_ids instance-attribute
reserved_instances_ids: Sequence[str] | None

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

DescribeReservedInstancesInput dataclass

Bases: _SerdeShape

Contains the parameters for DescribeReservedInstances.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • availability-zone-id - The ID of the Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:``<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

offering_class class-attribute instance-attribute
offering_class: str | None = ...

Describes whether the Reserved Instance is Standard or Convertible.

offering_type class-attribute instance-attribute
offering_type: str | None = ...

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

reserved_instances_ids class-attribute instance-attribute
reserved_instances_ids: list[str] | None = ...

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Output

DescribeReservedInstancesOutput dataclass

Bases: _SerdeShape

Contains the output for DescribeReservedInstances.

Attributes

reserved_instances class-attribute instance-attribute
reserved_instances: list[ReservedInstances] | None = ...

A list of Reserved Instances.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.