com.amazonaws.services.ec2.model

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>

Container for the parameters to the DescribeReservedInstances operation.

Describes one or more of the Reserved instances that you purchased.

For more information about Reserved instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.describeReservedInstances(DescribeReservedInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeReservedInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeReservedInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<DescribeReservedInstancesRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
String	getOfferingType() The Reserved instance offering type.
List<String>	getReservedInstancesIds() One or more Reserved instance IDs.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setOfferingType(OfferingTypeValues offeringType) The Reserved instance offering type.
void	setOfferingType(String offeringType) The Reserved instance offering type.
void	setReservedInstancesIds(Collection<String> reservedInstancesIds) One or more Reserved instance IDs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeReservedInstancesRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeReservedInstancesRequest	withFilters(Filter... filters) One or more filters.
DescribeReservedInstancesRequest	withOfferingType(OfferingTypeValues offeringType) The Reserved instance offering type.
DescribeReservedInstancesRequest	withOfferingType(String offeringType) The Reserved instance offering type.
DescribeReservedInstancesRequest	withReservedInstancesIds(Collection<String> reservedInstancesIds) One or more Reserved instance IDs.
DescribeReservedInstancesRequest	withReservedInstancesIds(String... reservedInstancesIds) One or more Reserved instance IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeReservedInstancesRequest

public DescribeReservedInstancesRequest()

Method Detail

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.

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

Parameters:

reservedInstancesIds - One or more Reserved instance IDs.

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

Returns:

A reference to this updated 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.

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

Parameters:

reservedInstancesIds - One or more Reserved instance IDs.

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

Returns:

A reference to this updated 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.

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

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:

A reference to this updated 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).

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

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:

A reference to this updated object so that method calls can be chained together.

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.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

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:

OfferingTypeValues

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.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

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:

OfferingTypeValues

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.

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

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

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:

A reference to this updated object so that method calls can be chained together.

See Also:

OfferingTypeValues

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.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

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:

OfferingTypeValues

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.

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

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

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:

A reference to this updated object so that method calls can be chained together.

See Also:

OfferingTypeValues

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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeReservedInstancesRequest 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:

Object.clone()