public class DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements java.io.Serializable, DryRunSupportedRequest<DescribeReservedInstancesRequest>
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 .
Constructor and Description |
---|
DescribeReservedInstancesRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
Request<DescribeReservedInstancesRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
java.util.List<Filter> |
getFilters()
One or more filters.
|
java.lang.String |
getOfferingType()
The Reserved Instance offering type.
|
java.util.List<java.lang.String> |
getReservedInstancesIds()
One or more Reserved Instance IDs.
|
int |
hashCode() |
void |
setFilters(java.util.Collection<Filter> filters)
One or more filters.
|
void |
setOfferingType(OfferingTypeValues offeringType)
The Reserved Instance offering type.
|
void |
setOfferingType(java.lang.String offeringType)
The Reserved Instance offering type.
|
void |
setReservedInstancesIds(java.util.Collection<java.lang.String> reservedInstancesIds)
One or more Reserved Instance IDs.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeReservedInstancesRequest |
withFilters(java.util.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(java.lang.String offeringType)
The Reserved Instance offering type.
|
DescribeReservedInstancesRequest |
withReservedInstancesIds(java.util.Collection<java.lang.String> reservedInstancesIds)
One or more Reserved Instance IDs.
|
DescribeReservedInstancesRequest |
withReservedInstancesIds(java.lang.String... reservedInstancesIds)
One or more Reserved Instance IDs.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.util.List<java.lang.String> getReservedInstancesIds()
Default: Describes all your Reserved Instances, or only those otherwise specified.
Default: Describes all your Reserved Instances, or only those otherwise specified.
public void setReservedInstancesIds(java.util.Collection<java.lang.String> reservedInstancesIds)
Default: Describes all your Reserved Instances, or only those otherwise specified.
reservedInstancesIds
- One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.
public DescribeReservedInstancesRequest withReservedInstancesIds(java.lang.String... reservedInstancesIds)
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.
reservedInstancesIds
- One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.
public DescribeReservedInstancesRequest withReservedInstancesIds(java.util.Collection<java.lang.String> reservedInstancesIds)
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.
reservedInstancesIds
- One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.
public java.util.List<Filter> getFilters()
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).
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).
public void setFilters(java.util.Collection<Filter> 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).
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).
public DescribeReservedInstancesRequest withFilters(Filter... 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.
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).
public DescribeReservedInstancesRequest withFilters(java.util.Collection<Filter> 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.
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).
public java.lang.String getOfferingType()
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
Medium Utilization
Reserved Instance offering type.OfferingTypeValues
public void setOfferingType(java.lang.String offeringType)
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
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.OfferingTypeValues
public DescribeReservedInstancesRequest withOfferingType(java.lang.String offeringType)
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
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.OfferingTypeValues
public void setOfferingType(OfferingTypeValues offeringType)
Medium Utilization
Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
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.OfferingTypeValues
public DescribeReservedInstancesRequest withOfferingType(OfferingTypeValues offeringType)
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
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.OfferingTypeValues
public Request<DescribeReservedInstancesRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeReservedInstancesRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.