com.amazonaws.services.ec2.model

Class DescribeAvailabilityZonesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeAvailabilityZonesRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAvailabilityZonesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeAvailabilityZonesRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAvailabilityZonesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeAvailabilityZonesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAllAvailabilityZones() Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
Request<DescribeAvailabilityZonesRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() The filters.
List<String>	getZoneIds() The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
List<String>	getZoneNames() The names of the Availability Zones, Local Zones, and Wavelength Zones.
int	hashCode()
Boolean	isAllAvailabilityZones() Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
void	setAllAvailabilityZones(Boolean allAvailabilityZones) Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
void	setFilters(Collection<Filter> filters) The filters.
void	setZoneIds(Collection<String> zoneIds) The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
void	setZoneNames(Collection<String> zoneNames) The names of the Availability Zones, Local Zones, and Wavelength Zones.
String	toString() Returns a string representation of this object.
DescribeAvailabilityZonesRequest	withAllAvailabilityZones(Boolean allAvailabilityZones) Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
DescribeAvailabilityZonesRequest	withFilters(Collection<Filter> filters) The filters.
DescribeAvailabilityZonesRequest	withFilters(Filter... filters) The filters.
DescribeAvailabilityZonesRequest	withZoneIds(Collection<String> zoneIds) The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
DescribeAvailabilityZonesRequest	withZoneIds(String... zoneIds) The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
DescribeAvailabilityZonesRequest	withZoneNames(Collection<String> zoneNames) The names of the Availability Zones, Local Zones, and Wavelength Zones.
DescribeAvailabilityZonesRequest	withZoneNames(String... zoneNames) The names of the Availability Zones, Local Zones, and Wavelength Zones.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAvailabilityZonesRequest

public DescribeAvailabilityZonesRequest()

Method Detail

getFilters

public List<Filter> getFilters()

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

Returns:

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

setFilters

public void setFilters(Collection<Filter> filters)

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

Parameters:

filters - The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

withFilters

public DescribeAvailabilityZonesRequest withFilters(Filter... filters)

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public DescribeAvailabilityZonesRequest withFilters(Collection<Filter> filters)

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

Parameters:

filters - The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with 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).

• 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).

Returns:

Returns a reference to this object so that method calls can be chained together.

getZoneNames

public List<String> getZoneNames()

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

Returns:

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

setZoneNames

public void setZoneNames(Collection<String> zoneNames)

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

Parameters:

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

withZoneNames

public DescribeAvailabilityZonesRequest withZoneNames(String... zoneNames)

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

NOTE: This method appends the values to the existing list (if any). Use setZoneNames(java.util.Collection) or withZoneNames(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withZoneNames

public DescribeAvailabilityZonesRequest withZoneNames(Collection<String> zoneNames)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getZoneIds

public List<String> getZoneIds()

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

Returns:

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

setZoneIds

public void setZoneIds(Collection<String> zoneIds)

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

Parameters:

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

withZoneIds

public DescribeAvailabilityZonesRequest withZoneIds(String... zoneIds)

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

NOTE: This method appends the values to the existing list (if any). Use setZoneIds(java.util.Collection) or withZoneIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withZoneIds

public DescribeAvailabilityZonesRequest withZoneIds(Collection<String> zoneIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllAvailabilityZones

public void setAllAvailabilityZones(Boolean allAvailabilityZones)

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.

Parameters:

allAvailabilityZones - 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.

getAllAvailabilityZones

public Boolean getAllAvailabilityZones()

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.

Returns:

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.

withAllAvailabilityZones

public DescribeAvailabilityZonesRequest withAllAvailabilityZones(Boolean allAvailabilityZones)

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.

Parameters:

allAvailabilityZones - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAllAvailabilityZones

public Boolean isAllAvailabilityZones()

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.

Returns:

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.

getDryRunRequest

public Request<DescribeAvailabilityZonesRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeAvailabilityZonesRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeAvailabilityZonesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()