ec2_describe_reserved_instances {aws.ecx}

Describe Reserved Instances

Description

Describe Reserved Instances

Usage

ec2_describe_reserved_instances(
  Filter = NULL,
  OfferingClass = NULL,
  ReservedInstancesId = NULL,
  DryRun = NULL,
  OfferingType = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

OfferingClass

Character. Describes whether the Reserved Instance is Standard or Convertible.[optional]

ReservedInstancesId

List. One or more Reserved Instance IDs.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

OfferingType

Character. The Reserved Instance offering type.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

Filter

One or more filters.

• availability-zone - 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. Instances that include ⁠(Amazon VPC)⁠ in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX \| ⁠Linux/UNIX (Amazon VPC)⁠ \| ⁠SUSE Linux⁠ \| ⁠SUSE Linux (Amazon VPC)⁠ \| ⁠Red Hat Enterprise Linux⁠ \| ⁠Red Hat Enterprise Linux (Amazon VPC)⁠ \| Windows \| ⁠Windows (Amazon VPC)⁠ \| ⁠Windows with SQL Server Standard⁠ \| ⁠Windows with SQL Server Standard (Amazon VPC)⁠ \| ⁠Windows with SQL Server Web⁠ \| ⁠Windows with SQL Server Web (Amazon VPC)⁠ \| ⁠Windows with SQL Server Enterprise⁠ \| ⁠Windows with SQL Server Enterprise (Amazon VPC)⁠).

• 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:\ - 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).

OfferingClass

Describes whether the Reserved Instance is Standard or Convertible.

ReservedInstancesId

One or more Reserved Instance IDs.

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

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.

OfferingType

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.