Aws::EC2::Model::DescribeCarrierGatewaysRequest Class Reference

#include <DescribeCarrierGatewaysRequest.h>

Inheritance diagram for Aws::EC2::Model::DescribeCarrierGatewaysRequest:

Public Member Functions
	DescribeCarrierGatewaysRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
const Aws::Vector< Aws::String > &	GetCarrierGatewayIds () const
bool	CarrierGatewayIdsHasBeenSet () const
void	SetCarrierGatewayIds (const Aws::Vector< Aws::String > &value)
void	SetCarrierGatewayIds (Aws::Vector< Aws::String > &&value)
DescribeCarrierGatewaysRequest &	WithCarrierGatewayIds (const Aws::Vector< Aws::String > &value)
DescribeCarrierGatewaysRequest &	WithCarrierGatewayIds (Aws::Vector< Aws::String > &&value)
DescribeCarrierGatewaysRequest &	AddCarrierGatewayIds (const Aws::String &value)
DescribeCarrierGatewaysRequest &	AddCarrierGatewayIds (Aws::String &&value)
DescribeCarrierGatewaysRequest &	AddCarrierGatewayIds (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)
DescribeCarrierGatewaysRequest &	WithFilters (const Aws::Vector< Filter > &value)
DescribeCarrierGatewaysRequest &	WithFilters (Aws::Vector< Filter > &&value)
DescribeCarrierGatewaysRequest &	AddFilters (const Filter &value)
DescribeCarrierGatewaysRequest &	AddFilters (Filter &&value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
DescribeCarrierGatewaysRequest &	WithMaxResults (int value)
const Aws::String &	GetNextToken () const
bool	NextTokenHasBeenSet () const
void	SetNextToken (const Aws::String &value)
void	SetNextToken (Aws::String &&value)
void	SetNextToken (const char *value)
DescribeCarrierGatewaysRequest &	WithNextToken (const Aws::String &value)
DescribeCarrierGatewaysRequest &	WithNextToken (Aws::String &&value)
DescribeCarrierGatewaysRequest &	WithNextToken (const char *value)
bool	GetDryRun () const
bool	DryRunHasBeenSet () const
void	SetDryRun (bool value)
DescribeCarrierGatewaysRequest &	WithDryRun (bool 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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 DescribeCarrierGatewaysRequest.h.

Constructor & Destructor Documentation

DescribeCarrierGatewaysRequest()

Aws::EC2::Model::DescribeCarrierGatewaysRequest::DescribeCarrierGatewaysRequest

(

)

Member Function Documentation

AddCarrierGatewayIds() [1/3]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::AddCarrierGatewayIds ( Aws::String &&  value )

inline

One or more carrier gateway IDs.

Definition at line 79 of file DescribeCarrierGatewaysRequest.h.

AddCarrierGatewayIds() [2/3]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::AddCarrierGatewayIds ( const Aws::String &  value )

inline

One or more carrier gateway IDs.

Definition at line 74 of file DescribeCarrierGatewaysRequest.h.

AddCarrierGatewayIds() [3/3]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::AddCarrierGatewayIds ( const char *  value )

inline

One or more carrier gateway IDs.

Definition at line 84 of file DescribeCarrierGatewaysRequest.h.

AddFilters() [1/2]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::AddFilters ( const Filter &  value )

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 218 of file DescribeCarrierGatewaysRequest.h.

AddFilters() [2/2]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::AddFilters ( Filter &&  value )

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 237 of file DescribeCarrierGatewaysRequest.h.

CarrierGatewayIdsHasBeenSet()

bool Aws::EC2::Model::DescribeCarrierGatewaysRequest::CarrierGatewayIdsHasBeenSet ( ) const

inline

One or more carrier gateway IDs.

Definition at line 49 of file DescribeCarrierGatewaysRequest.h.

DryRunHasBeenSet()

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

DumpBodyToUrl()

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

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 123 of file DescribeCarrierGatewaysRequest.h.

GetCarrierGatewayIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeCarrierGatewaysRequest::GetCarrierGatewayIds ( ) const

inline

One or more carrier gateway IDs.

Definition at line 44 of file DescribeCarrierGatewaysRequest.h.

GetDryRun()

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

GetFilters()

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

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 104 of file DescribeCarrierGatewaysRequest.h.

GetMaxResults()

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

GetNextToken()

const Aws::String& Aws::EC2::Model::DescribeCarrierGatewaysRequest::GetNextToken ( ) const

inline

The token for the next page of results.

Definition at line 272 of file DescribeCarrierGatewaysRequest.h.

GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeCarrierGatewaysRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeCarrierGatewaysRequest.h.

MaxResultsHasBeenSet()

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

NextTokenHasBeenSet()

bool Aws::EC2::Model::DescribeCarrierGatewaysRequest::NextTokenHasBeenSet ( ) const

inline

The token for the next page of results.

Definition at line 277 of file DescribeCarrierGatewaysRequest.h.

SerializePayload()

Aws::String Aws::EC2::Model::DescribeCarrierGatewaysRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetCarrierGatewayIds() [1/2]

void Aws::EC2::Model::DescribeCarrierGatewaysRequest::SetCarrierGatewayIds ( Aws::Vector< Aws::String > &&  value )

inline

One or more carrier gateway IDs.

Definition at line 59 of file DescribeCarrierGatewaysRequest.h.

SetCarrierGatewayIds() [2/2]

void Aws::EC2::Model::DescribeCarrierGatewaysRequest::SetCarrierGatewayIds ( const Aws::Vector< Aws::String > &  value )

inline

One or more carrier gateway IDs.

Definition at line 54 of file DescribeCarrierGatewaysRequest.h.

SetDryRun()

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

SetFilters() [1/2]

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

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 161 of file DescribeCarrierGatewaysRequest.h.

SetFilters() [2/2]

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

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 142 of file DescribeCarrierGatewaysRequest.h.

SetMaxResults()

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

SetNextToken() [1/3]

void Aws::EC2::Model::DescribeCarrierGatewaysRequest::SetNextToken ( Aws::String &&  value )

inline

The token for the next page of results.

Definition at line 287 of file DescribeCarrierGatewaysRequest.h.

SetNextToken() [2/3]

void Aws::EC2::Model::DescribeCarrierGatewaysRequest::SetNextToken ( const Aws::String &  value )

inline

The token for the next page of results.

Definition at line 282 of file DescribeCarrierGatewaysRequest.h.

SetNextToken() [3/3]

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

inline

The token for the next page of results.

Definition at line 292 of file DescribeCarrierGatewaysRequest.h.

WithCarrierGatewayIds() [1/2]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::WithCarrierGatewayIds ( Aws::Vector< Aws::String > &&  value )

inline

One or more carrier gateway IDs.

Definition at line 69 of file DescribeCarrierGatewaysRequest.h.

WithCarrierGatewayIds() [2/2]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::WithCarrierGatewayIds ( const Aws::Vector< Aws::String > &  value )

inline

One or more carrier gateway IDs.

Definition at line 64 of file DescribeCarrierGatewaysRequest.h.

WithDryRun()

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

WithFilters() [1/2]

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

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 199 of file DescribeCarrierGatewaysRequest.h.

WithFilters() [2/2]

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

inline

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier 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.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Definition at line 180 of file DescribeCarrierGatewaysRequest.h.

WithMaxResults()

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

WithNextToken() [1/3]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::WithNextToken ( Aws::String &&  value )

inline

The token for the next page of results.

Definition at line 302 of file DescribeCarrierGatewaysRequest.h.

WithNextToken() [2/3]

DescribeCarrierGatewaysRequest& Aws::EC2::Model::DescribeCarrierGatewaysRequest::WithNextToken ( const Aws::String &  value )

inline

The token for the next page of results.

Definition at line 297 of file DescribeCarrierGatewaysRequest.h.

WithNextToken() [3/3]

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

inline

The token for the next page of results.

Definition at line 307 of file DescribeCarrierGatewaysRequest.h.

---

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

• aws-cpp-sdk-ec2/include/aws/ec2/model/DescribeCarrierGatewaysRequest.h