ec2_describe_spot_price_history {aws.ecx}

Describe Spot Price History

Description

Describe Spot Price History

Usage

ec2_describe_spot_price_history(
  Filter = NULL,
  AvailabilityZone = NULL,
  DryRun = NULL,
  EndTime = NULL,
  InstanceType = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  ProductDescription = NULL,
  StartTime = 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]

AvailabilityZone

Character. Filters the results by the specified Availability Zone.[optional]

DryRun

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

EndTime

Character. The date and time, up to the current date, from which to stop retrieving the price history data,...[optional]

InstanceType

List. Filters the results by the specified instance types.[optional]

MaxResults

Integer. The maximum number of results to return in a single call.[optional]

NextToken

Characters. The token for the next page of results[optional]

ProductDescription

List. Filters the results by the specified basic product descriptions.[optional]

StartTime

Character. The date and time, up to the past 90 days, from which to start retrieving the price history data,...[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 for which prices should be returned.

• instance-type - The type of instance (for example, m3.medium).

• product-description - The product description for the Spot price (Linux/UNIX \| ⁠Red Hat Enterprise Linux⁠ \| ⁠SUSE Linux⁠ \| Windows \| ⁠Linux/UNIX (Amazon VPC)⁠ \| ⁠Red Hat Enterprise Linux (Amazon VPC)⁠ \| ⁠SUSE Linux (Amazon VPC)⁠ \| ⁠Windows (Amazon VPC)⁠).

• spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

• timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (\* and ?). Greater than or less than comparison is not supported.

AvailabilityZone

Filters the results by the specified Availability Zone.

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.

EndTime

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

InstanceType

Filters the results by the specified instance types.

MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

ProductDescription

Filters the results by the specified basic product descriptions.

StartTime

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).