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

#include <DescribeDhcpOptionsRequest.h>

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

Public Member Functions

 DescribeDhcpOptionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetDhcpOptionsIds () const
 
bool DhcpOptionsIdsHasBeenSet () const
 
void SetDhcpOptionsIds (const Aws::Vector< Aws::String > &value)
 
void SetDhcpOptionsIds (Aws::Vector< Aws::String > &&value)
 
DescribeDhcpOptionsRequestWithDhcpOptionsIds (const Aws::Vector< Aws::String > &value)
 
DescribeDhcpOptionsRequestWithDhcpOptionsIds (Aws::Vector< Aws::String > &&value)
 
DescribeDhcpOptionsRequestAddDhcpOptionsIds (const Aws::String &value)
 
DescribeDhcpOptionsRequestAddDhcpOptionsIds (Aws::String &&value)
 
DescribeDhcpOptionsRequestAddDhcpOptionsIds (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeDhcpOptionsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeDhcpOptionsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeDhcpOptionsRequestAddFilters (const Filter &value)
 
DescribeDhcpOptionsRequestAddFilters (Filter &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeDhcpOptionsRequestWithDryRun (bool value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeDhcpOptionsRequestWithNextToken (const Aws::String &value)
 
DescribeDhcpOptionsRequestWithNextToken (Aws::String &&value)
 
DescribeDhcpOptionsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeDhcpOptionsRequestWithMaxResults (int 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 DescribeDhcpOptionsRequest.h.

Constructor & Destructor Documentation

◆ DescribeDhcpOptionsRequest()

Aws::EC2::Model::DescribeDhcpOptionsRequest::DescribeDhcpOptionsRequest ( )

Member Function Documentation

◆ AddDhcpOptionsIds() [1/3]

DescribeDhcpOptionsRequest& Aws::EC2::Model::DescribeDhcpOptionsRequest::AddDhcpOptionsIds ( const Aws::String value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 91 of file DescribeDhcpOptionsRequest.h.

◆ AddDhcpOptionsIds() [2/3]

DescribeDhcpOptionsRequest& Aws::EC2::Model::DescribeDhcpOptionsRequest::AddDhcpOptionsIds ( Aws::String &&  value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 97 of file DescribeDhcpOptionsRequest.h.

◆ AddDhcpOptionsIds() [3/3]

DescribeDhcpOptionsRequest& Aws::EC2::Model::DescribeDhcpOptionsRequest::AddDhcpOptionsIds ( const char *  value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 103 of file DescribeDhcpOptionsRequest.h.

◆ AddFilters() [1/2]

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 223 of file DescribeDhcpOptionsRequest.h.

◆ AddFilters() [2/2]

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 240 of file DescribeDhcpOptionsRequest.h.

◆ DhcpOptionsIdsHasBeenSet()

bool Aws::EC2::Model::DescribeDhcpOptionsRequest::DhcpOptionsIdsHasBeenSet ( ) const
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 61 of file DescribeDhcpOptionsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeDhcpOptionsRequest::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 257 of file DescribeDhcpOptionsRequest.h.

◆ DumpBodyToUrl()

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 138 of file DescribeDhcpOptionsRequest.h.

◆ GetDhcpOptionsIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeDhcpOptionsRequest::GetDhcpOptionsIds ( ) const
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 55 of file DescribeDhcpOptionsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeDhcpOptionsRequest::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 249 of file DescribeDhcpOptionsRequest.h.

◆ GetFilters()

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 DescribeDhcpOptionsRequest.h.

◆ GetMaxResults()

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 322 of file DescribeDhcpOptionsRequest.h.

◆ GetNextToken()

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

The token for the next page of results.

Definition at line 279 of file DescribeDhcpOptionsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file DescribeDhcpOptionsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 329 of file DescribeDhcpOptionsRequest.h.

◆ NextTokenHasBeenSet()

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

The token for the next page of results.

Definition at line 284 of file DescribeDhcpOptionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDhcpOptionsIds() [1/2]

void Aws::EC2::Model::DescribeDhcpOptionsRequest::SetDhcpOptionsIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 67 of file DescribeDhcpOptionsRequest.h.

◆ SetDhcpOptionsIds() [2/2]

void Aws::EC2::Model::DescribeDhcpOptionsRequest::SetDhcpOptionsIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 73 of file DescribeDhcpOptionsRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::DescribeDhcpOptionsRequest::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 265 of file DescribeDhcpOptionsRequest.h.

◆ SetFilters() [1/2]

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 155 of file DescribeDhcpOptionsRequest.h.

◆ SetFilters() [2/2]

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 172 of file DescribeDhcpOptionsRequest.h.

◆ SetMaxResults()

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 336 of file DescribeDhcpOptionsRequest.h.

◆ SetNextToken() [1/3]

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

The token for the next page of results.

Definition at line 289 of file DescribeDhcpOptionsRequest.h.

◆ SetNextToken() [2/3]

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

The token for the next page of results.

Definition at line 294 of file DescribeDhcpOptionsRequest.h.

◆ SetNextToken() [3/3]

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

The token for the next page of results.

Definition at line 299 of file DescribeDhcpOptionsRequest.h.

◆ WithDhcpOptionsIds() [1/2]

DescribeDhcpOptionsRequest& Aws::EC2::Model::DescribeDhcpOptionsRequest::WithDhcpOptionsIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 79 of file DescribeDhcpOptionsRequest.h.

◆ WithDhcpOptionsIds() [2/2]

DescribeDhcpOptionsRequest& Aws::EC2::Model::DescribeDhcpOptionsRequest::WithDhcpOptionsIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Definition at line 85 of file DescribeDhcpOptionsRequest.h.

◆ WithDryRun()

DescribeDhcpOptionsRequest& Aws::EC2::Model::DescribeDhcpOptionsRequest::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 273 of file DescribeDhcpOptionsRequest.h.

◆ WithFilters() [1/2]

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 189 of file DescribeDhcpOptionsRequest.h.

◆ WithFilters() [2/2]

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

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • 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 206 of file DescribeDhcpOptionsRequest.h.

◆ WithMaxResults()

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 343 of file DescribeDhcpOptionsRequest.h.

◆ WithNextToken() [1/3]

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

The token for the next page of results.

Definition at line 304 of file DescribeDhcpOptionsRequest.h.

◆ WithNextToken() [2/3]

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

The token for the next page of results.

Definition at line 309 of file DescribeDhcpOptionsRequest.h.

◆ WithNextToken() [3/3]

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

The token for the next page of results.

Definition at line 314 of file DescribeDhcpOptionsRequest.h.


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