DescribeCustomAvailabilityZones - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeCustomAvailabilityZones

Returns information about custom Availability Zones (AZs).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CustomAvailabilityZoneId

The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

Type: String

Required: No

Filters.Filter.N

A filter that specifies one or more custom AZs to describe.

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

CustomAvailabilityZones.CustomAvailabilityZone.N

The list of CustomAvailabilityZone objects for the Amazon account.

Type: Array of CustomAvailabilityZone objects

Marker

An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

CustomAvailabilityZoneNotFound

CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of DescribeCustomAvailabilityZones.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=DescribeCustomAvailabilityZones &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AIDACKCEVSQ6C2EXAMPLE/20201217/us-east-1/rds/aws4_request &X-Amz-Date=20201217T223855Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=ced6826de92d2bdeed8f846f0bf508e8559e98e4b0194b84example54174deb456c

Sample Response

<DescribeCustomAvailabilityZonesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <DescribeCustomAvailabilityZonesResult> <CustomAvailabilityZones> <CustomAvailabilityZone> <CustomAvailabilityZoneName>custom-az-1</CustomAvailabilityZoneName> <VpnDetails> <VpnGatewayIp>192.0.2.0</VpnGatewayIp> <VpnTunnelOriginatorIP>198.51.100.0</VpnTunnelOriginatorIP> <VpnId>3604EXAMPLE-7bdEXAMPLE</VpnId> <VpnState>AVAILABLE</VpnState> <VpnPSK>388cEXAMPLE</VpnPSK> <VpnName>vpn-EXAMPLE1</VpnName> </VpnDetails> <CustomAvailabilityZoneId>rds-caz-EXAMPLE1</CustomAvailabilityZoneId> <CustomAvailabilityZoneStatus>CREATING</CustomAvailabilityZoneStatus> </CustomAvailabilityZone> <CustomAvailabilityZone> <CustomAvailabilityZoneName>custom-az-2</CustomAvailabilityZoneName> <VpnDetails> <VpnGatewayIp>198.51.100.0</VpnGatewayIp> <VpnTunnelOriginatorIP>203.0.113.0</VpnTunnelOriginatorIP> <VpnId>360EXAMPLE-82EXAMPLE</VpnId> <VpnState>AVAILABLE</VpnState> <VpnPSK>c95cEXAMPLE</VpnPSK> <VpnName>vpn-EXAMPLE2</VpnName> </VpnDetails> <CustomAvailabilityZoneId>rds-caz-EXAMPLE2</CustomAvailabilityZoneId> <CustomAvailabilityZoneStatus>CREATING</CustomAvailabilityZoneStatus> </CustomAvailabilityZone> </CustomAvailabilityZones> </DescribeCustomAvailabilityZonesResult> <ResponseMetadata> <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId> </ResponseMetadata> <DescribeCustomAvailabilityZonesResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: