R: Describe Reserved Instances Offerings

ec2_describe_reserved_instances_offerings {aws.ecx}

R Documentation

Describe Reserved Instances Offerings

Description

Describe Reserved Instances Offerings

Usage

ec2_describe_reserved_instances_offerings(
  AvailabilityZone = NULL,
  Filter = NULL,
  IncludeMarketplace = NULL,
  InstanceType = NULL,
  MaxDuration = NULL,
  MaxInstanceCount = NULL,
  MinDuration = NULL,
  OfferingClass = NULL,
  ProductDescription = NULL,
  ReservedInstancesOfferingId = NULL,
  DryRun = NULL,
  InstanceTenancy = NULL,
  MaxResults = NULL,
  NextToken = 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

`AvailabilityZone`	Character. The Availability Zone in which the Reserved Instance can be used.[optional]
`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]
`IncludeMarketplace`	Logical. Include Reserved Instance Marketplace offerings in the response.[optional]
`InstanceType`	Character. The instance type that the reservation will cover (for example, `m1.small`). For more information,...[optional]
`MaxDuration`	Integer. The maximum duration (in seconds) to filter when searching for offerings.[optional]
`MaxInstanceCount`	Integer. The maximum number of instances to filter when searching for offerings. Default: 20 [optional]
`MinDuration`	Integer. The minimum duration (in seconds) to filter when searching for offerings.[optional]
`OfferingClass`	Character. The offering class of the Reserved Instance. Can be `standard` or `convertible`.[optional]
`ProductDescription`	Character. The Reserved Instance product platform description.[optional]
`ReservedInstancesOfferingId`	List. One or more Reserved Instances offering IDs.[optional]
`DryRun`	Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
`InstanceTenancy`	Character. The tenancy of the instances covered by the reservation.[optional]
`MaxResults`	Integer. The maximum number of results to return for the request in a single page.[optional]
`NextToken`	Characters. The token for the next page of results[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

AvailabilityZone

The Availability Zone in which the Reserved Instance can be used.

Filter

One or more filters.

availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 \| 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.
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-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (⁠Availability Zone⁠ or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

IncludeMarketplace

Include Reserved Instance Marketplace offerings in the response.

InstanceType

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.

MaxDuration

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

MaxInstanceCount

The maximum number of instances to filter when searching for offerings.

Default: 20

MinDuration

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

OfferingClass

The offering class of the Reserved Instance. Can be standard or convertible.

ProductDescription

The Reserved Instance product platform description. Instances that include ⁠(Amazon VPC)⁠ in the description are for use with Amazon VPC.

ReservedInstancesOfferingId

One or more Reserved Instances offering IDs.

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.

InstanceTenancy

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

MaxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

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.

[Package aws.ecx version 1.0.5 Index]