@aws-sdk/client-datazone 3.600.0 → 3.609.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.
Files changed (39) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +298 -41
  3. package/dist-es/DataZone.js +6 -0
  4. package/dist-es/commands/GetLineageNodeCommand.js +25 -0
  5. package/dist-es/commands/ListLineageNodeHistoryCommand.js +24 -0
  6. package/dist-es/commands/ListNotificationsCommand.js +1 -1
  7. package/dist-es/commands/PostLineageEventCommand.js +25 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/models/models_0.js +12 -29
  10. package/dist-es/models/models_1.js +41 -1
  11. package/dist-es/pagination/ListLineageNodeHistoryPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/protocols/Aws_restJson1.js +169 -5
  14. package/dist-types/DataZone.d.ts +21 -0
  15. package/dist-types/DataZoneClient.d.ts +5 -2
  16. package/dist-types/commands/GetLineageNodeCommand.d.ts +111 -0
  17. package/dist-types/commands/ListLineageNodeHistoryCommand.d.ts +101 -0
  18. package/dist-types/commands/ListNotificationsCommand.d.ts +2 -1
  19. package/dist-types/commands/PostLineageEventCommand.d.ts +90 -0
  20. package/dist-types/commands/SearchTypesCommand.d.ts +18 -1
  21. package/dist-types/commands/index.d.ts +3 -0
  22. package/dist-types/models/models_0.d.ts +256 -145
  23. package/dist-types/models/models_1.d.ts +271 -2
  24. package/dist-types/pagination/ListLineageNodeHistoryPaginator.d.ts +7 -0
  25. package/dist-types/pagination/index.d.ts +1 -0
  26. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  27. package/dist-types/ts3.4/DataZone.d.ts +51 -0
  28. package/dist-types/ts3.4/DataZoneClient.d.ts +18 -0
  29. package/dist-types/ts3.4/commands/GetLineageNodeCommand.d.ts +36 -0
  30. package/dist-types/ts3.4/commands/ListLineageNodeHistoryCommand.d.ts +40 -0
  31. package/dist-types/ts3.4/commands/ListNotificationsCommand.d.ts +2 -4
  32. package/dist-types/ts3.4/commands/PostLineageEventCommand.d.ts +49 -0
  33. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  34. package/dist-types/ts3.4/models/models_0.d.ts +67 -57
  35. package/dist-types/ts3.4/models/models_1.d.ts +90 -1
  36. package/dist-types/ts3.4/pagination/ListLineageNodeHistoryPaginator.d.ts +11 -0
  37. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  38. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  39. package/package.json +35 -35
@@ -7314,6 +7314,126 @@ export interface GetIamPortalLoginUrlOutput {
7314
7314
  */
7315
7315
  userProfileId: string | undefined;
7316
7316
  }
7317
+ /**
7318
+ * @public
7319
+ */
7320
+ export interface GetLineageNodeInput {
7321
+ /**
7322
+ * <p>The ID of the domain in which you want to get the data lineage node.</p>
7323
+ * @public
7324
+ */
7325
+ domainIdentifier: string | undefined;
7326
+ /**
7327
+ * <p>The ID of the data lineage node that you want to get.</p>
7328
+ * <p>Both, a lineage node identifier generated by Amazon DataZone and a
7329
+ * <code>sourceIdentifier</code> of the lineage node are supported. If
7330
+ * <code>sourceIdentifier</code> is greater than 1800 characters, you can use lineage node
7331
+ * identifier generated by Amazon DataZone to get the node details.</p>
7332
+ * @public
7333
+ */
7334
+ identifier: string | undefined;
7335
+ /**
7336
+ * <p>The event time stamp for which you want to get the data lineage node.</p>
7337
+ * @public
7338
+ */
7339
+ eventTimestamp?: Date;
7340
+ }
7341
+ /**
7342
+ * <p>The reference details for the data lineage node.</p>
7343
+ * @public
7344
+ */
7345
+ export interface LineageNodeReference {
7346
+ /**
7347
+ * <p>The ID of the data lineage node.</p>
7348
+ * @public
7349
+ */
7350
+ id?: string;
7351
+ /**
7352
+ * <p>The event timestamp of the data lineage node.</p>
7353
+ * @public
7354
+ */
7355
+ eventTimestamp?: Date;
7356
+ }
7357
+ /**
7358
+ * @public
7359
+ */
7360
+ export interface GetLineageNodeOutput {
7361
+ /**
7362
+ * <p>The ID of the domain where you're getting the data lineage node.</p>
7363
+ * @public
7364
+ */
7365
+ domainId: string | undefined;
7366
+ /**
7367
+ * <p>The name of the data lineage node.</p>
7368
+ * @public
7369
+ */
7370
+ name?: string;
7371
+ /**
7372
+ * <p>The description of the data lineage node.</p>
7373
+ * @public
7374
+ */
7375
+ description?: string;
7376
+ /**
7377
+ * <p>The timestamp at which the data lineage node was created.</p>
7378
+ * @public
7379
+ */
7380
+ createdAt?: Date;
7381
+ /**
7382
+ * <p>The user who created the data lineage node.</p>
7383
+ * @public
7384
+ */
7385
+ createdBy?: string;
7386
+ /**
7387
+ * <p>The timestamp at which the data lineage node was updated.</p>
7388
+ * @public
7389
+ */
7390
+ updatedAt?: Date;
7391
+ /**
7392
+ * <p>The user who updated the data lineage node.</p>
7393
+ * @public
7394
+ */
7395
+ updatedBy?: string;
7396
+ /**
7397
+ * <p>The ID of the data lineage node.</p>
7398
+ * @public
7399
+ */
7400
+ id: string | undefined;
7401
+ /**
7402
+ * <p>The name of the type of the specified data lineage node.</p>
7403
+ * @public
7404
+ */
7405
+ typeName: string | undefined;
7406
+ /**
7407
+ * <p>The revision type of the specified data lineage node.</p>
7408
+ * @public
7409
+ */
7410
+ typeRevision?: string;
7411
+ /**
7412
+ * <p>The source identifier of the data lineage node.</p>
7413
+ * @public
7414
+ */
7415
+ sourceIdentifier?: string;
7416
+ /**
7417
+ * <p>The timestamp of the event described in the data lineage node.</p>
7418
+ * @public
7419
+ */
7420
+ eventTimestamp?: Date;
7421
+ /**
7422
+ * <p>The metadata of the specified data lineage node.</p>
7423
+ * @public
7424
+ */
7425
+ formsOutput?: FormOutput[];
7426
+ /**
7427
+ * <p>The upstream nodes of the specified data lineage node.</p>
7428
+ * @public
7429
+ */
7430
+ upstreamNodes?: LineageNodeReference[];
7431
+ /**
7432
+ * <p>The downsteam nodes of the specified data lineage node.</p>
7433
+ * @public
7434
+ */
7435
+ downstreamNodes?: LineageNodeReference[];
7436
+ }
7317
7437
  /**
7318
7438
  * @public
7319
7439
  */
@@ -8967,225 +9087,165 @@ export interface GetListingOutput {
8967
9087
  * @public
8968
9088
  * @enum
8969
9089
  */
8970
- export declare const TaskStatus: {
8971
- readonly ACTIVE: "ACTIVE";
8972
- readonly INACTIVE: "INACTIVE";
9090
+ export declare const EdgeDirection: {
9091
+ readonly DOWNSTREAM: "DOWNSTREAM";
9092
+ readonly UPSTREAM: "UPSTREAM";
8973
9093
  };
8974
9094
  /**
8975
9095
  * @public
8976
9096
  */
8977
- export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
9097
+ export type EdgeDirection = (typeof EdgeDirection)[keyof typeof EdgeDirection];
8978
9098
  /**
8979
9099
  * @public
8980
9100
  * @enum
8981
9101
  */
8982
- export declare const NotificationType: {
8983
- readonly EVENT: "EVENT";
8984
- readonly TASK: "TASK";
9102
+ export declare const SortOrder: {
9103
+ readonly ASCENDING: "ASCENDING";
9104
+ readonly DESCENDING: "DESCENDING";
8985
9105
  };
8986
9106
  /**
8987
9107
  * @public
8988
9108
  */
8989
- export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
9109
+ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
8990
9110
  /**
8991
9111
  * @public
8992
9112
  */
8993
- export interface ListNotificationsInput {
9113
+ export interface ListLineageNodeHistoryInput {
8994
9114
  /**
8995
- * <p>The identifier of the Amazon DataZone domain.</p>
9115
+ * <p>The ID of the domain where you want to list the history of the specified data lineage
9116
+ * node.</p>
8996
9117
  * @public
8997
9118
  */
8998
9119
  domainIdentifier: string | undefined;
8999
9120
  /**
9000
- * <p>The type of notifications.</p>
9121
+ * <p>The maximum number of history items to return in a single call to
9122
+ * ListLineageNodeHistory. When the number of memberships to be listed is greater than the
9123
+ * value of MaxResults, the response contains a NextToken value that you can use in a
9124
+ * subsequent call to ListLineageNodeHistory to list the next set of items.</p>
9001
9125
  * @public
9002
9126
  */
9003
- type: NotificationType | undefined;
9127
+ maxResults?: number;
9004
9128
  /**
9005
- * <p>The time after which you want to list notifications.</p>
9129
+ * <p>When the number of history items is greater than the default value for the MaxResults
9130
+ * parameter, or if you explicitly specify a value for MaxResults that is less than the number
9131
+ * of items, the response includes a pagination token named NextToken. You can specify this
9132
+ * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of
9133
+ * items.</p>
9006
9134
  * @public
9007
9135
  */
9008
- afterTimestamp?: Date;
9136
+ nextToken?: string;
9009
9137
  /**
9010
- * <p>The time before which you want to list notifications.</p>
9138
+ * <p>The ID of the data lineage node whose history you want to list.</p>
9011
9139
  * @public
9012
9140
  */
9013
- beforeTimestamp?: Date;
9141
+ identifier: string | undefined;
9014
9142
  /**
9015
- * <p>The subjects of notifications.</p>
9143
+ * <p>The direction of the data lineage node refers to the lineage node having neighbors in
9144
+ * that direction. For example, if direction is <code>UPSTREAM</code>, the
9145
+ * <code>ListLineageNodeHistory</code> API responds with historical versions with upstream
9146
+ * neighbors only.</p>
9016
9147
  * @public
9017
9148
  */
9018
- subjects?: string[];
9149
+ direction?: EdgeDirection;
9019
9150
  /**
9020
- * <p>The task status of notifications.</p>
9151
+ * <p>Specifies whether the action is to return data lineage node history from the time after
9152
+ * the event timestamp.</p>
9021
9153
  * @public
9022
9154
  */
9023
- taskStatus?: TaskStatus;
9155
+ eventTimestampGTE?: Date;
9024
9156
  /**
9025
- * <p>The maximum number of notifications to return in a single call to
9026
- * <code>ListNotifications</code>. When the number of notifications to be listed is greater
9027
- * than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code>
9028
- * value that you can use in a subsequent call to <code>ListNotifications</code> to list the
9029
- * next set of notifications.</p>
9157
+ * <p>Specifies whether the action is to return data lineage node history from the time prior
9158
+ * of the event timestamp.</p>
9030
9159
  * @public
9031
9160
  */
9032
- maxResults?: number;
9161
+ eventTimestampLTE?: Date;
9033
9162
  /**
9034
- * <p>When the number of notifications is greater than the default value for the
9035
- * <code>MaxResults</code> parameter, or if you explicitly specify a value for
9036
- * <code>MaxResults</code> that is less than the number of notifications, the response
9037
- * includes a pagination token named <code>NextToken</code>. You can specify this
9038
- * <code>NextToken</code> value in a subsequent call to <code>ListNotifications</code> to
9039
- * list the next set of notifications.</p>
9163
+ * <p>The order by which you want data lineage node history to be sorted.</p>
9040
9164
  * @public
9041
9165
  */
9042
- nextToken?: string;
9166
+ sortOrder?: SortOrder;
9043
9167
  }
9044
9168
  /**
9045
- * @public
9046
- * @enum
9047
- */
9048
- export declare const NotificationResourceType: {
9049
- readonly PROJECT: "PROJECT";
9050
- };
9051
- /**
9169
+ * <p>The summary of the data lineage node.</p>
9052
9170
  * @public
9053
9171
  */
9054
- export type NotificationResourceType = (typeof NotificationResourceType)[keyof typeof NotificationResourceType];
9055
- /**
9056
- * <p>The details of the resource mentioned in a notification.</p>
9057
- * @public
9058
- */
9059
- export interface NotificationResource {
9172
+ export interface LineageNodeSummary {
9060
9173
  /**
9061
- * <p>The type of the resource mentioned in a notification.</p>
9174
+ * <p>The ID of the domain of the data lineage node.</p>
9062
9175
  * @public
9063
9176
  */
9064
- type: NotificationResourceType | undefined;
9065
- /**
9066
- * <p>The ID of the resource mentioned in a notification.</p>
9067
- * @public
9068
- */
9069
- id: string | undefined;
9177
+ domainId: string | undefined;
9070
9178
  /**
9071
- * <p>The name of the resource mentioned in a notification.</p>
9179
+ * <p>The name of the data lineage node.</p>
9072
9180
  * @public
9073
9181
  */
9074
9182
  name?: string;
9075
- }
9076
- /**
9077
- * @public
9078
- * @enum
9079
- */
9080
- export declare const NotificationRole: {
9081
- readonly DOMAIN_OWNER: "DOMAIN_OWNER";
9082
- readonly PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR";
9083
- readonly PROJECT_OWNER: "PROJECT_OWNER";
9084
- readonly PROJECT_SUBSCRIBER: "PROJECT_SUBSCRIBER";
9085
- readonly PROJECT_VIEWER: "PROJECT_VIEWER";
9086
- };
9087
- /**
9088
- * @public
9089
- */
9090
- export type NotificationRole = (typeof NotificationRole)[keyof typeof NotificationRole];
9091
- /**
9092
- * <p>The topic of the notification.</p>
9093
- * @public
9094
- */
9095
- export interface Topic {
9096
- /**
9097
- * <p>The subject of the resource mentioned in a notification.</p>
9098
- * @public
9099
- */
9100
- subject: string | undefined;
9101
- /**
9102
- * <p>The details of the resource mentioned in a notification.</p>
9103
- * @public
9104
- */
9105
- resource: NotificationResource | undefined;
9106
- /**
9107
- * <p>The role of the resource mentioned in a notification.</p>
9108
- * @public
9109
- */
9110
- role: NotificationRole | undefined;
9111
- }
9112
- /**
9113
- * <p>The details of a notification generated in Amazon DataZone.</p>
9114
- * @public
9115
- */
9116
- export interface NotificationOutput {
9117
9183
  /**
9118
- * <p>The identifier of the notification.</p>
9184
+ * <p>The description of the data lineage node.</p>
9119
9185
  * @public
9120
9186
  */
9121
- identifier: string | undefined;
9122
- /**
9123
- * <p>The identifier of a Amazon DataZone domain in which the notification exists.</p>
9124
- * @public
9125
- */
9126
- domainIdentifier: string | undefined;
9187
+ description?: string;
9127
9188
  /**
9128
- * <p>The type of the notification.</p>
9189
+ * <p>The timestamp at which the data lineage node was created.</p>
9129
9190
  * @public
9130
9191
  */
9131
- type: NotificationType | undefined;
9192
+ createdAt?: Date;
9132
9193
  /**
9133
- * <p>The topic of the notification.</p>
9194
+ * <p>The user who created the data lineage node.</p>
9134
9195
  * @public
9135
9196
  */
9136
- topic: Topic | undefined;
9197
+ createdBy?: string;
9137
9198
  /**
9138
- * <p>The title of the notification.</p>
9199
+ * <p>The timestamp at which the data lineage node was updated.</p>
9139
9200
  * @public
9140
9201
  */
9141
- title: string | undefined;
9202
+ updatedAt?: Date;
9142
9203
  /**
9143
- * <p>The message included in the notification.</p>
9204
+ * <p>The user who updated the data lineage node.</p>
9144
9205
  * @public
9145
9206
  */
9146
- message: string | undefined;
9207
+ updatedBy?: string;
9147
9208
  /**
9148
- * <p>The status included in the notification.</p>
9209
+ * <p>The ID of the data lineage node.</p>
9149
9210
  * @public
9150
9211
  */
9151
- status?: TaskStatus;
9212
+ id: string | undefined;
9152
9213
  /**
9153
- * <p>The action link included in the notification.</p>
9214
+ * <p>The name of the type of the data lineage node.</p>
9154
9215
  * @public
9155
9216
  */
9156
- actionLink: string | undefined;
9217
+ typeName: string | undefined;
9157
9218
  /**
9158
- * <p>The timestamp of when a notification was created.</p>
9219
+ * <p>The type of the revision of the data lineage node.</p>
9159
9220
  * @public
9160
9221
  */
9161
- creationTimestamp: Date | undefined;
9222
+ typeRevision?: string;
9162
9223
  /**
9163
- * <p>The timestamp of when the notification was last updated.</p>
9224
+ * <p>The alternate ID of the data lineage node.</p>
9164
9225
  * @public
9165
9226
  */
9166
- lastUpdatedTimestamp: Date | undefined;
9227
+ sourceIdentifier?: string;
9167
9228
  /**
9168
- * <p>The metadata included in the notification.</p>
9229
+ * <p>The event timestamp of the data lineage node.</p>
9169
9230
  * @public
9170
9231
  */
9171
- metadata?: Record<string, string>;
9232
+ eventTimestamp?: Date;
9172
9233
  }
9173
9234
  /**
9174
9235
  * @public
9175
9236
  */
9176
- export interface ListNotificationsOutput {
9237
+ export interface ListLineageNodeHistoryOutput {
9177
9238
  /**
9178
- * <p>The results of the <code>ListNotifications</code> action.</p>
9239
+ * <p>The nodes returned by the ListLineageNodeHistory action.</p>
9179
9240
  * @public
9180
9241
  */
9181
- notifications?: NotificationOutput[];
9242
+ nodes?: LineageNodeSummary[];
9182
9243
  /**
9183
- * <p>When the number of notifications is greater than the default value for the
9184
- * <code>MaxResults</code> parameter, or if you explicitly specify a value for
9185
- * <code>MaxResults</code> that is less than the number of notifications, the response
9186
- * includes a pagination token named <code>NextToken</code>. You can specify this
9187
- * <code>NextToken</code> value in a subsequent call to <code>ListNotifications</code> to
9188
- * list the next set of notifications.</p>
9244
+ * <p>When the number of history items is greater than the default value for the MaxResults
9245
+ * parameter, or if you explicitly specify a value for MaxResults that is less than the number
9246
+ * of items, the response includes a pagination token named NextToken. You can specify this
9247
+ * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of
9248
+ * items.</p>
9189
9249
  * @public
9190
9250
  */
9191
9251
  nextToken?: string;
@@ -9194,25 +9254,80 @@ export interface ListNotificationsOutput {
9194
9254
  * @public
9195
9255
  * @enum
9196
9256
  */
9197
- export declare const SortFieldProject: {
9198
- readonly NAME: "NAME";
9257
+ export declare const TaskStatus: {
9258
+ readonly ACTIVE: "ACTIVE";
9259
+ readonly INACTIVE: "INACTIVE";
9199
9260
  };
9200
9261
  /**
9201
9262
  * @public
9202
9263
  */
9203
- export type SortFieldProject = (typeof SortFieldProject)[keyof typeof SortFieldProject];
9264
+ export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
9204
9265
  /**
9205
9266
  * @public
9206
9267
  * @enum
9207
9268
  */
9208
- export declare const SortOrder: {
9209
- readonly ASCENDING: "ASCENDING";
9210
- readonly DESCENDING: "DESCENDING";
9269
+ export declare const NotificationType: {
9270
+ readonly EVENT: "EVENT";
9271
+ readonly TASK: "TASK";
9211
9272
  };
9212
9273
  /**
9213
9274
  * @public
9214
9275
  */
9215
- export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
9276
+ export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
9277
+ /**
9278
+ * @public
9279
+ */
9280
+ export interface ListNotificationsInput {
9281
+ /**
9282
+ * <p>The identifier of the Amazon DataZone domain.</p>
9283
+ * @public
9284
+ */
9285
+ domainIdentifier: string | undefined;
9286
+ /**
9287
+ * <p>The type of notifications.</p>
9288
+ * @public
9289
+ */
9290
+ type: NotificationType | undefined;
9291
+ /**
9292
+ * <p>The time after which you want to list notifications.</p>
9293
+ * @public
9294
+ */
9295
+ afterTimestamp?: Date;
9296
+ /**
9297
+ * <p>The time before which you want to list notifications.</p>
9298
+ * @public
9299
+ */
9300
+ beforeTimestamp?: Date;
9301
+ /**
9302
+ * <p>The subjects of notifications.</p>
9303
+ * @public
9304
+ */
9305
+ subjects?: string[];
9306
+ /**
9307
+ * <p>The task status of notifications.</p>
9308
+ * @public
9309
+ */
9310
+ taskStatus?: TaskStatus;
9311
+ /**
9312
+ * <p>The maximum number of notifications to return in a single call to
9313
+ * <code>ListNotifications</code>. When the number of notifications to be listed is greater
9314
+ * than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code>
9315
+ * value that you can use in a subsequent call to <code>ListNotifications</code> to list the
9316
+ * next set of notifications.</p>
9317
+ * @public
9318
+ */
9319
+ maxResults?: number;
9320
+ /**
9321
+ * <p>When the number of notifications is greater than the default value for the
9322
+ * <code>MaxResults</code> parameter, or if you explicitly specify a value for
9323
+ * <code>MaxResults</code> that is less than the number of notifications, the response
9324
+ * includes a pagination token named <code>NextToken</code>. You can specify this
9325
+ * <code>NextToken</code> value in a subsequent call to <code>ListNotifications</code> to
9326
+ * list the next set of notifications.</p>
9327
+ * @public
9328
+ */
9329
+ nextToken?: string;
9330
+ }
9216
9331
  /**
9217
9332
  * @internal
9218
9333
  */
@@ -9485,6 +9600,10 @@ export declare const GetEnvironmentProfileOutputFilterSensitiveLog: (obj: GetEnv
9485
9600
  * @internal
9486
9601
  */
9487
9602
  export declare const GetGroupProfileOutputFilterSensitiveLog: (obj: GetGroupProfileOutput) => any;
9603
+ /**
9604
+ * @internal
9605
+ */
9606
+ export declare const GetLineageNodeOutputFilterSensitiveLog: (obj: GetLineageNodeOutput) => any;
9488
9607
  /**
9489
9608
  * @internal
9490
9609
  */
@@ -9569,11 +9688,3 @@ export declare const ListingItemFilterSensitiveLog: (obj: ListingItem) => any;
9569
9688
  * @internal
9570
9689
  */
9571
9690
  export declare const GetListingOutputFilterSensitiveLog: (obj: GetListingOutput) => any;
9572
- /**
9573
- * @internal
9574
- */
9575
- export declare const NotificationOutputFilterSensitiveLog: (obj: NotificationOutput) => any;
9576
- /**
9577
- * @internal
9578
- */
9579
- export declare const ListNotificationsOutputFilterSensitiveLog: (obj: ListNotificationsOutput) => any;