File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (297 lines) | stat: -rw-r--r-- 6,565 bytes parent folder | download | duplicates (4)
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

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

// Includes basic information for a data column such as its description, name, and
// type.
type Column struct {

	// The description for a column.
	Description *string

	// The column name.
	Name *string

	// The kind of data a column stores.
	Type *string

	noSmithyDocumentSerde
}

// The SQL query of column selections and row filters from the data table you want.
type DataQuery struct {

	// The query statement.
	//
	// This member is required.
	QueryStatement *string

	// The table configuration.
	TableConfigurations map[string]map[string]string

	noSmithyDocumentSerde
}

// The destinations used for data exports.
type DestinationConfigurations struct {

	// An object that describes the destination of the data exports file.
	//
	// This member is required.
	S3Destination *S3Destination

	noSmithyDocumentSerde
}

// The reference for the data export update.
type ExecutionReference struct {

	// The ID for this specific execution.
	//
	// This member is required.
	ExecutionId *string

	// The status of this specific execution.
	//
	// This member is required.
	ExecutionStatus *ExecutionStatus

	noSmithyDocumentSerde
}

// The status of the execution.
type ExecutionStatus struct {

	// The time when the execution was completed.
	CompletedAt *time.Time

	// The time when the execution was created.
	CreatedAt *time.Time

	// The time when the execution was last updated.
	LastUpdatedAt *time.Time

	// The code for the status of the execution.
	StatusCode ExecutionStatusCode

	// The reason for the failed status.
	StatusReason ExecutionStatusReason

	noSmithyDocumentSerde
}

// The details that are available for an export.
type Export struct {

	// The data query for this specific data export.
	//
	// This member is required.
	DataQuery *DataQuery

	// The destination configuration for this specific data export.
	//
	// This member is required.
	DestinationConfigurations *DestinationConfigurations

	// The name of this specific data export.
	//
	// This member is required.
	Name *string

	// The cadence for Amazon Web Services to update the export in your S3 bucket.
	//
	// This member is required.
	RefreshCadence *RefreshCadence

	// The description for this specific data export.
	Description *string

	// The Amazon Resource Name (ARN) for this export.
	ExportArn *string

	noSmithyDocumentSerde
}

// The reference details for a given export.
type ExportReference struct {

	// The Amazon Resource Name (ARN) for this export.
	//
	// This member is required.
	ExportArn *string

	// The name of this specific data export.
	//
	// This member is required.
	ExportName *string

	// The status of this specific data export.
	//
	// This member is required.
	ExportStatus *ExportStatus

	noSmithyDocumentSerde
}

// The status of the data export.
type ExportStatus struct {

	// The timestamp of when the export was created.
	CreatedAt *time.Time

	// The timestamp of when the export was last generated.
	LastRefreshedAt *time.Time

	// The timestamp of when the export was updated.
	LastUpdatedAt *time.Time

	// The status code for the request.
	StatusCode ExportStatusCode

	// The description for the status code.
	StatusReason ExecutionStatusReason

	noSmithyDocumentSerde
}

// The cadence for Amazon Web Services to update the data export in your S3 bucket.
type RefreshCadence struct {

	// The frequency that data exports are updated. The export refreshes each time the
	// source data updates, up to three times daily.
	//
	// This member is required.
	Frequency FrequencyOption

	noSmithyDocumentSerde
}

// The tag structure that contains a tag key and value.
type ResourceTag struct {

	// The key that's associated with the tag.
	//
	// This member is required.
	Key *string

	// The value that's associated with the tag.
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

// Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name
// and object keys of a data exports file.
type S3Destination struct {

	// The name of the Amazon S3 bucket used as the destination of a data export file.
	//
	// This member is required.
	S3Bucket *string

	// The output configuration for the data export.
	//
	// This member is required.
	S3OutputConfigurations *S3OutputConfigurations

	// The S3 path prefix you want prepended to the name of your data export.
	//
	// This member is required.
	S3Prefix *string

	// The S3 bucket Region.
	//
	// This member is required.
	S3Region *string

	noSmithyDocumentSerde
}

// The compression type, file format, and overwrite preference for the data export.
type S3OutputConfigurations struct {

	// The compression type for the data export.
	//
	// This member is required.
	Compression CompressionOption

	// The file format for the data export.
	//
	// This member is required.
	Format FormatOption

	// The output type for the data export.
	//
	// This member is required.
	OutputType S3OutputType

	// The rule to follow when generating a version of the data export file. You have
	// the choice to overwrite the previous version or to be delivered in addition to
	// the previous versions. Overwriting exports can save on Amazon S3 storage costs.
	// Creating new export versions allows you to track the changes in cost and usage
	// data over time.
	//
	// This member is required.
	Overwrite OverwriteOption

	noSmithyDocumentSerde
}

// The details for the data export table.
type Table struct {

	// The description for the table.
	Description *string

	// The name of the table.
	TableName *string

	// The properties for the table.
	TableProperties []TablePropertyDescription

	noSmithyDocumentSerde
}

// The properties for the data export table.
type TablePropertyDescription struct {

	// The default value for the table.
	DefaultValue *string

	// The description for the table.
	Description *string

	// The name of the table.
	Name *string

	// The valid values for the table.
	ValidValues []string

	noSmithyDocumentSerde
}

// The input failed to meet the constraints specified by the Amazon Web Services
// service in a specified field.
type ValidationExceptionField struct {

	// A message with the reason for the validation exception error.
	//
	// This member is required.
	Message *string

	// The field name where the invalid entry was detected.
	//
	// This member is required.
	Name *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde