File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (371 lines) | stat: -rw-r--r-- 9,194 bytes parent folder | download | duplicates (3)
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Contains information about an edge in a Neptune Analytics graph.
type EdgeStructure struct {

	// The number of instances of the edge in the graph.
	Count *int64

	// A list of the properties associated with the edge.
	EdgeProperties []string

	noSmithyDocumentSerde
}

// Summary information about the graph.
type GraphDataSummary struct {

	// A list of the edge labels in the graph.
	EdgeLabels []string

	// A list of the distinct edge properties in the graph, along with the count of
	// edges where each property is used.
	EdgeProperties []map[string]int64

	// This field is only present when the requested mode is DETAILED. It contains a
	// list of edge structures.
	EdgeStructures []EdgeStructure

	// A list of distinct node labels in the graph.
	NodeLabels []string

	// A list of the distinct node properties in the graph, along with the count of
	// nodes where each property is used.
	NodeProperties []map[string]int64

	// This field is only present when the requested mode is DETAILED. It contains a
	// list of node structures.
	NodeStructures []NodeStructure

	// The number of unique edge labels in the graph.
	NumEdgeLabels *int64

	// The number of edge properties in the graph.
	NumEdgeProperties *int64

	// The number of edges in the graph.
	NumEdges *int64

	// The number of distinct node labels in the graph.
	NumNodeLabels *int64

	// The number of distinct node properties in the graph.
	NumNodeProperties *int64

	// The number of nodes in the graph.
	NumNodes *int64

	// The total number of usages of all edge properties.
	TotalEdgePropertyValues *int64

	// The total number of usages of all node properties.
	TotalNodePropertyValues *int64

	noSmithyDocumentSerde
}

// Details about a graph snapshot.
type GraphSnapshotSummary struct {

	// The ARN of the graph snapshot.
	//
	// This member is required.
	Arn *string

	// The unique identifier of the graph snapshot.
	//
	// This member is required.
	Id *string

	// The snapshot name. For example: my-snapshot-1 .
	//
	// The name must contain from 1 to 63 letters, numbers, or hyphens, and its first
	// character must be a letter. It cannot end with a hyphen or contain two
	// consecutive hyphens.
	//
	// This member is required.
	Name *string

	// The ID of the KMS key used to encrypt and decrypt the snapshot.
	KmsKeyIdentifier *string

	// The time when the snapshot was created.
	SnapshotCreateTime *time.Time

	// The graph identifier for the graph for which a snapshot is to be created.
	SourceGraphId *string

	// The status of the graph snapshot.
	Status SnapshotStatus

	noSmithyDocumentSerde
}

// Summary details about a graph.
type GraphSummary struct {

	// The ARN associated with the graph.
	//
	// This member is required.
	Arn *string

	// The unique identifier of the graph.
	//
	// This member is required.
	Id *string

	// The name of the graph.
	//
	// This member is required.
	Name *string

	// If true , deletion protection is enabled for the graph.
	DeletionProtection *bool

	// The graph endpoint.
	Endpoint *string

	// The ID of the KMS key used to encrypt and decrypt graph data.
	KmsKeyIdentifier *string

	// The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the
	// graph.
	ProvisionedMemory *int32

	// If true , the graph has a public endpoint, otherwise not.
	PublicConnectivity *bool

	// The number of replicas for the graph.
	ReplicaCount *int32

	// The status of the graph.
	Status GraphStatus

	noSmithyDocumentSerde
}

// Options for how to perform an import.
//
// The following types satisfy this interface:
//
//	ImportOptionsMemberNeptune
type ImportOptions interface {
	isImportOptions()
}

// Options for importing data from a Neptune database.
type ImportOptionsMemberNeptune struct {
	Value NeptuneImportOptions

	noSmithyDocumentSerde
}

func (*ImportOptionsMemberNeptune) isImportOptions() {}

// Contains details about an import task.
type ImportTaskDetails struct {

	// The number of dictionary entries in the import task.
	//
	// This member is required.
	DictionaryEntryCount *int64

	// The number of errors encountered so far.
	//
	// This member is required.
	ErrorCount *int32

	// The percentage progress so far.
	//
	// This member is required.
	ProgressPercentage *int32

	// Time at which the import task started.
	//
	// This member is required.
	StartTime *time.Time

	// The number of statements in the import task.
	//
	// This member is required.
	StatementCount *int64

	// Status of the import task.
	//
	// This member is required.
	Status *string

	// Seconds elapsed since the import task started.
	//
	// This member is required.
	TimeElapsedSeconds *int64

	// Details about the errors that have been encountered.
	ErrorDetails *string

	noSmithyDocumentSerde
}

// Details about an import task.
type ImportTaskSummary struct {

	// The ARN of the IAM role that will allow access to the data that is to be
	// imported.
	//
	// This member is required.
	RoleArn *string

	// A URL identifying to the location of the data to be imported. This can be an
	// Amazon S3 path, or can point to a Neptune database endpoint or snapshot
	//
	// This member is required.
	Source *string

	// Status of the import task.
	//
	// This member is required.
	Status ImportTaskStatus

	// The unique identifier of the import task.
	//
	// This member is required.
	TaskId *string

	// Specifies the format of S3 data to be imported. Valid values are CSV , which
	// identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format].
	//
	// [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html
	// [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html
	Format Format

	// The unique identifier of the Neptune Analytics graph.
	GraphId *string

	noSmithyDocumentSerde
}

// Options for how to import Neptune data.
type NeptuneImportOptions struct {

	// The KMS key to use to encrypt data in the S3 bucket where the graph data is
	// exported
	//
	// This member is required.
	S3ExportKmsKeyId *string

	// The path to an S3 bucket from which to import data.
	//
	// This member is required.
	S3ExportPath *string

	// Neptune Analytics supports label-less vertices and no labels are assigned
	// unless one is explicitly provided. Neptune assigns default labels when none is
	// explicitly provided. When importing the data into Neptune Analytics, the default
	// vertex labels can be omitted by setting preserveDefaultVertexLabels to false.
	// Note that if the vertex only has default labels, and has no other properties or
	// edges, then the vertex will effectively not get imported into Neptune Analytics
	// when preserveDefaultVertexLabels is set to false.
	PreserveDefaultVertexLabels *bool

	// Neptune Analytics currently does not support user defined edge ids. The edge
	// ids are not imported by default. They are imported if preserveEdgeIds is set to
	// true, and ids are stored as properties on the relationships with the property
	// name neptuneEdgeId.
	PreserveEdgeIds *bool

	noSmithyDocumentSerde
}

// Information about a node.
type NodeStructure struct {

	// The number of instances of this node.
	Count *int64

	// The outgoing edge labels associated with this node.
	DistinctOutgoingEdgeLabels []string

	// Properties associated with this node.
	NodeProperties []string

	noSmithyDocumentSerde
}

// Details about a private graph endpoint.
type PrivateGraphEndpointSummary struct {

	// The status of the private graph endpoint.
	//
	// This member is required.
	Status PrivateGraphEndpointStatus

	// The subnet IDs associated with the private graph endpoint.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC in which the private graph endpoint is located.
	//
	// This member is required.
	VpcId *string

	// The ID of the VPC endpoint.
	VpcEndpointId *string

	noSmithyDocumentSerde
}

// Details of the query listed.
type QuerySummary struct {

	// The running time of the query, in milliseconds.
	Elapsed *int32

	// A string representation of the id of the query.
	Id *string

	// The actual query text. The queryString may be truncated if the actual query
	// string is too long.
	QueryString *string

	// State of the query.
	State QueryState

	// The amount of time, in milliseconds, the query has waited in the queue before
	// being picked up by a worker thread.
	Waited *int32

	noSmithyDocumentSerde
}

// Specifies the number of dimensions for vector embeddings loaded into the graph.
// Max = 65535
type VectorSearchConfiguration struct {

	// The number of dimensions.
	//
	// This member is required.
	Dimension *int32

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde

// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
	Tag   string
	Value []byte

	noSmithyDocumentSerde
}

func (*UnknownUnionMember) isImportOptions() {}