@aws-sdk/client-glue 3.590.0 → 3.591.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,382 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { GlueServiceException as __BaseException } from "./GlueServiceException";
3
- import { Action, Blueprint, Column, ConnectionPropertyKey, ConnectionsList, ConnectionType, Crawler, CsvHeaderOption, CsvSerdeOption, DataFormat, DataQualityAnalyzerResult, DataQualityObservation, DataQualityRuleResult, DataSource, DevEndpoint, ErrorDetail, EventBatchingCondition, GlueTable, JobRun, Partition, PartitionInput, PartitionValueList, PhysicalConnectionRequirements, Predicate, SchemaId, StorageDescriptor, TableOptimizerConfiguration, TableOptimizerType, TaskStatusType, TriggerType, WorkerType } from "./models_0";
3
+ import { Action, AuthenticationConfiguration, AuthenticationConfigurationInput, Blueprint, Column, ConnectionsList, Crawler, CrawlerTargets, CsvHeaderOption, CsvSerdeOption, DataFormat, DataQualityAnalyzerResult, DataQualityObservation, DataQualityRuleResult, DataSource, DevEndpoint, ErrorDetail, EventBatchingCondition, GlueTable, JobRun, LakeFormationConfiguration, LineageConfiguration, Partition, PartitionInput, PartitionValueList, Predicate, RecrawlPolicy, SchemaChangePolicy, SchemaId, StorageDescriptor, TableOptimizerConfiguration, TableOptimizerType, TaskStatusType, TriggerType, WorkerType } from "./models_0";
4
+ /**
5
+ * @public
6
+ * @enum
7
+ */
8
+ export declare const ConnectionPropertyKey: {
9
+ readonly CONFIG_FILES: "CONFIG_FILES";
10
+ readonly CONNECTION_URL: "CONNECTION_URL";
11
+ readonly CONNECTOR_CLASS_NAME: "CONNECTOR_CLASS_NAME";
12
+ readonly CONNECTOR_TYPE: "CONNECTOR_TYPE";
13
+ readonly CONNECTOR_URL: "CONNECTOR_URL";
14
+ readonly CUSTOM_JDBC_CERT: "CUSTOM_JDBC_CERT";
15
+ readonly CUSTOM_JDBC_CERT_STRING: "CUSTOM_JDBC_CERT_STRING";
16
+ readonly ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD: "ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD";
17
+ readonly ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD: "ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD";
18
+ readonly ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD: "ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD";
19
+ readonly ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD: "ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD";
20
+ readonly ENCRYPTED_PASSWORD: "ENCRYPTED_PASSWORD";
21
+ readonly HOST: "HOST";
22
+ readonly INSTANCE_ID: "INSTANCE_ID";
23
+ readonly JDBC_CONNECTION_URL: "JDBC_CONNECTION_URL";
24
+ readonly JDBC_DRIVER_CLASS_NAME: "JDBC_DRIVER_CLASS_NAME";
25
+ readonly JDBC_DRIVER_JAR_URI: "JDBC_DRIVER_JAR_URI";
26
+ readonly JDBC_ENFORCE_SSL: "JDBC_ENFORCE_SSL";
27
+ readonly JDBC_ENGINE: "JDBC_ENGINE";
28
+ readonly JDBC_ENGINE_VERSION: "JDBC_ENGINE_VERSION";
29
+ readonly KAFKA_BOOTSTRAP_SERVERS: "KAFKA_BOOTSTRAP_SERVERS";
30
+ readonly KAFKA_CLIENT_KEYSTORE: "KAFKA_CLIENT_KEYSTORE";
31
+ readonly KAFKA_CLIENT_KEYSTORE_PASSWORD: "KAFKA_CLIENT_KEYSTORE_PASSWORD";
32
+ readonly KAFKA_CLIENT_KEY_PASSWORD: "KAFKA_CLIENT_KEY_PASSWORD";
33
+ readonly KAFKA_CUSTOM_CERT: "KAFKA_CUSTOM_CERT";
34
+ readonly KAFKA_SASL_GSSAPI_KEYTAB: "KAFKA_SASL_GSSAPI_KEYTAB";
35
+ readonly KAFKA_SASL_GSSAPI_KRB5_CONF: "KAFKA_SASL_GSSAPI_KRB5_CONF";
36
+ readonly KAFKA_SASL_GSSAPI_PRINCIPAL: "KAFKA_SASL_GSSAPI_PRINCIPAL";
37
+ readonly KAFKA_SASL_GSSAPI_SERVICE: "KAFKA_SASL_GSSAPI_SERVICE";
38
+ readonly KAFKA_SASL_MECHANISM: "KAFKA_SASL_MECHANISM";
39
+ readonly KAFKA_SASL_PLAIN_PASSWORD: "KAFKA_SASL_PLAIN_PASSWORD";
40
+ readonly KAFKA_SASL_PLAIN_USERNAME: "KAFKA_SASL_PLAIN_USERNAME";
41
+ readonly KAFKA_SASL_SCRAM_PASSWORD: "KAFKA_SASL_SCRAM_PASSWORD";
42
+ readonly KAFKA_SASL_SCRAM_SECRETS_ARN: "KAFKA_SASL_SCRAM_SECRETS_ARN";
43
+ readonly KAFKA_SASL_SCRAM_USERNAME: "KAFKA_SASL_SCRAM_USERNAME";
44
+ readonly KAFKA_SKIP_CUSTOM_CERT_VALIDATION: "KAFKA_SKIP_CUSTOM_CERT_VALIDATION";
45
+ readonly KAFKA_SSL_ENABLED: "KAFKA_SSL_ENABLED";
46
+ readonly PASSWORD: "PASSWORD";
47
+ readonly PORT: "PORT";
48
+ readonly ROLE_ARN: "ROLE_ARN";
49
+ readonly SECRET_ID: "SECRET_ID";
50
+ readonly SKIP_CUSTOM_JDBC_CERT_VALIDATION: "SKIP_CUSTOM_JDBC_CERT_VALIDATION";
51
+ readonly USER_NAME: "USERNAME";
52
+ };
53
+ /**
54
+ * @public
55
+ */
56
+ export type ConnectionPropertyKey = (typeof ConnectionPropertyKey)[keyof typeof ConnectionPropertyKey];
57
+ /**
58
+ * @public
59
+ * @enum
60
+ */
61
+ export declare const ConnectionType: {
62
+ readonly CUSTOM: "CUSTOM";
63
+ readonly JDBC: "JDBC";
64
+ readonly KAFKA: "KAFKA";
65
+ readonly MARKETPLACE: "MARKETPLACE";
66
+ readonly MONGODB: "MONGODB";
67
+ readonly NETWORK: "NETWORK";
68
+ readonly SALESFORCE: "SALESFORCE";
69
+ readonly SFTP: "SFTP";
70
+ };
71
+ /**
72
+ * @public
73
+ */
74
+ export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
75
+ /**
76
+ * <p>The OAuth client app in GetConnection response.</p>
77
+ * @public
78
+ */
79
+ export interface PhysicalConnectionRequirements {
80
+ /**
81
+ * <p>The subnet ID used by the connection.</p>
82
+ * @public
83
+ */
84
+ SubnetId?: string;
85
+ /**
86
+ * <p>The security group ID list used by the connection.</p>
87
+ * @public
88
+ */
89
+ SecurityGroupIdList?: string[];
90
+ /**
91
+ * <p>The connection's Availability Zone.</p>
92
+ * @public
93
+ */
94
+ AvailabilityZone?: string;
95
+ }
96
+ /**
97
+ * <p>A structure that is used to specify a connection to create or update.</p>
98
+ * @public
99
+ */
100
+ export interface ConnectionInput {
101
+ /**
102
+ * <p>The name of the connection.</p>
103
+ * @public
104
+ */
105
+ Name: string | undefined;
106
+ /**
107
+ * <p>The description of the connection.</p>
108
+ * @public
109
+ */
110
+ Description?: string;
111
+ /**
112
+ * <p>The type of the connection. Currently, these types are supported:</p>
113
+ * <ul>
114
+ * <li>
115
+ * <p>
116
+ * <code>JDBC</code> - Designates a connection to a database through Java Database Connectivity (JDBC).</p>
117
+ * <p>
118
+ * <code>JDBC</code> Connections use the following ConnectionParameters.</p>
119
+ * <ul>
120
+ * <li>
121
+ * <p>Required: All of (<code>HOST</code>, <code>PORT</code>, <code>JDBC_ENGINE</code>) or <code>JDBC_CONNECTION_URL</code>.</p>
122
+ * </li>
123
+ * <li>
124
+ * <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
125
+ * </li>
126
+ * <li>
127
+ * <p>Optional: <code>JDBC_ENFORCE_SSL</code>, <code>CUSTOM_JDBC_CERT</code>, <code>CUSTOM_JDBC_CERT_STRING</code>, <code>SKIP_CUSTOM_JDBC_CERT_VALIDATION</code>. These parameters are used to configure SSL with JDBC.</p>
128
+ * </li>
129
+ * </ul>
130
+ * </li>
131
+ * <li>
132
+ * <p>
133
+ * <code>KAFKA</code> - Designates a connection to an Apache Kafka streaming platform.</p>
134
+ * <p>
135
+ * <code>KAFKA</code> Connections use the following ConnectionParameters.</p>
136
+ * <ul>
137
+ * <li>
138
+ * <p>Required: <code>KAFKA_BOOTSTRAP_SERVERS</code>.</p>
139
+ * </li>
140
+ * <li>
141
+ * <p>Optional: <code>KAFKA_SSL_ENABLED</code>, <code>KAFKA_CUSTOM_CERT</code>, <code>KAFKA_SKIP_CUSTOM_CERT_VALIDATION</code>. These parameters are used to configure SSL with <code>KAFKA</code>.</p>
142
+ * </li>
143
+ * <li>
144
+ * <p>Optional: <code>KAFKA_CLIENT_KEYSTORE</code>, <code>KAFKA_CLIENT_KEYSTORE_PASSWORD</code>, <code>KAFKA_CLIENT_KEY_PASSWORD</code>, <code>ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD</code>, <code>ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD</code>. These parameters are used to configure TLS client configuration with SSL in <code>KAFKA</code>.</p>
145
+ * </li>
146
+ * <li>
147
+ * <p>Optional: <code>KAFKA_SASL_MECHANISM</code>. Can be specified as <code>SCRAM-SHA-512</code>, <code>GSSAPI</code>, or <code>AWS_MSK_IAM</code>.</p>
148
+ * </li>
149
+ * <li>
150
+ * <p>Optional: <code>KAFKA_SASL_SCRAM_USERNAME</code>, <code>KAFKA_SASL_SCRAM_PASSWORD</code>, <code>ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD</code>. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with <code>KAFKA</code>.</p>
151
+ * </li>
152
+ * <li>
153
+ * <p>Optional: <code>KAFKA_SASL_GSSAPI_KEYTAB</code>, <code>KAFKA_SASL_GSSAPI_KRB5_CONF</code>, <code>KAFKA_SASL_GSSAPI_SERVICE</code>, <code>KAFKA_SASL_GSSAPI_PRINCIPAL</code>. These parameters are used to configure SASL/GSSAPI authentication with <code>KAFKA</code>.</p>
154
+ * </li>
155
+ * </ul>
156
+ * </li>
157
+ * <li>
158
+ * <p>
159
+ * <code>MONGODB</code> - Designates a connection to a MongoDB document database.</p>
160
+ * <p>
161
+ * <code>MONGODB</code> Connections use the following ConnectionParameters.</p>
162
+ * <ul>
163
+ * <li>
164
+ * <p>Required: <code>CONNECTION_URL</code>.</p>
165
+ * </li>
166
+ * <li>
167
+ * <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
168
+ * </li>
169
+ * </ul>
170
+ * </li>
171
+ * <li>
172
+ * <p>
173
+ * <code>SALESFORCE</code> - Designates a connection to Salesforce using OAuth authencation.</p>
174
+ * <ul>
175
+ * <li>
176
+ * <p>Requires the <code>AuthenticationConfiguration</code> member to be configured.</p>
177
+ * </li>
178
+ * </ul>
179
+ * </li>
180
+ * <li>
181
+ * <p>
182
+ * <code>NETWORK</code> - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).</p>
183
+ * <p>
184
+ * <code>NETWORK</code> Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.</p>
185
+ * </li>
186
+ * <li>
187
+ * <p>
188
+ * <code>MARKETPLACE</code> - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.</p>
189
+ * <p>
190
+ * <code>MARKETPLACE</code> Connections use the following ConnectionParameters.</p>
191
+ * <ul>
192
+ * <li>
193
+ * <p>Required: <code>CONNECTOR_TYPE</code>, <code>CONNECTOR_URL</code>, <code>CONNECTOR_CLASS_NAME</code>, <code>CONNECTION_URL</code>.</p>
194
+ * </li>
195
+ * <li>
196
+ * <p>Required for <code>JDBC</code>
197
+ * <code>CONNECTOR_TYPE</code> connections: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p>
198
+ * </li>
199
+ * </ul>
200
+ * </li>
201
+ * <li>
202
+ * <p>
203
+ * <code>CUSTOM</code> - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.</p>
204
+ * </li>
205
+ * </ul>
206
+ * <p>
207
+ * <code>SFTP</code> is not supported.</p>
208
+ * <p>For more information about how optional ConnectionProperties are used to configure features in Glue, consult <a href="https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html">Glue connection properties</a>.</p>
209
+ * <p>For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult <a href="https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html">Using connectors and connections</a>.</p>
210
+ * @public
211
+ */
212
+ ConnectionType: ConnectionType | undefined;
213
+ /**
214
+ * <p>A list of criteria that can be used in selecting this connection.</p>
215
+ * @public
216
+ */
217
+ MatchCriteria?: string[];
218
+ /**
219
+ * <p>These key-value pairs define parameters for the connection.</p>
220
+ * @public
221
+ */
222
+ ConnectionProperties: Partial<Record<ConnectionPropertyKey, string>> | undefined;
223
+ /**
224
+ * <p>The physical connection requirements, such as virtual private cloud (VPC) and <code>SecurityGroup</code>, that are needed to successfully make this connection.</p>
225
+ * @public
226
+ */
227
+ PhysicalConnectionRequirements?: PhysicalConnectionRequirements;
228
+ /**
229
+ * <p>The authentication properties of the connection. Used for a Salesforce connection.</p>
230
+ * @public
231
+ */
232
+ AuthenticationConfiguration?: AuthenticationConfigurationInput;
233
+ /**
234
+ * <p>A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true. </p>
235
+ * @public
236
+ */
237
+ ValidateCredentials?: boolean;
238
+ }
239
+ /**
240
+ * @public
241
+ */
242
+ export interface CreateConnectionRequest {
243
+ /**
244
+ * <p>The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services
245
+ * account ID is used by default.</p>
246
+ * @public
247
+ */
248
+ CatalogId?: string;
249
+ /**
250
+ * <p>A <code>ConnectionInput</code> object defining the connection
251
+ * to create.</p>
252
+ * @public
253
+ */
254
+ ConnectionInput: ConnectionInput | undefined;
255
+ /**
256
+ * <p>The tags you assign to the connection.</p>
257
+ * @public
258
+ */
259
+ Tags?: Record<string, string>;
260
+ }
261
+ /**
262
+ * @public
263
+ * @enum
264
+ */
265
+ export declare const ConnectionStatus: {
266
+ readonly FAILED: "FAILED";
267
+ readonly IN_PROGRESS: "IN_PROGRESS";
268
+ readonly READY: "READY";
269
+ };
270
+ /**
271
+ * @public
272
+ */
273
+ export type ConnectionStatus = (typeof ConnectionStatus)[keyof typeof ConnectionStatus];
274
+ /**
275
+ * @public
276
+ */
277
+ export interface CreateConnectionResponse {
278
+ /**
279
+ * <p>The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.</p>
280
+ * @public
281
+ */
282
+ CreateConnectionStatus?: ConnectionStatus;
283
+ }
284
+ /**
285
+ * @public
286
+ */
287
+ export interface CreateCrawlerRequest {
288
+ /**
289
+ * <p>Name of the new crawler.</p>
290
+ * @public
291
+ */
292
+ Name: string | undefined;
293
+ /**
294
+ * <p>The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to
295
+ * access customer resources.</p>
296
+ * @public
297
+ */
298
+ Role: string | undefined;
299
+ /**
300
+ * <p>The Glue database where results are written, such as:
301
+ * <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>
302
+ * @public
303
+ */
304
+ DatabaseName?: string;
305
+ /**
306
+ * <p>A description of the new crawler.</p>
307
+ * @public
308
+ */
309
+ Description?: string;
310
+ /**
311
+ * <p>A list of collection of targets to crawl.</p>
312
+ * @public
313
+ */
314
+ Targets: CrawlerTargets | undefined;
315
+ /**
316
+ * <p>A <code>cron</code> expression used to specify the schedule (see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html">Time-Based Schedules for Jobs and Crawlers</a>. For example, to run
317
+ * something every day at 12:15 UTC, you would specify:
318
+ * <code>cron(15 12 * * ? *)</code>.</p>
319
+ * @public
320
+ */
321
+ Schedule?: string;
322
+ /**
323
+ * <p>A list of custom classifiers that the user has registered. By default, all built-in
324
+ * classifiers are included in a crawl, but these custom classifiers always override the default
325
+ * classifiers for a given classification.</p>
326
+ * @public
327
+ */
328
+ Classifiers?: string[];
329
+ /**
330
+ * <p>The table prefix used for catalog tables that are created.</p>
331
+ * @public
332
+ */
333
+ TablePrefix?: string;
334
+ /**
335
+ * <p>The policy for the crawler's update and deletion behavior.</p>
336
+ * @public
337
+ */
338
+ SchemaChangePolicy?: SchemaChangePolicy;
339
+ /**
340
+ * <p>A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.</p>
341
+ * @public
342
+ */
343
+ RecrawlPolicy?: RecrawlPolicy;
344
+ /**
345
+ * <p>Specifies data lineage configuration settings for the crawler.</p>
346
+ * @public
347
+ */
348
+ LineageConfiguration?: LineageConfiguration;
349
+ /**
350
+ * <p>Specifies Lake Formation configuration settings for the crawler.</p>
351
+ * @public
352
+ */
353
+ LakeFormationConfiguration?: LakeFormationConfiguration;
354
+ /**
355
+ * <p>Crawler configuration information. This versioned JSON
356
+ * string allows users to specify aspects of a crawler's behavior.
357
+ * For more information, see <a href="https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html">Setting crawler configuration options</a>.</p>
358
+ * @public
359
+ */
360
+ Configuration?: string;
361
+ /**
362
+ * <p>The name of the <code>SecurityConfiguration</code> structure to be used by this
363
+ * crawler.</p>
364
+ * @public
365
+ */
366
+ CrawlerSecurityConfiguration?: string;
367
+ /**
368
+ * <p>The tags to use with this crawler request. You may use tags to limit access to the
369
+ * crawler. For more information about tags in Glue, see <a href="https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html">Amazon Web Services Tags in Glue</a> in the developer
370
+ * guide.</p>
371
+ * @public
372
+ */
373
+ Tags?: Record<string, string>;
374
+ }
375
+ /**
376
+ * @public
377
+ */
378
+ export interface CreateCrawlerResponse {
379
+ }
4
380
  /**
5
381
  * @public
6
382
  */
@@ -4142,18 +4518,17 @@ export interface Connection {
4142
4518
  */
4143
4519
  ConnectionProperties?: Partial<Record<ConnectionPropertyKey, string>>;
4144
4520
  /**
4145
- * <p>A map of physical connection requirements, such as virtual private cloud (VPC) and
4146
- * <code>SecurityGroup</code>, that are needed to make this connection successfully.</p>
4521
+ * <p>The physical connection requirements, such as virtual private cloud (VPC) and <code>SecurityGroup</code>, that are needed to make this connection successfully.</p>
4147
4522
  * @public
4148
4523
  */
4149
4524
  PhysicalConnectionRequirements?: PhysicalConnectionRequirements;
4150
4525
  /**
4151
- * <p>The time that this connection definition was created.</p>
4526
+ * <p>The timestamp of the time that this connection definition was created.</p>
4152
4527
  * @public
4153
4528
  */
4154
4529
  CreationTime?: Date;
4155
4530
  /**
4156
- * <p>The last time that this connection definition was updated.</p>
4531
+ * <p>The timestamp of the last time the connection definition was updated.</p>
4157
4532
  * @public
4158
4533
  */
4159
4534
  LastUpdatedTime?: Date;
@@ -4162,6 +4537,26 @@ export interface Connection {
4162
4537
  * @public
4163
4538
  */
4164
4539
  LastUpdatedBy?: string;
4540
+ /**
4541
+ * <p>The status of the connection. Can be one of: <code>READY</code>, <code>IN_PROGRESS</code>, or <code>FAILED</code>.</p>
4542
+ * @public
4543
+ */
4544
+ Status?: ConnectionStatus;
4545
+ /**
4546
+ * <p>The reason for the connection status.</p>
4547
+ * @public
4548
+ */
4549
+ StatusReason?: string;
4550
+ /**
4551
+ * <p>A timestamp of the time this connection was last validated.</p>
4552
+ * @public
4553
+ */
4554
+ LastConnectionValidationTime?: Date;
4555
+ /**
4556
+ * <p>The authentication properties of the connection.</p>
4557
+ * @public
4558
+ */
4559
+ AuthenticationConfiguration?: AuthenticationConfiguration;
4165
4560
  }
4166
4561
  /**
4167
4562
  * @public
@@ -6952,182 +7347,3 @@ export interface GetSchemaByDefinitionResponse {
6952
7347
  */
6953
7348
  CreatedTime?: string;
6954
7349
  }
6955
- /**
6956
- * <p>A structure containing the schema version information.</p>
6957
- * @public
6958
- */
6959
- export interface SchemaVersionNumber {
6960
- /**
6961
- * <p>The latest version available for the schema.</p>
6962
- * @public
6963
- */
6964
- LatestVersion?: boolean;
6965
- /**
6966
- * <p>The version number of the schema.</p>
6967
- * @public
6968
- */
6969
- VersionNumber?: number;
6970
- }
6971
- /**
6972
- * @public
6973
- */
6974
- export interface GetSchemaVersionInput {
6975
- /**
6976
- * <p>This is a wrapper structure to contain schema identity fields. The structure contains:</p>
6977
- * <ul>
6978
- * <li>
6979
- * <p>SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either <code>SchemaArn</code> or <code>SchemaName</code> and <code>RegistryName</code> has to be provided.</p>
6980
- * </li>
6981
- * <li>
6982
- * <p>SchemaId$SchemaName: The name of the schema. Either <code>SchemaArn</code> or <code>SchemaName</code> and <code>RegistryName</code> has to be provided.</p>
6983
- * </li>
6984
- * </ul>
6985
- * @public
6986
- */
6987
- SchemaId?: SchemaId;
6988
- /**
6989
- * <p>The <code>SchemaVersionId</code> of the schema version. This field is required for fetching by schema ID. Either this or the <code>SchemaId</code> wrapper has to be provided.</p>
6990
- * @public
6991
- */
6992
- SchemaVersionId?: string;
6993
- /**
6994
- * <p>The version number of the schema.</p>
6995
- * @public
6996
- */
6997
- SchemaVersionNumber?: SchemaVersionNumber;
6998
- }
6999
- /**
7000
- * @public
7001
- */
7002
- export interface GetSchemaVersionResponse {
7003
- /**
7004
- * <p>The <code>SchemaVersionId</code> of the schema version.</p>
7005
- * @public
7006
- */
7007
- SchemaVersionId?: string;
7008
- /**
7009
- * <p>The schema definition for the schema ID.</p>
7010
- * @public
7011
- */
7012
- SchemaDefinition?: string;
7013
- /**
7014
- * <p>The data format of the schema definition. Currently <code>AVRO</code>, <code>JSON</code> and <code>PROTOBUF</code> are supported.</p>
7015
- * @public
7016
- */
7017
- DataFormat?: DataFormat;
7018
- /**
7019
- * <p>The Amazon Resource Name (ARN) of the schema.</p>
7020
- * @public
7021
- */
7022
- SchemaArn?: string;
7023
- /**
7024
- * <p>The version number of the schema.</p>
7025
- * @public
7026
- */
7027
- VersionNumber?: number;
7028
- /**
7029
- * <p>The status of the schema version. </p>
7030
- * @public
7031
- */
7032
- Status?: SchemaVersionStatus;
7033
- /**
7034
- * <p>The date and time the schema version was created.</p>
7035
- * @public
7036
- */
7037
- CreatedTime?: string;
7038
- }
7039
- /**
7040
- * @public
7041
- * @enum
7042
- */
7043
- export declare const SchemaDiffType: {
7044
- readonly SYNTAX_DIFF: "SYNTAX_DIFF";
7045
- };
7046
- /**
7047
- * @public
7048
- */
7049
- export type SchemaDiffType = (typeof SchemaDiffType)[keyof typeof SchemaDiffType];
7050
- /**
7051
- * @public
7052
- */
7053
- export interface GetSchemaVersionsDiffInput {
7054
- /**
7055
- * <p>This is a wrapper structure to contain schema identity fields. The structure contains:</p>
7056
- * <ul>
7057
- * <li>
7058
- * <p>SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.</p>
7059
- * </li>
7060
- * <li>
7061
- * <p>SchemaId$SchemaName: The name of the schema. One of <code>SchemaArn</code> or <code>SchemaName</code> has to be provided.</p>
7062
- * </li>
7063
- * </ul>
7064
- * @public
7065
- */
7066
- SchemaId: SchemaId | undefined;
7067
- /**
7068
- * <p>The first of the two schema versions to be compared.</p>
7069
- * @public
7070
- */
7071
- FirstSchemaVersionNumber: SchemaVersionNumber | undefined;
7072
- /**
7073
- * <p>The second of the two schema versions to be compared.</p>
7074
- * @public
7075
- */
7076
- SecondSchemaVersionNumber: SchemaVersionNumber | undefined;
7077
- /**
7078
- * <p>Refers to <code>SYNTAX_DIFF</code>, which is the currently supported diff type.</p>
7079
- * @public
7080
- */
7081
- SchemaDiffType: SchemaDiffType | undefined;
7082
- }
7083
- /**
7084
- * @public
7085
- */
7086
- export interface GetSchemaVersionsDiffResponse {
7087
- /**
7088
- * <p>The difference between schemas as a string in JsonPatch format.</p>
7089
- * @public
7090
- */
7091
- Diff?: string;
7092
- }
7093
- /**
7094
- * @public
7095
- */
7096
- export interface GetSecurityConfigurationRequest {
7097
- /**
7098
- * <p>The name of the security configuration to retrieve.</p>
7099
- * @public
7100
- */
7101
- Name: string | undefined;
7102
- }
7103
- /**
7104
- * <p>Specifies a security configuration.</p>
7105
- * @public
7106
- */
7107
- export interface SecurityConfiguration {
7108
- /**
7109
- * <p>The name of the security configuration.</p>
7110
- * @public
7111
- */
7112
- Name?: string;
7113
- /**
7114
- * <p>The time at which this security configuration was created.</p>
7115
- * @public
7116
- */
7117
- CreatedTimeStamp?: Date;
7118
- /**
7119
- * <p>The encryption configuration associated with this security configuration.</p>
7120
- * @public
7121
- */
7122
- EncryptionConfiguration?: EncryptionConfiguration;
7123
- }
7124
- /**
7125
- * @public
7126
- */
7127
- export interface GetSecurityConfigurationResponse {
7128
- /**
7129
- * <p>The requested security configuration.</p>
7130
- * @public
7131
- */
7132
- SecurityConfiguration?: SecurityConfiguration;
7133
- }