AWS SDK for C++

AWS SDK for C++ Version 1.11.788

Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeAvailabilityZonesRequest Class Reference

#include <DescribeAvailabilityZonesRequest.h>

Inheritance diagram for Aws::EC2::Model::DescribeAvailabilityZonesRequest:
[legend]

Public Member Functions

AWS_EC2_API DescribeAvailabilityZonesRequest ()=default
 
virtual const char * GetServiceRequestName () const override
 
AWS_EC2_API Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetZoneNames () const
 
bool ZoneNamesHasBeenSet () const
 
template<typename ZoneNamesT = Aws::Vector<Aws::String>>
void SetZoneNames (ZoneNamesT &&value)
 
template<typename ZoneNamesT = Aws::Vector<Aws::String>>
 
template<typename ZoneNamesT = Aws::String>
 
const Aws::Vector< Aws::String > & GetZoneIds () const
 
bool ZoneIdsHasBeenSet () const
 
template<typename ZoneIdsT = Aws::Vector<Aws::String>>
void SetZoneIds (ZoneIdsT &&value)
 
template<typename ZoneIdsT = Aws::Vector<Aws::String>>
 
template<typename ZoneIdsT = Aws::String>
 
 
 
void SetAllAvailabilityZones (bool value)
 
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (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>>
 
template<typename FiltersT = Filter>
 

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

virtual ~EC2Request ()
 
 
 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 
virtual ~AmazonWebServiceRequest ()=default
 
 
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 bool ShouldComputeContentMd5 () const
 
virtual bool ShouldValidateResponseChecksum () const
 
 
 
virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const
 
 
 
 
 
 
virtual bool RequestChecksumRequired () const
 
 
void SetRetryContext (const RetryContext &context) 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 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)
 
 

Protected Member Functions

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

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

 

Additional Inherited Members

Public Types inherited from Aws::EC2::EC2Request

 
 

Public Types inherited from Aws::AmazonWebServiceRequest

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

 

Detailed Description

Definition at line 21 of file DescribeAvailabilityZonesRequest.h.

Constructor & Destructor Documentation

◆ DescribeAvailabilityZonesRequest()

AWS_EC2_API Aws::EC2::Model::DescribeAvailabilityZonesRequest::DescribeAvailabilityZonesRequest ( )
default

Member Function Documentation

◆ AddFilters()

template<typename FiltersT = Filter>
DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::AddFilters ( FiltersT &&  value)
inline

The filters.

  • group-long-name - The long name of the zone group for the Availability Zone (for example, US West (Oregon) 1), the Local Zone (for example, for Zone group us-west-2-lax-1, it is US West (Los Angeles), or the Wavelength Zone (for example, for Zone group us-east-1-wl1, it is US East (Verizon).

  • group-name - The name of the zone group for the Availability Zone (for example, us-east-1-zg-1), the Local Zone (for example, us-west-2-lax-1), or the Wavelength Zone (for example, us-east-1-wl1).

  • message - The Zone message.

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

  • parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

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

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | unavailable | constrained).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-name

    • The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Definition at line 169 of file DescribeAvailabilityZonesRequest.h.

◆ AddZoneIds()

template<typename ZoneIdsT = Aws::String>
DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::AddZoneIds ( ZoneIdsT &&  value)
inline

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 78 of file DescribeAvailabilityZonesRequest.h.

◆ AddZoneNames()

template<typename ZoneNamesT = Aws::String>
DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::AddZoneNames ( ZoneNamesT &&  value)
inline

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 54 of file DescribeAvailabilityZonesRequest.h.

◆ AllAvailabilityZonesHasBeenSet()

bool Aws::EC2::Model::DescribeAvailabilityZonesRequest::AllAvailabilityZonesHasBeenSet ( ) const
inline

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Definition at line 93 of file DescribeAvailabilityZonesRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

AWS_EC2_API void Aws::EC2::Model::DescribeAvailabilityZonesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeAvailabilityZonesRequest::FiltersHasBeenSet ( ) const
inline

The filters.

  • group-long-name - The long name of the zone group for the Availability Zone (for example, US West (Oregon) 1), the Local Zone (for example, for Zone group us-west-2-lax-1, it is US West (Los Angeles), or the Wavelength Zone (for example, for Zone group us-east-1-wl1, it is US East (Verizon).

  • group-name - The name of the zone group for the Availability Zone (for example, us-east-1-zg-1), the Local Zone (for example, us-west-2-lax-1), or the Wavelength Zone (for example, us-east-1-wl1).

  • message - The Zone message.

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

  • parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

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

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | unavailable | constrained).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-name

    • The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Definition at line 157 of file DescribeAvailabilityZonesRequest.h.

◆ GetAllAvailabilityZones()

bool Aws::EC2::Model::DescribeAvailabilityZonesRequest::GetAllAvailabilityZones ( ) const
inline

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Definition at line 92 of file DescribeAvailabilityZonesRequest.h.

◆ GetDryRun()

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

◆ GetFilters()

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

The filters.

  • group-long-name - The long name of the zone group for the Availability Zone (for example, US West (Oregon) 1), the Local Zone (for example, for Zone group us-west-2-lax-1, it is US West (Los Angeles), or the Wavelength Zone (for example, for Zone group us-east-1-wl1, it is US East (Verizon).

  • group-name - The name of the zone group for the Availability Zone (for example, us-east-1-zg-1), the Local Zone (for example, us-west-2-lax-1), or the Wavelength Zone (for example, us-east-1-wl1).

  • message - The Zone message.

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

  • parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

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

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | unavailable | constrained).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-name

    • The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Definition at line 156 of file DescribeAvailabilityZonesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 29 of file DescribeAvailabilityZonesRequest.h.

◆ GetZoneIds()

const Aws::Vector< Aws::String > & Aws::EC2::Model::DescribeAvailabilityZonesRequest::GetZoneIds ( ) const
inline

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 65 of file DescribeAvailabilityZonesRequest.h.

◆ GetZoneNames()

const Aws::Vector< Aws::String > & Aws::EC2::Model::DescribeAvailabilityZonesRequest::GetZoneNames ( ) const
inline

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 41 of file DescribeAvailabilityZonesRequest.h.

◆ SerializePayload()

AWS_EC2_API Aws::String Aws::EC2::Model::DescribeAvailabilityZonesRequest::SerializePayload ( ) const
overridevirtual

◆ SetAllAvailabilityZones()

void Aws::EC2::Model::DescribeAvailabilityZonesRequest::SetAllAvailabilityZones ( bool  value)
inline

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Definition at line 94 of file DescribeAvailabilityZonesRequest.h.

◆ SetDryRun()

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

◆ SetFilters()

template<typename FiltersT = Aws::Vector<Filter>>
void Aws::EC2::Model::DescribeAvailabilityZonesRequest::SetFilters ( FiltersT &&  value)
inline

The filters.

  • group-long-name - The long name of the zone group for the Availability Zone (for example, US West (Oregon) 1), the Local Zone (for example, for Zone group us-west-2-lax-1, it is US West (Los Angeles), or the Wavelength Zone (for example, for Zone group us-east-1-wl1, it is US East (Verizon).

  • group-name - The name of the zone group for the Availability Zone (for example, us-east-1-zg-1), the Local Zone (for example, us-west-2-lax-1), or the Wavelength Zone (for example, us-east-1-wl1).

  • message - The Zone message.

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

  • parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

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

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | unavailable | constrained).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-name

    • The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Definition at line 159 of file DescribeAvailabilityZonesRequest.h.

◆ SetZoneIds()

template<typename ZoneIdsT = Aws::Vector<Aws::String>>
void Aws::EC2::Model::DescribeAvailabilityZonesRequest::SetZoneIds ( ZoneIdsT &&  value)
inline

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 68 of file DescribeAvailabilityZonesRequest.h.

◆ SetZoneNames()

template<typename ZoneNamesT = Aws::Vector<Aws::String>>
void Aws::EC2::Model::DescribeAvailabilityZonesRequest::SetZoneNames ( ZoneNamesT &&  value)
inline

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 44 of file DescribeAvailabilityZonesRequest.h.

◆ WithAllAvailabilityZones()

DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::WithAllAvailabilityZones ( bool  value)
inline

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Definition at line 98 of file DescribeAvailabilityZonesRequest.h.

◆ WithDryRun()

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

◆ WithFilters()

template<typename FiltersT = Aws::Vector<Filter>>
DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::WithFilters ( FiltersT &&  value)
inline

The filters.

  • group-long-name - The long name of the zone group for the Availability Zone (for example, US West (Oregon) 1), the Local Zone (for example, for Zone group us-west-2-lax-1, it is US West (Los Angeles), or the Wavelength Zone (for example, for Zone group us-east-1-wl1, it is US East (Verizon).

  • group-name - The name of the zone group for the Availability Zone (for example, us-east-1-zg-1), the Local Zone (for example, us-west-2-lax-1), or the Wavelength Zone (for example, us-east-1-wl1).

  • message - The Zone message.

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

  • parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

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

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | unavailable | constrained).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-name

    • The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Definition at line 164 of file DescribeAvailabilityZonesRequest.h.

◆ WithZoneIds()

template<typename ZoneIdsT = Aws::Vector<Aws::String>>
DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::WithZoneIds ( ZoneIdsT &&  value)
inline

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 73 of file DescribeAvailabilityZonesRequest.h.

◆ WithZoneNames()

template<typename ZoneNamesT = Aws::Vector<Aws::String>>
DescribeAvailabilityZonesRequest & Aws::EC2::Model::DescribeAvailabilityZonesRequest::WithZoneNames ( ZoneNamesT &&  value)
inline

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 49 of file DescribeAvailabilityZonesRequest.h.

◆ ZoneIdsHasBeenSet()

bool Aws::EC2::Model::DescribeAvailabilityZonesRequest::ZoneIdsHasBeenSet ( ) const
inline

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 66 of file DescribeAvailabilityZonesRequest.h.

◆ ZoneNamesHasBeenSet()

bool Aws::EC2::Model::DescribeAvailabilityZonesRequest::ZoneNamesHasBeenSet ( ) const
inline

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Definition at line 42 of file DescribeAvailabilityZonesRequest.h.


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