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

#include <DescribeHostsRequest.h>

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

Public Member Functions

 DescribeHostsRequest ()
 
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)
 
DescribeHostsRequestWithFilter (const Aws::Vector< Filter > &value)
 
DescribeHostsRequestWithFilter (Aws::Vector< Filter > &&value)
 
DescribeHostsRequestAddFilter (const Filter &value)
 
DescribeHostsRequestAddFilter (Filter &&value)
 
const Aws::Vector< Aws::String > & GetHostIds () const
 
bool HostIdsHasBeenSet () const
 
void SetHostIds (const Aws::Vector< Aws::String > &value)
 
void SetHostIds (Aws::Vector< Aws::String > &&value)
 
DescribeHostsRequestWithHostIds (const Aws::Vector< Aws::String > &value)
 
DescribeHostsRequestWithHostIds (Aws::Vector< Aws::String > &&value)
 
DescribeHostsRequestAddHostIds (const Aws::String &value)
 
DescribeHostsRequestAddHostIds (Aws::String &&value)
 
DescribeHostsRequestAddHostIds (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeHostsRequestWithMaxResults (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)
 
DescribeHostsRequestWithNextToken (const Aws::String &value)
 
DescribeHostsRequestWithNextToken (Aws::String &&value)
 
DescribeHostsRequestWithNextToken (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 DescribeHostsRequest.h.

Constructor & Destructor Documentation

◆ DescribeHostsRequest()

Aws::EC2::Model::DescribeHostsRequest::DescribeHostsRequest ( )

Member Function Documentation

◆ AddFilter() [1/2]

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 182 of file DescribeHostsRequest.h.

◆ AddFilter() [2/2]

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 201 of file DescribeHostsRequest.h.

◆ AddHostIds() [1/3]

DescribeHostsRequest& Aws::EC2::Model::DescribeHostsRequest::AddHostIds ( const Aws::String value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 244 of file DescribeHostsRequest.h.

◆ AddHostIds() [2/3]

DescribeHostsRequest& Aws::EC2::Model::DescribeHostsRequest::AddHostIds ( Aws::String &&  value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 250 of file DescribeHostsRequest.h.

◆ AddHostIds() [3/3]

DescribeHostsRequest& Aws::EC2::Model::DescribeHostsRequest::AddHostIds ( const char *  value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 256 of file DescribeHostsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeHostsRequest::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::DescribeHostsRequest::FilterHasBeenSet ( ) const
inline

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 87 of file DescribeHostsRequest.h.

◆ GetFilter()

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 68 of file DescribeHostsRequest.h.

◆ GetHostIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeHostsRequest::GetHostIds ( ) const
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 208 of file DescribeHostsRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeHostsRequest::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.

You cannot specify this parameter and the host IDs parameter in the same request.

Definition at line 267 of file DescribeHostsRequest.h.

◆ GetNextToken()

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

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

Definition at line 303 of file DescribeHostsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file DescribeHostsRequest.h.

◆ HostIdsHasBeenSet()

bool Aws::EC2::Model::DescribeHostsRequest::HostIdsHasBeenSet ( ) const
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 214 of file DescribeHostsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EC2::Model::DescribeHostsRequest::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.

You cannot specify this parameter and the host IDs parameter in the same request.

Definition at line 277 of file DescribeHostsRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 308 of file DescribeHostsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 106 of file DescribeHostsRequest.h.

◆ SetFilter() [2/2]

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 125 of file DescribeHostsRequest.h.

◆ SetHostIds() [1/2]

void Aws::EC2::Model::DescribeHostsRequest::SetHostIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 220 of file DescribeHostsRequest.h.

◆ SetHostIds() [2/2]

void Aws::EC2::Model::DescribeHostsRequest::SetHostIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 226 of file DescribeHostsRequest.h.

◆ SetMaxResults()

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

You cannot specify this parameter and the host IDs parameter in the same request.

Definition at line 287 of file DescribeHostsRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 313 of file DescribeHostsRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 318 of file DescribeHostsRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 323 of file DescribeHostsRequest.h.

◆ WithFilter() [1/2]

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 144 of file DescribeHostsRequest.h.

◆ WithFilter() [2/2]

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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 163 of file DescribeHostsRequest.h.

◆ WithHostIds() [1/2]

DescribeHostsRequest& Aws::EC2::Model::DescribeHostsRequest::WithHostIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 232 of file DescribeHostsRequest.h.

◆ WithHostIds() [2/2]

DescribeHostsRequest& Aws::EC2::Model::DescribeHostsRequest::WithHostIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Definition at line 238 of file DescribeHostsRequest.h.

◆ WithMaxResults()

DescribeHostsRequest& Aws::EC2::Model::DescribeHostsRequest::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.

You cannot specify this parameter and the host IDs parameter in the same request.

Definition at line 297 of file DescribeHostsRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 328 of file DescribeHostsRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 333 of file DescribeHostsRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 338 of file DescribeHostsRequest.h.


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