Class: Aws::EC2::Types::DescribeSpotPriceHistoryRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeSpotPriceHistoryRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeSpotPriceHistoryRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  availability_zone: "String",
  dry_run: false,
  end_time: Time.now,
  instance_types: ["t1.micro"], # accepts t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.16xlarge
  max_results: 1,
  next_token: "String",
  product_descriptions: ["String"],
  start_time: Time.now,
}

Contains the parameters for DescribeSpotPriceHistory.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #availability_zone ⇒ String

  Filters the results by the specified Availability Zone.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #end_time ⇒ Time

  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-*DD*T*HH*:MM:*SS*Z).

• #filters ⇒ Array<Types::Filter>

  One or more filters.

• #instance_types ⇒ Array<String>

  Filters the results by the specified instance types.

• #max_results ⇒ Integer

  The maximum number of results to return in a single call.

• #next_token ⇒ String

  The token for the next set of results.

• #product_descriptions ⇒ Array<String>

  Filters the results by the specified basic product descriptions.

• #start_time ⇒ Time

  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-*DD*T*HH*:MM:*SS*Z).

Instance Attribute Details

#availability_zone ⇒ String

Filters the results by the specified Availability Zone.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#dry_run ⇒ Boolean

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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#end_time ⇒ Time

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-*DD*T*HH*:MM:*SS*Z).

Returns:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#filters ⇒ Array<Types::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` | `SUSE Linux` | `Windows` | `Linux/UNIX (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 timestamp of the Spot price history, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#instance_types ⇒ Array<String>

Filters the results by the specified instance types. Note that T2 and HS1 instance types are not supported.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#max_results ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#product_descriptions ⇒ Array<String>

Filters the results by the specified basic product descriptions.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end

#start_time ⇒ Time

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-*DD*T*HH*:MM:*SS*Z).

Returns:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 10113

class DescribeSpotPriceHistoryRequest < Struct.new(
  :filters,
  :availability_zone,
  :dry_run,
  :end_time,
  :instance_types,
  :max_results,
  :next_token,
  :product_descriptions,
  :start_time)
  include Aws::Structure
end