OpenSearchService / Client / describe_domain_nodes



Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_nodes(

DomainName (string) –


The name of the domain.

Return type:



Response Syntax

    'DomainNodesStatusList': [
            'NodeId': 'string',
            'NodeType': 'Data'|'Ultrawarm'|'Master',
            'AvailabilityZone': 'string',
            'InstanceType': ''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|'',
            'NodeStatus': 'Active'|'StandBy'|'NotAvailable',
            'StorageType': 'string',
            'StorageVolumeType': 'standard'|'gp2'|'io1'|'gp3',
            'StorageSize': 'string'

Response Structure

  • (dict) –

    The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

    • DomainNodesStatusList (list) –

      Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

      • (dict) –

        Container for information about nodes on the domain.

        • NodeId (string) –

          The ID of the node.

        • NodeType (string) –

          Indicates whether the nodes is a data, master, or ultrawarm node.

        • AvailabilityZone (string) –

          The Availability Zone of the node.

        • InstanceType (string) –

          The instance type information of the node.

        • NodeStatus (string) –

          Indicates if the node is active or in standby.

        • StorageType (string) –

          Indicates if the node has EBS or instance storage.

        • StorageVolumeType (string) –

          If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.

        • StorageSize (string) –

          The storage size of the node, in GiB.