1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package opensearch
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/opensearch/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns information about domain and node health, the standby Availability
// Zone, number of nodes per Availability Zone, and shard count per node.
func (c *Client) DescribeDomainHealth(ctx context.Context, params *DescribeDomainHealthInput, optFns ...func(*Options)) (*DescribeDomainHealthOutput, error) {
if params == nil {
params = &DescribeDomainHealthInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeDomainHealth", params, optFns, c.addOperationDescribeDomainHealthMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeDomainHealthOutput)
out.ResultMetadata = metadata
return out, nil
}
// Container for the parameters to the DescribeDomainHealth operation.
type DescribeDomainHealthInput struct {
// The name of the domain.
//
// This member is required.
DomainName *string
noSmithyDocumentSerde
}
// The result of a DescribeDomainHealth request. Contains health information for
// the requested domain.
type DescribeDomainHealthOutput struct {
// The number of active Availability Zones configured for the domain. If the
// service is unable to fetch this information, it will return NotAvailable .
ActiveAvailabilityZoneCount *string
// The number of Availability Zones configured for the domain. If the service is
// unable to fetch this information, it will return NotAvailable .
AvailabilityZoneCount *string
// The current health status of your cluster.
// - Red - At least one primary shard is not allocated to any node.
// - Yellow - All primary shards are allocated to nodes, but some replicas
// aren’t.
// - Green - All primary shards and their replicas are allocated to nodes.
// - NotAvailable - Unable to retrieve cluster health.
ClusterHealth types.DomainHealth
// The number of data nodes configured for the domain. If the service is unable to
// fetch this information, it will return NotAvailable .
DataNodeCount *string
// A boolean that indicates if dedicated master nodes are activated for the domain.
DedicatedMaster *bool
// The current state of the domain.
// - Processing - The domain has updates in progress.
// - Active - Requested changes have been processed and deployed to the domain.
DomainState types.DomainState
// A list of EnvironmentInfo for the domain.
EnvironmentInformation []types.EnvironmentInfo
// The number of nodes that can be elected as a master node. If dedicated master
// nodes is turned on, this value is the number of dedicated master nodes
// configured for the domain. If the service is unable to fetch this information,
// it will return NotAvailable .
MasterEligibleNodeCount *string
// Indicates whether the domain has an elected master node.
// - Available - The domain has an elected master node.
// - UnAvailable - The master node hasn't yet been elected, and a quorum to
// elect a new master node hasn't been reached.
MasterNode types.MasterNodeStatus
// The number of standby Availability Zones configured for the domain. If the
// service is unable to fetch this information, it will return NotAvailable .
StandByAvailabilityZoneCount *string
// The total number of primary and replica shards for the domain.
TotalShards *string
// The total number of primary and replica shards not allocated to any of the
// nodes for the cluster.
TotalUnAssignedShards *string
// The number of warm nodes configured for the domain.
WarmNodeCount *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeDomainHealthMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeDomainHealth{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeDomainHealth{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeDomainHealth"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeDomainHealthValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDomainHealth(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeDomainHealth(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeDomainHealth",
}
}
|
