You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

Filters the results by the specified Availability Zone.

Returns:

  • (String)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_runBoolean

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)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_timeTime

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

Returns:

  • (Time)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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

#filtersArray<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-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

Returns:



10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_typesArray<String>

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

Returns:

  • (Array<String>)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_resultsInteger

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)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_tokenString

The token for the next set of results.

Returns:

  • (String)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_descriptionsArray<String>

Filters the results by the specified basic product descriptions.

Returns:

  • (Array<String>)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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_timeTime

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

Returns:

  • (Time)


10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10088

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