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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package neptunedata
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/neptunedata/document"
"github.com/aws/aws-sdk-go-v2/service/neptunedata/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the status of the graph database on the host.
//
// When invoking this operation in a Neptune cluster that has IAM authentication
// enabled, the IAM user or role making the request must have a policy attached
// that allows the [neptune-db:GetEngineStatus]IAM action in that cluster.
//
// [neptune-db:GetEngineStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus
func (c *Client) GetEngineStatus(ctx context.Context, params *GetEngineStatusInput, optFns ...func(*Options)) (*GetEngineStatusOutput, error) {
if params == nil {
params = &GetEngineStatusInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetEngineStatus", params, optFns, c.addOperationGetEngineStatusMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetEngineStatusOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetEngineStatusInput struct {
noSmithyDocumentSerde
}
type GetEngineStatusOutput struct {
// Set to the Neptune engine version running on your DB cluster. If this engine
// version has been manually patched since it was released, the version number is
// prefixed by Patch- .
DbEngineVersion *string
// Set to enabled if the DFE engine is fully enabled, or to viaQueryHint (the
// default) if the DFE engine is only used with queries that have the useDFE query
// hint set to true .
DfeQueryEngine *string
// Contains status information about the features enabled on your DB cluster.
Features map[string]document.Interface
// Contains information about the Gremlin query language available on your
// cluster. Specifically, it contains a version field that specifies the current
// TinkerPop version being used by the engine.
Gremlin *types.QueryLanguageVersion
// Contains Lab Mode settings being used by the engine.
LabMode map[string]string
// Contains information about the openCypher query language available on your
// cluster. Specifically, it contains a version field that specifies the current
// operCypher version being used by the engine.
Opencypher *types.QueryLanguageVersion
// Set to reader if the instance is a read-replica, or to writer if the instance
// is the primary instance.
Role *string
// If there are transactions being rolled back, this field is set to the number of
// such transactions. If there are none, the field doesn't appear at all.
RollingBackTrxCount *int32
// Set to the start time of the earliest transaction being rolled back. If no
// transactions are being rolled back, the field doesn't appear at all.
RollingBackTrxEarliestStartTime *string
// Contains information about the current settings on your DB cluster. For
// example, contains the current cluster query timeout setting (
// clusterQueryTimeoutInMs ).
Settings map[string]string
// Contains information about the SPARQL query language available on your cluster.
// Specifically, it contains a version field that specifies the current SPARQL
// version being used by the engine.
Sparql *types.QueryLanguageVersion
// Set to the UTC time at which the current server process started.
StartTime *string
// Set to healthy if the instance is not experiencing problems. If the instance is
// recovering from a crash or from being rebooted and there are active transactions
// running from the latest server shutdown, status is set to recovery .
Status *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetEngineStatusMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetEngineStatus{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetEngineStatus{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetEngineStatus"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEngineStatus(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opGetEngineStatus(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetEngineStatus",
}
}
|
