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

#include <DescribeHostReservationsRequest.h>

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

Public Member Functions

 DescribeHostReservationsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Aws::Vector< Filter > &value)
 
void SetFilter (Aws::Vector< Filter > &&value)
 
DescribeHostReservationsRequestWithFilter (const Aws::Vector< Filter > &value)
 
DescribeHostReservationsRequestWithFilter (Aws::Vector< Filter > &&value)
 
DescribeHostReservationsRequestAddFilter (const Filter &value)
 
DescribeHostReservationsRequestAddFilter (Filter &&value)
 
const Aws::Vector< Aws::String > & GetHostReservationIdSet () const
 
bool HostReservationIdSetHasBeenSet () const
 
void SetHostReservationIdSet (const Aws::Vector< Aws::String > &value)
 
void SetHostReservationIdSet (Aws::Vector< Aws::String > &&value)
 
DescribeHostReservationsRequestWithHostReservationIdSet (const Aws::Vector< Aws::String > &value)
 
DescribeHostReservationsRequestWithHostReservationIdSet (Aws::Vector< Aws::String > &&value)
 
DescribeHostReservationsRequestAddHostReservationIdSet (const Aws::String &value)
 
DescribeHostReservationsRequestAddHostReservationIdSet (Aws::String &&value)
 
DescribeHostReservationsRequestAddHostReservationIdSet (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeHostReservationsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeHostReservationsRequestWithNextToken (const Aws::String &value)
 
DescribeHostReservationsRequestWithNextToken (Aws::String &&value)
 
DescribeHostReservationsRequestWithNextToken (const char *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

Definition at line 33 of file DescribeHostReservationsRequest.h.

Constructor & Destructor Documentation

◆ DescribeHostReservationsRequest()

Aws::EC2::Model::DescribeHostReservationsRequest::DescribeHostReservationsRequest ( )

Member Function Documentation

◆ AddFilter() [1/2]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::AddFilter ( const Filter value)
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 175 of file DescribeHostReservationsRequest.h.

◆ AddFilter() [2/2]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::AddFilter ( Filter &&  value)
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 193 of file DescribeHostReservationsRequest.h.

◆ AddHostReservationIdSet() [1/3]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::AddHostReservationIdSet ( const Aws::String value)
inline

The host reservation IDs.

Definition at line 229 of file DescribeHostReservationsRequest.h.

◆ AddHostReservationIdSet() [2/3]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::AddHostReservationIdSet ( Aws::String &&  value)
inline

The host reservation IDs.

Definition at line 234 of file DescribeHostReservationsRequest.h.

◆ AddHostReservationIdSet() [3/3]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::AddHostReservationIdSet ( const char *  value)
inline

The host reservation IDs.

Definition at line 239 of file DescribeHostReservationsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeHostReservationsRequest::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.

◆ FilterHasBeenSet()

bool Aws::EC2::Model::DescribeHostReservationsRequest::FilterHasBeenSet ( ) const
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 85 of file DescribeHostReservationsRequest.h.

◆ GetFilter()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeHostReservationsRequest::GetFilter ( ) const
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 67 of file DescribeHostReservationsRequest.h.

◆ GetHostReservationIdSet()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeHostReservationsRequest::GetHostReservationIdSet ( ) const
inline

The host reservation IDs.

Definition at line 199 of file DescribeHostReservationsRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeHostReservationsRequest::GetMaxResults ( ) const
inline

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Definition at line 249 of file DescribeHostReservationsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::EC2::Model::DescribeHostReservationsRequest::GetNextToken ( ) const
inline

The token to use to retrieve the next page of results.

Definition at line 282 of file DescribeHostReservationsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file DescribeHostReservationsRequest.h.

◆ HostReservationIdSetHasBeenSet()

bool Aws::EC2::Model::DescribeHostReservationsRequest::HostReservationIdSetHasBeenSet ( ) const
inline

The host reservation IDs.

Definition at line 204 of file DescribeHostReservationsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EC2::Model::DescribeHostReservationsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Definition at line 258 of file DescribeHostReservationsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::EC2::Model::DescribeHostReservationsRequest::NextTokenHasBeenSet ( ) const
inline

The token to use to retrieve the next page of results.

Definition at line 287 of file DescribeHostReservationsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetFilter ( const Aws::Vector< Filter > &  value)
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 103 of file DescribeHostReservationsRequest.h.

◆ SetFilter() [2/2]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetFilter ( Aws::Vector< Filter > &&  value)
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 121 of file DescribeHostReservationsRequest.h.

◆ SetHostReservationIdSet() [1/2]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetHostReservationIdSet ( const Aws::Vector< Aws::String > &  value)
inline

The host reservation IDs.

Definition at line 209 of file DescribeHostReservationsRequest.h.

◆ SetHostReservationIdSet() [2/2]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetHostReservationIdSet ( Aws::Vector< Aws::String > &&  value)
inline

The host reservation IDs.

Definition at line 214 of file DescribeHostReservationsRequest.h.

◆ SetMaxResults()

void Aws::EC2::Model::DescribeHostReservationsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Definition at line 267 of file DescribeHostReservationsRequest.h.

◆ SetNextToken() [1/3]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetNextToken ( const Aws::String value)
inline

The token to use to retrieve the next page of results.

Definition at line 292 of file DescribeHostReservationsRequest.h.

◆ SetNextToken() [2/3]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetNextToken ( Aws::String &&  value)
inline

The token to use to retrieve the next page of results.

Definition at line 297 of file DescribeHostReservationsRequest.h.

◆ SetNextToken() [3/3]

void Aws::EC2::Model::DescribeHostReservationsRequest::SetNextToken ( const char *  value)
inline

The token to use to retrieve the next page of results.

Definition at line 302 of file DescribeHostReservationsRequest.h.

◆ WithFilter() [1/2]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithFilter ( const Aws::Vector< Filter > &  value)
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 139 of file DescribeHostReservationsRequest.h.

◆ WithFilter() [2/2]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithFilter ( Aws::Vector< Filter > &&  value)
inline

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | 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.

Definition at line 157 of file DescribeHostReservationsRequest.h.

◆ WithHostReservationIdSet() [1/2]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithHostReservationIdSet ( const Aws::Vector< Aws::String > &  value)
inline

The host reservation IDs.

Definition at line 219 of file DescribeHostReservationsRequest.h.

◆ WithHostReservationIdSet() [2/2]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithHostReservationIdSet ( Aws::Vector< Aws::String > &&  value)
inline

The host reservation IDs.

Definition at line 224 of file DescribeHostReservationsRequest.h.

◆ WithMaxResults()

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Definition at line 276 of file DescribeHostReservationsRequest.h.

◆ WithNextToken() [1/3]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithNextToken ( const Aws::String value)
inline

The token to use to retrieve the next page of results.

Definition at line 307 of file DescribeHostReservationsRequest.h.

◆ WithNextToken() [2/3]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithNextToken ( Aws::String &&  value)
inline

The token to use to retrieve the next page of results.

Definition at line 312 of file DescribeHostReservationsRequest.h.

◆ WithNextToken() [3/3]

DescribeHostReservationsRequest& Aws::EC2::Model::DescribeHostReservationsRequest::WithNextToken ( const char *  value)
inline

The token to use to retrieve the next page of results.

Definition at line 317 of file DescribeHostReservationsRequest.h.


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