Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AvailabilityZoneInfo - Amazon OpenSearch Service

AvailabilityZoneInfo

Information about an Availability Zone on a domain.

Contents

AvailabilityZoneName

The name of the Availability Zone.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 15.

Required: No

AvailableDataNodeCount

The number of data nodes active in the Availability Zone.

Type: String

Pattern: ^((\d+)|(NotAvailable))$

Required: No

ConfiguredDataNodeCount

The total number of data nodes configured in the Availability Zone.

Type: String

Pattern: ^((\d+)|(NotAvailable))$

Required: No

TotalShards

The total number of primary and replica shards in the Availability Zone.

Type: String

Pattern: ^((\d+)|(NotAvailable))$

Required: No

TotalUnAssignedShards

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

Type: String

Pattern: ^((\d+)|(NotAvailable))$

Required: No

ZoneStatus

The current state of the Availability Zone. Current options are Active and StandBy.

  • Active - Data nodes in the Availability Zone are in use.

  • StandBy - Data nodes in the Availability Zone are in a standby state.

  • NotAvailable - Unable to retrieve information.

Type: String

Valid Values: Active | StandBy | NotAvailable

Required: No

See Also

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.