Class DescribeReservedInstancesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest
All Implemented Interfaces:
ReadLimitInfo, DryRunSupportedRequest<DescribeReservedInstancesRequest>, Serializable, Cloneable

public class DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeReservedInstancesRequest>

Contains the parameters for DescribeReservedInstances.

See Also:
  • Constructor Details

    • DescribeReservedInstancesRequest

      public DescribeReservedInstancesRequest()
  • Method Details

    • getReservedInstancesIds

      public List<String> getReservedInstancesIds()

      One or more Reserved Instance IDs.

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

      Returns:
      One or more Reserved Instance IDs.

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

    • setReservedInstancesIds

      public void setReservedInstancesIds(Collection<String> reservedInstancesIds)

      One or more Reserved Instance IDs.

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

      Parameters:
      reservedInstancesIds - One or more Reserved Instance IDs.

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

    • withReservedInstancesIds

      public DescribeReservedInstancesRequest withReservedInstancesIds(String... reservedInstancesIds)

      One or more Reserved Instance IDs.

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

      NOTE: This method appends the values to the existing list (if any). Use setReservedInstancesIds(java.util.Collection) or withReservedInstancesIds(java.util.Collection) if you want to override the existing values.

      Parameters:
      reservedInstancesIds - One or more Reserved Instance IDs.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withReservedInstancesIds

      public DescribeReservedInstancesRequest withReservedInstancesIds(Collection<String> reservedInstancesIds)

      One or more Reserved Instance IDs.

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

      Parameters:
      reservedInstancesIds - One or more Reserved Instance IDs.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getFilters

      public List<Filter> getFilters()

      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.

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

      • 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:
      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.

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

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

    • setFilters

      public void setFilters(Collection<Filter> filters)

      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.

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

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

      Parameters:
      filters - 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.

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

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

    • withFilters

      public DescribeReservedInstancesRequest withFilters(Filter... filters)

      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.

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

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

      NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

      Parameters:
      filters - 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.

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

      • 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:
      Returns a reference to this object so that method calls can be chained together.
    • withFilters

      public DescribeReservedInstancesRequest withFilters(Collection<Filter> filters)

      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.

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

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

      Parameters:
      filters - 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.

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

      • 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:
      Returns a reference to this object so that method calls can be chained together.
    • setOfferingType

      public void setOfferingType(String 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.

      Parameters:
      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.
      See Also:
    • getOfferingType

      public String getOfferingType()

      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:
      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.
      See Also:
    • withOfferingType

      public DescribeReservedInstancesRequest withOfferingType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setOfferingType

      public void setOfferingType(OfferingTypeValues 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.

      Parameters:
      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.
      See Also:
    • withOfferingType

      public DescribeReservedInstancesRequest withOfferingType(OfferingTypeValues 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • getDryRunRequest

      public Request<DescribeReservedInstancesRequest> getDryRunRequest()
      This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
      Specified by:
      getDryRunRequest in interface DryRunSupportedRequest<DescribeReservedInstancesRequest>
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: