@aws-sdk/client-datazone 3.999.0 → 3.1001.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.
- package/README.md +7 -0
- package/dist-cjs/index.js +39 -8
- package/dist-cjs/schemas/schemas_0.js +113 -40
- package/dist-es/DataZone.js +4 -0
- package/dist-es/commands/QueryGraphCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +18 -8
- package/dist-es/pagination/QueryGraphPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +96 -23
- package/dist-types/DataZone.d.ts +14 -0
- package/dist-types/DataZoneClient.d.ts +3 -2
- package/dist-types/commands/CreateSubscriptionTargetCommand.d.ts +2 -1
- package/dist-types/commands/QueryGraphCommand.d.ts +169 -0
- package/dist-types/commands/SearchListingsCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +50 -16
- package/dist-types/models/models_0.d.ts +11 -85
- package/dist-types/models/models_1.d.ts +263 -274
- package/dist-types/models/models_2.d.ts +345 -3
- package/dist-types/pagination/QueryGraphPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +9 -0
- package/dist-types/ts3.4/DataZone.d.ts +24 -0
- package/dist-types/ts3.4/DataZoneClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateSubscriptionTargetCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/QueryGraphCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/SearchListingsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +25 -10
- package/dist-types/ts3.4/models/models_0.d.ts +3 -18
- package/dist-types/ts3.4/models/models_1.d.ts +69 -104
- package/dist-types/ts3.4/models/models_2.d.ts +143 -1
- package/dist-types/ts3.4/pagination/QueryGraphPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +9 -0
- package/package.json +14 -14
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
|
|
4
|
+
import type { QueryGraphOutput } from "../models/models_1";
|
|
5
|
+
import type { QueryGraphInput } from "../models/models_2";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link QueryGraphCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface QueryGraphCommandInput extends QueryGraphInput {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link QueryGraphCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface QueryGraphCommandOutput extends QueryGraphOutput, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
declare const QueryGraphCommand_base: {
|
|
26
|
+
new (input: QueryGraphCommandInput): import("@smithy/smithy-client").CommandImpl<QueryGraphCommandInput, QueryGraphCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: QueryGraphCommandInput): import("@smithy/smithy-client").CommandImpl<QueryGraphCommandInput, QueryGraphCommandOutput, DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* <p>Queries entities in the graph store.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { DataZoneClient, QueryGraphCommand } from "@aws-sdk/client-datazone"; // ES Modules import
|
|
36
|
+
* // const { DataZoneClient, QueryGraphCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
|
|
37
|
+
* // import type { DataZoneClientConfig } from "@aws-sdk/client-datazone";
|
|
38
|
+
* const config = {}; // type is DataZoneClientConfig
|
|
39
|
+
* const client = new DataZoneClient(config);
|
|
40
|
+
* const input = { // QueryGraphInput
|
|
41
|
+
* domainIdentifier: "STRING_VALUE", // required
|
|
42
|
+
* match: [ // MatchClauses // required
|
|
43
|
+
* { // MatchClause Union: only one key present
|
|
44
|
+
* relationPattern: { // RelationPattern
|
|
45
|
+
* relationType: "LINEAGE", // required
|
|
46
|
+
* relationDirection: "IN" || "OUT", // required
|
|
47
|
+
* maxPathLength: Number("int"),
|
|
48
|
+
* },
|
|
49
|
+
* entityPattern: { // EntityPattern
|
|
50
|
+
* entityType: "LINEAGE_NODE", // required
|
|
51
|
+
* identifier: "STRING_VALUE", // required
|
|
52
|
+
* filters: { // FilterClause Union: only one key present
|
|
53
|
+
* filter: { // Filter
|
|
54
|
+
* attribute: "STRING_VALUE", // required
|
|
55
|
+
* value: "STRING_VALUE",
|
|
56
|
+
* intValue: Number("long"),
|
|
57
|
+
* operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
|
|
58
|
+
* },
|
|
59
|
+
* and: [ // FilterList
|
|
60
|
+
* {// Union: only one key present
|
|
61
|
+
* filter: {
|
|
62
|
+
* attribute: "STRING_VALUE", // required
|
|
63
|
+
* value: "STRING_VALUE",
|
|
64
|
+
* intValue: Number("long"),
|
|
65
|
+
* operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
|
|
66
|
+
* },
|
|
67
|
+
* and: [
|
|
68
|
+
* "<FilterClause>",
|
|
69
|
+
* ],
|
|
70
|
+
* or: [
|
|
71
|
+
* "<FilterClause>",
|
|
72
|
+
* ],
|
|
73
|
+
* },
|
|
74
|
+
* ],
|
|
75
|
+
* or: [
|
|
76
|
+
* "<FilterClause>",
|
|
77
|
+
* ],
|
|
78
|
+
* },
|
|
79
|
+
* },
|
|
80
|
+
* },
|
|
81
|
+
* ],
|
|
82
|
+
* maxResults: Number("int"),
|
|
83
|
+
* nextToken: "STRING_VALUE",
|
|
84
|
+
* additionalAttributes: { // AdditionalAttributes
|
|
85
|
+
* formNames: [ // FormNameList
|
|
86
|
+
* "STRING_VALUE",
|
|
87
|
+
* ],
|
|
88
|
+
* },
|
|
89
|
+
* };
|
|
90
|
+
* const command = new QueryGraphCommand(input);
|
|
91
|
+
* const response = await client.send(command);
|
|
92
|
+
* // { // QueryGraphOutput
|
|
93
|
+
* // items: [ // ResultItemList
|
|
94
|
+
* // { // ResultItem Union: only one key present
|
|
95
|
+
* // lineageNode: { // LineageNodeItem
|
|
96
|
+
* // domainId: "STRING_VALUE", // required
|
|
97
|
+
* // name: "STRING_VALUE",
|
|
98
|
+
* // description: "STRING_VALUE",
|
|
99
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
100
|
+
* // createdBy: "STRING_VALUE",
|
|
101
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
102
|
+
* // updatedBy: "STRING_VALUE",
|
|
103
|
+
* // id: "STRING_VALUE", // required
|
|
104
|
+
* // typeName: "STRING_VALUE", // required
|
|
105
|
+
* // typeRevision: "STRING_VALUE",
|
|
106
|
+
* // sourceIdentifier: "STRING_VALUE",
|
|
107
|
+
* // eventTimestamp: new Date("TIMESTAMP"),
|
|
108
|
+
* // formsOutput: [ // FormOutputList
|
|
109
|
+
* // { // FormOutput
|
|
110
|
+
* // formName: "STRING_VALUE", // required
|
|
111
|
+
* // typeName: "STRING_VALUE",
|
|
112
|
+
* // typeRevision: "STRING_VALUE",
|
|
113
|
+
* // content: "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // upstreamLineageNodeIds: [ // LineageNodeIds
|
|
117
|
+
* // "STRING_VALUE",
|
|
118
|
+
* // ],
|
|
119
|
+
* // downstreamLineageNodeIds: [
|
|
120
|
+
* // "STRING_VALUE",
|
|
121
|
+
* // ],
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // ],
|
|
125
|
+
* // nextToken: "STRING_VALUE",
|
|
126
|
+
* // };
|
|
127
|
+
*
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @param QueryGraphCommandInput - {@link QueryGraphCommandInput}
|
|
131
|
+
* @returns {@link QueryGraphCommandOutput}
|
|
132
|
+
* @see {@link QueryGraphCommandInput} for command's `input` shape.
|
|
133
|
+
* @see {@link QueryGraphCommandOutput} for command's `response` shape.
|
|
134
|
+
* @see {@link DataZoneClientResolvedConfig | config} for DataZoneClient's `config` shape.
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
137
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link InternalServerException} (server fault)
|
|
140
|
+
* <p>The request has failed because of an unknown error, exception or failure.</p>
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
143
|
+
* <p>The request was denied due to request throttling.</p>
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link ValidationException} (client fault)
|
|
146
|
+
* <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
149
|
+
* <p>You do not have permission to perform this action.</p>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link DataZoneServiceException}
|
|
152
|
+
* <p>Base exception class for all service exceptions from DataZone service.</p>
|
|
153
|
+
*
|
|
154
|
+
*
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
export declare class QueryGraphCommand extends QueryGraphCommand_base {
|
|
158
|
+
/** @internal type navigation helper, not in runtime. */
|
|
159
|
+
protected static __types: {
|
|
160
|
+
api: {
|
|
161
|
+
input: QueryGraphInput;
|
|
162
|
+
output: QueryGraphOutput;
|
|
163
|
+
};
|
|
164
|
+
sdk: {
|
|
165
|
+
input: QueryGraphCommandInput;
|
|
166
|
+
output: QueryGraphCommandOutput;
|
|
167
|
+
};
|
|
168
|
+
};
|
|
169
|
+
}
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient";
|
|
4
|
-
import type { SearchListingsOutput } from "../models/
|
|
5
|
-
import type { SearchListingsInput } from "../models/models_2";
|
|
4
|
+
import type { SearchListingsInput, SearchListingsOutput } from "../models/models_2";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -138,6 +138,7 @@ export * from "./PostLineageEventCommand";
|
|
|
138
138
|
export * from "./PostTimeSeriesDataPointsCommand";
|
|
139
139
|
export * from "./PutDataExportConfigurationCommand";
|
|
140
140
|
export * from "./PutEnvironmentBlueprintConfigurationCommand";
|
|
141
|
+
export * from "./QueryGraphCommand";
|
|
141
142
|
export * from "./RejectPredictionsCommand";
|
|
142
143
|
export * from "./RejectSubscriptionRequestCommand";
|
|
143
144
|
export * from "./RemoveEntityOwnerCommand";
|
|
@@ -1244,6 +1244,56 @@ export declare const MetadataGenerationTargetType: {
|
|
|
1244
1244
|
* @public
|
|
1245
1245
|
*/
|
|
1246
1246
|
export type MetadataGenerationTargetType = (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType];
|
|
1247
|
+
/**
|
|
1248
|
+
* @public
|
|
1249
|
+
* @enum
|
|
1250
|
+
*/
|
|
1251
|
+
export declare const GraphEntityType: {
|
|
1252
|
+
readonly LINEAGE_NODE: "LINEAGE_NODE";
|
|
1253
|
+
};
|
|
1254
|
+
/**
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
export type GraphEntityType = (typeof GraphEntityType)[keyof typeof GraphEntityType];
|
|
1258
|
+
/**
|
|
1259
|
+
* @public
|
|
1260
|
+
* @enum
|
|
1261
|
+
*/
|
|
1262
|
+
export declare const FilterOperator: {
|
|
1263
|
+
readonly EQ: "EQ";
|
|
1264
|
+
readonly GE: "GE";
|
|
1265
|
+
readonly GT: "GT";
|
|
1266
|
+
readonly LE: "LE";
|
|
1267
|
+
readonly LT: "LT";
|
|
1268
|
+
readonly TEXT_SEARCH: "TEXT_SEARCH";
|
|
1269
|
+
};
|
|
1270
|
+
/**
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
|
|
1274
|
+
/**
|
|
1275
|
+
* @public
|
|
1276
|
+
* @enum
|
|
1277
|
+
*/
|
|
1278
|
+
export declare const RelationDirection: {
|
|
1279
|
+
readonly IN: "IN";
|
|
1280
|
+
readonly OUT: "OUT";
|
|
1281
|
+
};
|
|
1282
|
+
/**
|
|
1283
|
+
* @public
|
|
1284
|
+
*/
|
|
1285
|
+
export type RelationDirection = (typeof RelationDirection)[keyof typeof RelationDirection];
|
|
1286
|
+
/**
|
|
1287
|
+
* @public
|
|
1288
|
+
* @enum
|
|
1289
|
+
*/
|
|
1290
|
+
export declare const RelationType: {
|
|
1291
|
+
readonly LINEAGE: "LINEAGE";
|
|
1292
|
+
};
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
export type RelationType = (typeof RelationType)[keyof typeof RelationType];
|
|
1247
1297
|
/**
|
|
1248
1298
|
* @public
|
|
1249
1299
|
* @enum
|
|
@@ -1269,22 +1319,6 @@ export declare const SearchOutputAdditionalAttribute: {
|
|
|
1269
1319
|
* @public
|
|
1270
1320
|
*/
|
|
1271
1321
|
export type SearchOutputAdditionalAttribute = (typeof SearchOutputAdditionalAttribute)[keyof typeof SearchOutputAdditionalAttribute];
|
|
1272
|
-
/**
|
|
1273
|
-
* @public
|
|
1274
|
-
* @enum
|
|
1275
|
-
*/
|
|
1276
|
-
export declare const FilterOperator: {
|
|
1277
|
-
readonly EQ: "EQ";
|
|
1278
|
-
readonly GE: "GE";
|
|
1279
|
-
readonly GT: "GT";
|
|
1280
|
-
readonly LE: "LE";
|
|
1281
|
-
readonly LT: "LT";
|
|
1282
|
-
readonly TEXT_SEARCH: "TEXT_SEARCH";
|
|
1283
|
-
};
|
|
1284
|
-
/**
|
|
1285
|
-
* @public
|
|
1286
|
-
*/
|
|
1287
|
-
export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
|
|
1288
1322
|
/**
|
|
1289
1323
|
* @public
|
|
1290
1324
|
* @enum
|
|
@@ -998,6 +998,17 @@ export interface AddEntityOwnerInput {
|
|
|
998
998
|
*/
|
|
999
999
|
export interface AddEntityOwnerOutput {
|
|
1000
1000
|
}
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>Additional details on the queried entity that can be requested in the response.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
export interface AdditionalAttributes {
|
|
1006
|
+
/**
|
|
1007
|
+
* <p>Names of forms on the query entity that can be requested in the response.</p>
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
formNames?: string[] | undefined;
|
|
1011
|
+
}
|
|
1001
1012
|
/**
|
|
1002
1013
|
* <p>The details of the policy grant.</p>
|
|
1003
1014
|
* @public
|
|
@@ -10037,88 +10048,3 @@ export interface CreateSubscriptionTargetInput {
|
|
|
10037
10048
|
*/
|
|
10038
10049
|
subscriptionGrantCreationMode?: SubscriptionGrantCreationMode | undefined;
|
|
10039
10050
|
}
|
|
10040
|
-
/**
|
|
10041
|
-
* @public
|
|
10042
|
-
*/
|
|
10043
|
-
export interface CreateSubscriptionTargetOutput {
|
|
10044
|
-
/**
|
|
10045
|
-
* <p>The ID of the subscription target.</p>
|
|
10046
|
-
* @public
|
|
10047
|
-
*/
|
|
10048
|
-
id: string | undefined;
|
|
10049
|
-
/**
|
|
10050
|
-
* <p>The authorised principals of the subscription target.</p>
|
|
10051
|
-
* @public
|
|
10052
|
-
*/
|
|
10053
|
-
authorizedPrincipals: string[] | undefined;
|
|
10054
|
-
/**
|
|
10055
|
-
* <p>The ID of the Amazon DataZone domain in which the subscription target was created.</p>
|
|
10056
|
-
* @public
|
|
10057
|
-
*/
|
|
10058
|
-
domainId: string | undefined;
|
|
10059
|
-
/**
|
|
10060
|
-
* <p>???</p>
|
|
10061
|
-
* @public
|
|
10062
|
-
*/
|
|
10063
|
-
projectId: string | undefined;
|
|
10064
|
-
/**
|
|
10065
|
-
* <p>The ID of the environment in which the subscription target was created.</p>
|
|
10066
|
-
* @public
|
|
10067
|
-
*/
|
|
10068
|
-
environmentId: string | undefined;
|
|
10069
|
-
/**
|
|
10070
|
-
* <p>The name of the subscription target.</p>
|
|
10071
|
-
* @public
|
|
10072
|
-
*/
|
|
10073
|
-
name: string | undefined;
|
|
10074
|
-
/**
|
|
10075
|
-
* <p>The type of the subscription target.</p>
|
|
10076
|
-
* @public
|
|
10077
|
-
*/
|
|
10078
|
-
type: string | undefined;
|
|
10079
|
-
/**
|
|
10080
|
-
* <p>The Amazon DataZone user who created the subscription target.</p>
|
|
10081
|
-
* @public
|
|
10082
|
-
*/
|
|
10083
|
-
createdBy: string | undefined;
|
|
10084
|
-
/**
|
|
10085
|
-
* <p>The Amazon DataZone user who updated the subscription target.</p>
|
|
10086
|
-
* @public
|
|
10087
|
-
*/
|
|
10088
|
-
updatedBy?: string | undefined;
|
|
10089
|
-
/**
|
|
10090
|
-
* <p>The timestamp of when the subscription target was created.</p>
|
|
10091
|
-
* @public
|
|
10092
|
-
*/
|
|
10093
|
-
createdAt: Date | undefined;
|
|
10094
|
-
/**
|
|
10095
|
-
* <p>The timestamp of when the subscription target was updated.</p>
|
|
10096
|
-
* @public
|
|
10097
|
-
*/
|
|
10098
|
-
updatedAt?: Date | undefined;
|
|
10099
|
-
/**
|
|
10100
|
-
* <p>The manage access role with which the subscription target was created.</p>
|
|
10101
|
-
* @public
|
|
10102
|
-
*/
|
|
10103
|
-
manageAccessRole?: string | undefined;
|
|
10104
|
-
/**
|
|
10105
|
-
* <p>The asset types that can be included in the subscription target.</p>
|
|
10106
|
-
* @public
|
|
10107
|
-
*/
|
|
10108
|
-
applicableAssetTypes: string[] | undefined;
|
|
10109
|
-
/**
|
|
10110
|
-
* <p>The configuration of the subscription target.</p>
|
|
10111
|
-
* @public
|
|
10112
|
-
*/
|
|
10113
|
-
subscriptionTargetConfig: SubscriptionTargetForm[] | undefined;
|
|
10114
|
-
/**
|
|
10115
|
-
* <p>The provider of the subscription target.</p>
|
|
10116
|
-
* @public
|
|
10117
|
-
*/
|
|
10118
|
-
provider: string | undefined;
|
|
10119
|
-
/**
|
|
10120
|
-
* <p> Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually. </p>
|
|
10121
|
-
* @public
|
|
10122
|
-
*/
|
|
10123
|
-
subscriptionGrantCreationMode?: SubscriptionGrantCreationMode | undefined;
|
|
10124
|
-
}
|