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

#include <DescribeInternetGatewaysRequest.h>

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

Public Member Functions

 DescribeInternetGatewaysRequest ()
 
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)
 
DescribeInternetGatewaysRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeInternetGatewaysRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeInternetGatewaysRequestAddFilters (const Filter &value)
 
DescribeInternetGatewaysRequestAddFilters (Filter &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeInternetGatewaysRequestWithDryRun (bool value)
 
const Aws::Vector< Aws::String > & GetInternetGatewayIds () const
 
bool InternetGatewayIdsHasBeenSet () const
 
void SetInternetGatewayIds (const Aws::Vector< Aws::String > &value)
 
void SetInternetGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeInternetGatewaysRequestWithInternetGatewayIds (const Aws::Vector< Aws::String > &value)
 
DescribeInternetGatewaysRequestWithInternetGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeInternetGatewaysRequestAddInternetGatewayIds (const Aws::String &value)
 
DescribeInternetGatewaysRequestAddInternetGatewayIds (Aws::String &&value)
 
DescribeInternetGatewaysRequestAddInternetGatewayIds (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeInternetGatewaysRequestWithNextToken (const Aws::String &value)
 
DescribeInternetGatewaysRequestWithNextToken (Aws::String &&value)
 
DescribeInternetGatewaysRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeInternetGatewaysRequestWithMaxResults (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 23 of file DescribeInternetGatewaysRequest.h.

Constructor & Destructor Documentation

◆ DescribeInternetGatewaysRequest()

Aws::EC2::Model::DescribeInternetGatewaysRequest::DescribeInternetGatewaysRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

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

◆ AddFilters() [2/2]

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 191 of file DescribeInternetGatewaysRequest.h.

◆ AddInternetGatewayIds() [1/3]

DescribeInternetGatewaysRequest& Aws::EC2::Model::DescribeInternetGatewaysRequest::AddInternetGatewayIds ( Aws::String &&  value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 273 of file DescribeInternetGatewaysRequest.h.

◆ AddInternetGatewayIds() [2/3]

DescribeInternetGatewaysRequest& Aws::EC2::Model::DescribeInternetGatewaysRequest::AddInternetGatewayIds ( const Aws::String value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 267 of file DescribeInternetGatewaysRequest.h.

◆ AddInternetGatewayIds() [3/3]

DescribeInternetGatewaysRequest& Aws::EC2::Model::DescribeInternetGatewaysRequest::AddInternetGatewayIds ( const char *  value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 279 of file DescribeInternetGatewaysRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 77 of file DescribeInternetGatewaysRequest.h.

◆ GetDryRun()

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

◆ GetFilters()

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 58 of file DescribeInternetGatewaysRequest.h.

◆ GetInternetGatewayIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeInternetGatewaysRequest::GetInternetGatewayIds ( ) const
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 231 of file DescribeInternetGatewaysRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeInternetGatewaysRequest::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 328 of file DescribeInternetGatewaysRequest.h.

◆ GetNextToken()

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

The token for the next page of results.

Definition at line 285 of file DescribeInternetGatewaysRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeInternetGatewaysRequest.h.

◆ InternetGatewayIdsHasBeenSet()

bool Aws::EC2::Model::DescribeInternetGatewaysRequest::InternetGatewayIdsHasBeenSet ( ) const
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 237 of file DescribeInternetGatewaysRequest.h.

◆ MaxResultsHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

The token for the next page of results.

Definition at line 290 of file DescribeInternetGatewaysRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

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

◆ SetFilters() [1/2]

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 115 of file DescribeInternetGatewaysRequest.h.

◆ SetFilters() [2/2]

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 96 of file DescribeInternetGatewaysRequest.h.

◆ SetInternetGatewayIds() [1/2]

void Aws::EC2::Model::DescribeInternetGatewaysRequest::SetInternetGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 249 of file DescribeInternetGatewaysRequest.h.

◆ SetInternetGatewayIds() [2/2]

void Aws::EC2::Model::DescribeInternetGatewaysRequest::SetInternetGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 243 of file DescribeInternetGatewaysRequest.h.

◆ SetMaxResults()

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

◆ SetNextToken() [1/3]

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

The token for the next page of results.

Definition at line 300 of file DescribeInternetGatewaysRequest.h.

◆ SetNextToken() [2/3]

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

The token for the next page of results.

Definition at line 295 of file DescribeInternetGatewaysRequest.h.

◆ SetNextToken() [3/3]

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

The token for the next page of results.

Definition at line 305 of file DescribeInternetGatewaysRequest.h.

◆ WithDryRun()

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

◆ WithFilters() [1/2]

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 153 of file DescribeInternetGatewaysRequest.h.

◆ WithFilters() [2/2]

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

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • 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 134 of file DescribeInternetGatewaysRequest.h.

◆ WithInternetGatewayIds() [1/2]

DescribeInternetGatewaysRequest& Aws::EC2::Model::DescribeInternetGatewaysRequest::WithInternetGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 261 of file DescribeInternetGatewaysRequest.h.

◆ WithInternetGatewayIds() [2/2]

DescribeInternetGatewaysRequest& Aws::EC2::Model::DescribeInternetGatewaysRequest::WithInternetGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more internet gateway IDs.

Default: Describes all your internet gateways.

Definition at line 255 of file DescribeInternetGatewaysRequest.h.

◆ WithMaxResults()

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

◆ WithNextToken() [1/3]

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

The token for the next page of results.

Definition at line 315 of file DescribeInternetGatewaysRequest.h.

◆ WithNextToken() [2/3]

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

The token for the next page of results.

Definition at line 310 of file DescribeInternetGatewaysRequest.h.

◆ WithNextToken() [3/3]

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

The token for the next page of results.

Definition at line 320 of file DescribeInternetGatewaysRequest.h.


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