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

Class: Aws::EC2::Types::DescribeReservedInstancesRequest

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 DescribeReservedInstancesRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  offering_class: "standard", # accepts standard, convertible
  reserved_instances_ids: ["String"],
  dry_run: false,
  offering_type: "Heavy Utilization", # accepts Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
}

Contains the parameters for DescribeReservedInstances.

Instance Attribute Summary collapse

Instance Attribute Details

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


9055
9056
9057
9058
9059
9060
9061
9062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9055

class DescribeReservedInstancesRequest < Struct.new(
  :filters,
  :offering_class,
  :reserved_instances_ids,
  :dry_run,
  :offering_type)
  include Aws::Structure
end

#filtersArray<Types::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:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

Returns:



9055
9056
9057
9058
9059
9060
9061
9062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9055

class DescribeReservedInstancesRequest < Struct.new(
  :filters,
  :offering_class,
  :reserved_instances_ids,
  :dry_run,
  :offering_type)
  include Aws::Structure
end

#offering_classString

Describes whether the Reserved Instance is Standard or Convertible.

Returns:

  • (String)


9055
9056
9057
9058
9059
9060
9061
9062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9055

class DescribeReservedInstancesRequest < Struct.new(
  :filters,
  :offering_class,
  :reserved_instances_ids,
  :dry_run,
  :offering_type)
  include Aws::Structure
end

#offering_typeString

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.

Returns:

  • (String)


9055
9056
9057
9058
9059
9060
9061
9062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9055

class DescribeReservedInstancesRequest < Struct.new(
  :filters,
  :offering_class,
  :reserved_instances_ids,
  :dry_run,
  :offering_type)
  include Aws::Structure
end

#reserved_instances_idsArray<String>

One or more Reserved Instance IDs.

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

Returns:

  • (Array<String>)


9055
9056
9057
9058
9059
9060
9061
9062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9055

class DescribeReservedInstancesRequest < Struct.new(
  :filters,
  :offering_class,
  :reserved_instances_ids,
  :dry_run,
  :offering_type)
  include Aws::Structure
end