AWS SDK for C++  1.8.73
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeReservedInstancesRequest Class Reference

#include <DescribeReservedInstancesRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribeReservedInstancesRequest:

Public Member Functions

 DescribeReservedInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeReservedInstancesRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeReservedInstancesRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeReservedInstancesRequestAddFilters (const Filter &value)
 
DescribeReservedInstancesRequestAddFilters (Filter &&value)
 
const OfferingClassTypeGetOfferingClass () const
 
bool OfferingClassHasBeenSet () const
 
void SetOfferingClass (const OfferingClassType &value)
 
void SetOfferingClass (OfferingClassType &&value)
 
DescribeReservedInstancesRequestWithOfferingClass (const OfferingClassType &value)
 
DescribeReservedInstancesRequestWithOfferingClass (OfferingClassType &&value)
 
const Aws::Vector< Aws::String > & GetReservedInstancesIds () const
 
bool ReservedInstancesIdsHasBeenSet () const
 
void SetReservedInstancesIds (const Aws::Vector< Aws::String > &value)
 
void SetReservedInstancesIds (Aws::Vector< Aws::String > &&value)
 
DescribeReservedInstancesRequestWithReservedInstancesIds (const Aws::Vector< Aws::String > &value)
 
DescribeReservedInstancesRequestWithReservedInstancesIds (Aws::Vector< Aws::String > &&value)
 
DescribeReservedInstancesRequestAddReservedInstancesIds (const Aws::String &value)
 
DescribeReservedInstancesRequestAddReservedInstancesIds (Aws::String &&value)
 
DescribeReservedInstancesRequestAddReservedInstancesIds (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeReservedInstancesRequestWithDryRun (bool value)
 
const OfferingTypeValuesGetOfferingType () const
 
bool OfferingTypeHasBeenSet () const
 
void SetOfferingType (const OfferingTypeValues &value)
 
void SetOfferingType (OfferingTypeValues &&value)
 
DescribeReservedInstancesRequestWithOfferingType (const OfferingTypeValues &value)
 
DescribeReservedInstancesRequestWithOfferingType (OfferingTypeValues &&value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Contains the parameters for DescribeReservedInstances.

See Also:

AWS API Reference

Definition at line 29 of file DescribeReservedInstancesRequest.h.

Constructor & Destructor Documentation

◆ DescribeReservedInstancesRequest()

Aws::EC2::Model::DescribeReservedInstancesRequest::DescribeReservedInstancesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::AddFilters ( const Filter value)
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 332 of file DescribeReservedInstancesRequest.h.

◆ AddFilters() [2/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::AddFilters ( Filter &&  value)
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 373 of file DescribeReservedInstancesRequest.h.

◆ AddReservedInstancesIds() [1/3]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::AddReservedInstancesIds ( const Aws::String value)
inline

One or more Reserved Instance IDs.

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

Definition at line 447 of file DescribeReservedInstancesRequest.h.

◆ AddReservedInstancesIds() [2/3]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::AddReservedInstancesIds ( Aws::String &&  value)
inline

One or more Reserved Instance IDs.

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

Definition at line 453 of file DescribeReservedInstancesRequest.h.

◆ AddReservedInstancesIds() [3/3]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::AddReservedInstancesIds ( const char *  value)
inline

One or more Reserved Instance IDs.

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

Definition at line 459 of file DescribeReservedInstancesRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeReservedInstancesRequest::DryRunHasBeenSet ( ) const
inline

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.

Definition at line 476 of file DescribeReservedInstancesRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeReservedInstancesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeReservedInstancesRequest::FiltersHasBeenSet ( ) const
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 127 of file DescribeReservedInstancesRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeReservedInstancesRequest::GetDryRun ( ) const
inline

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.

Definition at line 468 of file DescribeReservedInstancesRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeReservedInstancesRequest::GetFilters ( ) const
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 86 of file DescribeReservedInstancesRequest.h.

◆ GetOfferingClass()

const OfferingClassType& Aws::EC2::Model::DescribeReservedInstancesRequest::GetOfferingClass ( ) const
inline

Describes whether the Reserved Instance is Standard or Convertible.

Definition at line 379 of file DescribeReservedInstancesRequest.h.

◆ GetOfferingType()

const OfferingTypeValues& Aws::EC2::Model::DescribeReservedInstancesRequest::GetOfferingType ( ) const
inline

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.

Definition at line 500 of file DescribeReservedInstancesRequest.h.

◆ GetReservedInstancesIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeReservedInstancesRequest::GetReservedInstancesIds ( ) const
inline

One or more Reserved Instance IDs.

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

Definition at line 411 of file DescribeReservedInstancesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeReservedInstancesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file DescribeReservedInstancesRequest.h.

◆ OfferingClassHasBeenSet()

bool Aws::EC2::Model::DescribeReservedInstancesRequest::OfferingClassHasBeenSet ( ) const
inline

Describes whether the Reserved Instance is Standard or Convertible.

Definition at line 384 of file DescribeReservedInstancesRequest.h.

◆ OfferingTypeHasBeenSet()

bool Aws::EC2::Model::DescribeReservedInstancesRequest::OfferingTypeHasBeenSet ( ) const
inline

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.

Definition at line 507 of file DescribeReservedInstancesRequest.h.

◆ ReservedInstancesIdsHasBeenSet()

bool Aws::EC2::Model::DescribeReservedInstancesRequest::ReservedInstancesIdsHasBeenSet ( ) const
inline

One or more Reserved Instance IDs.

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

Definition at line 417 of file DescribeReservedInstancesRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribeReservedInstancesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetDryRun ( bool  value)
inline

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.

Definition at line 484 of file DescribeReservedInstancesRequest.h.

◆ SetFilters() [1/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 168 of file DescribeReservedInstancesRequest.h.

◆ SetFilters() [2/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 209 of file DescribeReservedInstancesRequest.h.

◆ SetOfferingClass() [1/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetOfferingClass ( const OfferingClassType value)
inline

Describes whether the Reserved Instance is Standard or Convertible.

Definition at line 389 of file DescribeReservedInstancesRequest.h.

◆ SetOfferingClass() [2/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetOfferingClass ( OfferingClassType &&  value)
inline

Describes whether the Reserved Instance is Standard or Convertible.

Definition at line 394 of file DescribeReservedInstancesRequest.h.

◆ SetOfferingType() [1/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetOfferingType ( const OfferingTypeValues value)
inline

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.

Definition at line 514 of file DescribeReservedInstancesRequest.h.

◆ SetOfferingType() [2/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetOfferingType ( OfferingTypeValues &&  value)
inline

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.

Definition at line 521 of file DescribeReservedInstancesRequest.h.

◆ SetReservedInstancesIds() [1/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetReservedInstancesIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more Reserved Instance IDs.

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

Definition at line 423 of file DescribeReservedInstancesRequest.h.

◆ SetReservedInstancesIds() [2/2]

void Aws::EC2::Model::DescribeReservedInstancesRequest::SetReservedInstancesIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more Reserved Instance IDs.

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

Definition at line 429 of file DescribeReservedInstancesRequest.h.

◆ WithDryRun()

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithDryRun ( bool  value)
inline

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.

Definition at line 492 of file DescribeReservedInstancesRequest.h.

◆ WithFilters() [1/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 250 of file DescribeReservedInstancesRequest.h.

◆ WithFilters() [2/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Definition at line 291 of file DescribeReservedInstancesRequest.h.

◆ WithOfferingClass() [1/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithOfferingClass ( const OfferingClassType value)
inline

Describes whether the Reserved Instance is Standard or Convertible.

Definition at line 399 of file DescribeReservedInstancesRequest.h.

◆ WithOfferingClass() [2/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithOfferingClass ( OfferingClassType &&  value)
inline

Describes whether the Reserved Instance is Standard or Convertible.

Definition at line 404 of file DescribeReservedInstancesRequest.h.

◆ WithOfferingType() [1/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithOfferingType ( const OfferingTypeValues value)
inline

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.

Definition at line 528 of file DescribeReservedInstancesRequest.h.

◆ WithOfferingType() [2/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithOfferingType ( OfferingTypeValues &&  value)
inline

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.

Definition at line 535 of file DescribeReservedInstancesRequest.h.

◆ WithReservedInstancesIds() [1/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithReservedInstancesIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more Reserved Instance IDs.

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

Definition at line 435 of file DescribeReservedInstancesRequest.h.

◆ WithReservedInstancesIds() [2/2]

DescribeReservedInstancesRequest& Aws::EC2::Model::DescribeReservedInstancesRequest::WithReservedInstancesIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more Reserved Instance IDs.

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

Definition at line 441 of file DescribeReservedInstancesRequest.h.


The documentation for this class was generated from the following file: