Aws::EC2::Model::DescribeRegionsRequest Class Reference

#include <DescribeRegionsRequest.h>

Inheritance diagram for Aws::EC2::Model::DescribeRegionsRequest:

Public Member Functions

AWS_EC2_API DescribeRegionsRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_EC2_API Aws::String SerializePayload () const override

 

const Aws::Vector< Aws::String > & GetRegionNames () const

 

bool RegionNamesHasBeenSet () const

 

template<typename RegionNamesT = Aws::Vector<Aws::String>>

void SetRegionNames (RegionNamesT &&value)

 

template<typename RegionNamesT = Aws::Vector<Aws::String>>

DescribeRegionsRequest & WithRegionNames (RegionNamesT &&value)

 

template<typename RegionNamesT = Aws::String>

DescribeRegionsRequest & AddRegionNames (RegionNamesT &&value)

 

bool GetAllRegions () const

 

bool AllRegionsHasBeenSet () const

 

void SetAllRegions (bool value)

 

DescribeRegionsRequest & WithAllRegions (bool value)

 

bool GetDryRun () const

 

bool DryRunHasBeenSet () const

 

void SetDryRun (bool value)

 

DescribeRegionsRequest & WithDryRun (bool value)

 

const Aws::Vector< Filter > & GetFilters () const

 

bool FiltersHasBeenSet () const

 

template<typename FiltersT = Aws::Vector<Filter>>

void SetFilters (FiltersT &&value)

 

template<typename FiltersT = Aws::Vector<Filter>>

DescribeRegionsRequest & WithFilters (FiltersT &&value)

 

template<typename FiltersT = Filter>

DescribeRegionsRequest & AddFilters (FiltersT &&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 const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) 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 const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

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

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

AWS_EC2_API void DumpBodyToUrl (Aws::Http::URI &uri) const override

 

Protected Member Functions inherited from Aws::EC2::EC2Request

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Additional Inherited Members

Public Types inherited from Aws::EC2::EC2Request

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 21 of file DescribeRegionsRequest.h.

Constructor & Destructor Documentation

DescribeRegionsRequest()

AWS_EC2_API Aws::EC2::Model::DescribeRegionsRequest::DescribeRegionsRequest ( )

default

Member Function Documentation

AddFilters()

template<typename FiltersT = Filter>

DescribeRegionsRequest & Aws::EC2::Model::DescribeRegionsRequest::AddFilters ( FiltersT &&  value)

inline

The filters.

• endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

• opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

• region-name - The name of the Region (for example, us-east-1).

Definition at line 120 of file DescribeRegionsRequest.h.

AddRegionNames()

template<typename RegionNamesT = Aws::String>

DescribeRegionsRequest & Aws::EC2::Model::DescribeRegionsRequest::AddRegionNames ( RegionNamesT &&  value)

inline

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Definition at line 55 of file DescribeRegionsRequest.h.

AllRegionsHasBeenSet()

bool Aws::EC2::Model::DescribeRegionsRequest::AllRegionsHasBeenSet ( ) const

inline

Indicates whether to display all Regions, including Regions that are disabled for your account.

Definition at line 68 of file DescribeRegionsRequest.h.

DryRunHasBeenSet()

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

DumpBodyToUrl()

AWS_EC2_API void Aws::EC2::Model::DescribeRegionsRequest::DumpBodyToUrl ( Aws::Http::URI &  uri) const

overrideprotectedvirtual

Reimplemented from Aws::AmazonWebServiceRequest.

FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeRegionsRequest::FiltersHasBeenSet ( ) const

inline

The filters.

• endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

• opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

• region-name - The name of the Region (for example, us-east-1).

Definition at line 108 of file DescribeRegionsRequest.h.

GetAllRegions()

bool Aws::EC2::Model::DescribeRegionsRequest::GetAllRegions ( ) const

inline

Indicates whether to display all Regions, including Regions that are disabled for your account.

Definition at line 67 of file DescribeRegionsRequest.h.

GetDryRun()

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

GetFilters()

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

inline

The filters.

• endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

• opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

• region-name - The name of the Region (for example, us-east-1).

Definition at line 107 of file DescribeRegionsRequest.h.

GetRegionNames()

const Aws::Vector< Aws::String > & Aws::EC2::Model::DescribeRegionsRequest::GetRegionNames ( ) const

inline

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Definition at line 42 of file DescribeRegionsRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 29 of file DescribeRegionsRequest.h.

RegionNamesHasBeenSet()

bool Aws::EC2::Model::DescribeRegionsRequest::RegionNamesHasBeenSet ( ) const

inline

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Definition at line 43 of file DescribeRegionsRequest.h.

SerializePayload()

AWS_EC2_API Aws::String Aws::EC2::Model::DescribeRegionsRequest::SerializePayload ( ) const

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetAllRegions()

void Aws::EC2::Model::DescribeRegionsRequest::SetAllRegions ( bool  value)

inline

Indicates whether to display all Regions, including Regions that are disabled for your account.

Definition at line 69 of file DescribeRegionsRequest.h.

SetDryRun()

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

SetFilters()

template<typename FiltersT = Aws::Vector<Filter>>

void Aws::EC2::Model::DescribeRegionsRequest::SetFilters ( FiltersT &&  value)

inline

The filters.

• endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

• opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

• region-name - The name of the Region (for example, us-east-1).

Definition at line 110 of file DescribeRegionsRequest.h.

SetRegionNames()

template<typename RegionNamesT = Aws::Vector<Aws::String>>

void Aws::EC2::Model::DescribeRegionsRequest::SetRegionNames ( RegionNamesT &&  value)

inline

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Definition at line 45 of file DescribeRegionsRequest.h.

WithAllRegions()

DescribeRegionsRequest & Aws::EC2::Model::DescribeRegionsRequest::WithAllRegions ( bool  value)

inline

Indicates whether to display all Regions, including Regions that are disabled for your account.

Definition at line 73 of file DescribeRegionsRequest.h.

WithDryRun()

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

WithFilters()

template<typename FiltersT = Aws::Vector<Filter>>

DescribeRegionsRequest & Aws::EC2::Model::DescribeRegionsRequest::WithFilters ( FiltersT &&  value)

inline

The filters.

• endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

• opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

• region-name - The name of the Region (for example, us-east-1).

Definition at line 115 of file DescribeRegionsRequest.h.

WithRegionNames()

template<typename RegionNamesT = Aws::Vector<Aws::String>>

DescribeRegionsRequest & Aws::EC2::Model::DescribeRegionsRequest::WithRegionNames ( RegionNamesT &&  value)

inline

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Definition at line 50 of file DescribeRegionsRequest.h.

---

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

• generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/DescribeRegionsRequest.h