@aws-sdk/client-datazone 3.930.0 → 3.932.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 (33) hide show
  1. package/dist-cjs/index.js +120 -47
  2. package/dist-es/models/models_0.js +10 -25
  3. package/dist-es/models/models_1.js +19 -0
  4. package/dist-es/schemas/schemas_0.js +109 -40
  5. package/dist-types/commands/AcceptSubscriptionRequestCommand.d.ts +36 -0
  6. package/dist-types/commands/CancelSubscriptionCommand.d.ts +23 -0
  7. package/dist-types/commands/CreateProjectCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateSubscriptionGrantCommand.d.ts +6 -0
  9. package/dist-types/commands/CreateSubscriptionRequestCommand.d.ts +50 -0
  10. package/dist-types/commands/DeleteSubscriptionGrantCommand.d.ts +6 -0
  11. package/dist-types/commands/GetSubscriptionCommand.d.ts +23 -0
  12. package/dist-types/commands/GetSubscriptionGrantCommand.d.ts +6 -0
  13. package/dist-types/commands/GetSubscriptionRequestDetailsCommand.d.ts +23 -0
  14. package/dist-types/commands/ListSubscriptionGrantsCommand.d.ts +10 -1
  15. package/dist-types/commands/ListSubscriptionRequestsCommand.d.ts +26 -1
  16. package/dist-types/commands/ListSubscriptionsCommand.d.ts +26 -2
  17. package/dist-types/commands/RejectSubscriptionRequestCommand.d.ts +23 -0
  18. package/dist-types/commands/RevokeSubscriptionCommand.d.ts +23 -0
  19. package/dist-types/commands/UpdateSubscriptionGrantStatusCommand.d.ts +6 -0
  20. package/dist-types/commands/UpdateSubscriptionRequestCommand.d.ts +23 -0
  21. package/dist-types/models/models_0.d.ts +224 -234
  22. package/dist-types/models/models_1.d.ts +320 -379
  23. package/dist-types/models/models_2.d.ts +325 -3
  24. package/dist-types/schemas/schemas_0.d.ts +9 -1
  25. package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +2 -1
  26. package/dist-types/ts3.4/commands/ListSubscriptionGrantsCommand.d.ts +2 -4
  27. package/dist-types/ts3.4/commands/ListSubscriptionRequestsCommand.d.ts +1 -1
  28. package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +4 -2
  29. package/dist-types/ts3.4/models/models_0.d.ts +96 -87
  30. package/dist-types/ts3.4/models/models_1.d.ts +121 -106
  31. package/dist-types/ts3.4/models/models_2.d.ts +76 -6
  32. package/dist-types/ts3.4/schemas/schemas_0.d.ts +9 -1
  33. package/package.json +5 -5
@@ -1,4 +1,225 @@
1
- import { AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetRevision, AssetScope, AssetTargetNameMap, AssetTypesForRule, AwsAccount, ConfigurableEnvironmentAction, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionScope, ConnectionSummary, ConnectionType, CustomParameter, DataProductItem, DataProductStatus, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainStatus, DomainUnitOwnerProperties, DomainVersion, EnableSetting, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentStatus, FilterStatus, FormInput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, ListingStatus, ManagedPolicyType, MatchRationaleItem, Member, Model, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, RecommendationConfiguration, ResolutionStrategy, Resource, ResourceTag, RuleScopeSelectionMode, ScheduleConfiguration, SingleSignOn, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, UserDesignation } from "./models_0";
1
+ import { AcceptedAssetScope, AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetPermission, AssetRevision, AssetScope, AssetTargetNameMap, AssetTypesForRule, AwsAccount, ConfigurableEnvironmentAction, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionScope, ConnectionSummary, ConnectionType, CustomParameter, DataProductItem, DataProductStatus, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainStatus, DomainUnitOwnerProperties, DomainVersion, EnableSetting, EnvironmentConfigurationUserParameter, EnvironmentError, EnvironmentStatus, FilterStatus, FormInput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, ListingStatus, ManagedPolicyType, MatchRationaleItem, Model, OverallDeploymentStatus, Permissions, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProvisioningProperties, RecommendationConfiguration, ResolutionStrategy, Resource, RuleScopeSelectionMode, ScheduleConfiguration, SingleSignOn, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, UserProfileDetails } from "./models_0";
2
+ /**
3
+ * <p>The environment deployment details.</p>
4
+ * @public
5
+ */
6
+ export interface EnvironmentDeploymentDetails {
7
+ /**
8
+ * <p>The overall deployment status of the environment.</p>
9
+ * @public
10
+ */
11
+ overallDeploymentStatus?: OverallDeploymentStatus | undefined;
12
+ /**
13
+ * <p>Environment failure reasons.</p>
14
+ * @public
15
+ */
16
+ environmentFailureReasons?: Record<string, EnvironmentError[]> | undefined;
17
+ }
18
+ /**
19
+ * <p>Specifies the error message that is returned if the operation cannot be successfully completed.</p>
20
+ * @public
21
+ */
22
+ export interface ProjectDeletionError {
23
+ /**
24
+ * <p>The code of the project deletion error.</p>
25
+ * @public
26
+ */
27
+ code?: string | undefined;
28
+ /**
29
+ * <p>The message of the project deletion error.</p>
30
+ * @public
31
+ */
32
+ message?: string | undefined;
33
+ }
34
+ /**
35
+ * @public
36
+ * @enum
37
+ */
38
+ export declare const ProjectStatus: {
39
+ readonly ACTIVE: "ACTIVE";
40
+ readonly DELETE_FAILED: "DELETE_FAILED";
41
+ readonly DELETING: "DELETING";
42
+ readonly MOVING: "MOVING";
43
+ readonly UPDATE_FAILED: "UPDATE_FAILED";
44
+ readonly UPDATING: "UPDATING";
45
+ };
46
+ /**
47
+ * @public
48
+ */
49
+ export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus];
50
+ /**
51
+ * @public
52
+ * @enum
53
+ */
54
+ export declare const ResourceTagSource: {
55
+ readonly PROJECT: "PROJECT";
56
+ readonly PROJECT_PROFILE: "PROJECT_PROFILE";
57
+ };
58
+ /**
59
+ * @public
60
+ */
61
+ export type ResourceTagSource = (typeof ResourceTagSource)[keyof typeof ResourceTagSource];
62
+ /**
63
+ * <p>The resource tag of the project.</p>
64
+ * @public
65
+ */
66
+ export interface ResourceTag {
67
+ /**
68
+ * <p>The key of the resource tag of the project.</p>
69
+ * @public
70
+ */
71
+ key: string | undefined;
72
+ /**
73
+ * <p>The value of the resource tag of the project.</p>
74
+ * @public
75
+ */
76
+ value: string | undefined;
77
+ /**
78
+ * <p>The source of the resource tag of the project.</p>
79
+ * @public
80
+ */
81
+ source: ResourceTagSource | undefined;
82
+ }
83
+ /**
84
+ * @public
85
+ */
86
+ export interface CreateProjectOutput {
87
+ /**
88
+ * <p>The identifier of the Amazon DataZone domain in which the project was created.</p>
89
+ * @public
90
+ */
91
+ domainId: string | undefined;
92
+ /**
93
+ * <p>The ID of the Amazon DataZone project.</p>
94
+ * @public
95
+ */
96
+ id: string | undefined;
97
+ /**
98
+ * <p>The name of the project.</p>
99
+ * @public
100
+ */
101
+ name: string | undefined;
102
+ /**
103
+ * <p>The description of the project.</p>
104
+ * @public
105
+ */
106
+ description?: string | undefined;
107
+ /**
108
+ * <p>The status of the Amazon DataZone project that was created.</p>
109
+ * @public
110
+ */
111
+ projectStatus?: ProjectStatus | undefined;
112
+ /**
113
+ * <p>Specifies the error message that is returned if the operation cannot be successfully completed.</p>
114
+ * @public
115
+ */
116
+ failureReasons?: ProjectDeletionError[] | undefined;
117
+ /**
118
+ * <p>The Amazon DataZone user who created the project.</p>
119
+ * @public
120
+ */
121
+ createdBy: string | undefined;
122
+ /**
123
+ * <p>The timestamp of when the project was created.</p>
124
+ * @public
125
+ */
126
+ createdAt?: Date | undefined;
127
+ /**
128
+ * <p>The timestamp of when the project was last updated.</p>
129
+ * @public
130
+ */
131
+ lastUpdatedAt?: Date | undefined;
132
+ /**
133
+ * <p>The resource tags of the project.</p>
134
+ * @public
135
+ */
136
+ resourceTags?: ResourceTag[] | undefined;
137
+ /**
138
+ * <p>The glossary terms that can be used in the project.</p>
139
+ * @public
140
+ */
141
+ glossaryTerms?: string[] | undefined;
142
+ /**
143
+ * <p>The ID of the domain unit.</p>
144
+ * @public
145
+ */
146
+ domainUnitId?: string | undefined;
147
+ /**
148
+ * <p>The project profile ID.</p>
149
+ * @public
150
+ */
151
+ projectProfileId?: string | undefined;
152
+ /**
153
+ * <p>The user parameters of the project.</p>
154
+ * @public
155
+ */
156
+ userParameters?: EnvironmentConfigurationUserParameter[] | undefined;
157
+ /**
158
+ * <p>The environment deployment details.</p>
159
+ * @public
160
+ */
161
+ environmentDeploymentDetails?: EnvironmentDeploymentDetails | undefined;
162
+ }
163
+ /**
164
+ * @public
165
+ * @enum
166
+ */
167
+ export declare const UserDesignation: {
168
+ readonly PROJECT_CATALOG_CONSUMER: "PROJECT_CATALOG_CONSUMER";
169
+ readonly PROJECT_CATALOG_STEWARD: "PROJECT_CATALOG_STEWARD";
170
+ readonly PROJECT_CATALOG_VIEWER: "PROJECT_CATALOG_VIEWER";
171
+ readonly PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR";
172
+ readonly PROJECT_OWNER: "PROJECT_OWNER";
173
+ };
174
+ /**
175
+ * @public
176
+ */
177
+ export type UserDesignation = (typeof UserDesignation)[keyof typeof UserDesignation];
178
+ /**
179
+ * <p>The details about a project member.</p>
180
+ * @public
181
+ */
182
+ export type Member = Member.GroupIdentifierMember | Member.UserIdentifierMember | Member.$UnknownMember;
183
+ /**
184
+ * @public
185
+ */
186
+ export declare namespace Member {
187
+ /**
188
+ * <p>The user ID of a project member.</p>
189
+ * @public
190
+ */
191
+ interface UserIdentifierMember {
192
+ userIdentifier: string;
193
+ groupIdentifier?: never;
194
+ $unknown?: never;
195
+ }
196
+ /**
197
+ * <p>The ID of the group of a project member.</p>
198
+ * @public
199
+ */
200
+ interface GroupIdentifierMember {
201
+ userIdentifier?: never;
202
+ groupIdentifier: string;
203
+ $unknown?: never;
204
+ }
205
+ /**
206
+ * @public
207
+ */
208
+ interface $UnknownMember {
209
+ userIdentifier?: never;
210
+ groupIdentifier?: never;
211
+ $unknown: [string, any];
212
+ }
213
+ /**
214
+ * @deprecated unused in schema-serde mode.
215
+ *
216
+ */
217
+ interface Visitor<T> {
218
+ userIdentifier: (value: string) => T;
219
+ groupIdentifier: (value: string) => T;
220
+ _: (name: string, value: any) => T;
221
+ }
222
+ }
2
223
  /**
3
224
  * @public
4
225
  */
@@ -780,6 +1001,11 @@ export interface SubscribedAsset {
780
1001
  * @public
781
1002
  */
782
1003
  assetScope?: AssetScope | undefined;
1004
+ /**
1005
+ * <p>The asset permissions.</p>
1006
+ * @public
1007
+ */
1008
+ permissions?: Permissions | undefined;
783
1009
  }
784
1010
  /**
785
1011
  * <p>A revision of an asset published in a Amazon DataZone catalog.</p>
@@ -881,6 +1107,11 @@ export interface CreateSubscriptionGrantOutput {
881
1107
  * @public
882
1108
  */
883
1109
  updatedAt: Date | undefined;
1110
+ /**
1111
+ * <p>The environment ID for which subscription grant is created.</p>
1112
+ * @public
1113
+ */
1114
+ environmentId?: string | undefined;
884
1115
  /**
885
1116
  * <p>The ID of the subscription target for which the subscription grant is created.</p>
886
1117
  * @public
@@ -920,6 +1151,17 @@ export interface SubscribedListingInput {
920
1151
  */
921
1152
  identifier: string | undefined;
922
1153
  }
1154
+ /**
1155
+ * <p>The details of the subscribed group.</p>
1156
+ * @public
1157
+ */
1158
+ export interface SubscribedGroupInput {
1159
+ /**
1160
+ * <p>The ID of the subscribed group.</p>
1161
+ * @public
1162
+ */
1163
+ identifier?: string | undefined;
1164
+ }
923
1165
  /**
924
1166
  * <p>The project that is to be given a subscription grant.</p>
925
1167
  * @public
@@ -931,11 +1173,22 @@ export interface SubscribedProjectInput {
931
1173
  */
932
1174
  identifier?: string | undefined;
933
1175
  }
1176
+ /**
1177
+ * <p>The subscribed user.</p>
1178
+ * @public
1179
+ */
1180
+ export interface SubscribedUserInput {
1181
+ /**
1182
+ * <p>The ID of the subscribed user.</p>
1183
+ * @public
1184
+ */
1185
+ identifier?: string | undefined;
1186
+ }
934
1187
  /**
935
1188
  * <p>The principal that is to be given a subscriptiong grant.</p>
936
1189
  * @public
937
1190
  */
938
- export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember;
1191
+ export type SubscribedPrincipalInput = SubscribedPrincipalInput.GroupMember | SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.UserMember | SubscribedPrincipalInput.$UnknownMember;
939
1192
  /**
940
1193
  * @public
941
1194
  */
@@ -946,6 +1199,28 @@ export declare namespace SubscribedPrincipalInput {
946
1199
  */
947
1200
  interface ProjectMember {
948
1201
  project: SubscribedProjectInput;
1202
+ user?: never;
1203
+ group?: never;
1204
+ $unknown?: never;
1205
+ }
1206
+ /**
1207
+ * <p>The subscribed user.</p>
1208
+ * @public
1209
+ */
1210
+ interface UserMember {
1211
+ project?: never;
1212
+ user: SubscribedUserInput;
1213
+ group?: never;
1214
+ $unknown?: never;
1215
+ }
1216
+ /**
1217
+ * <p>The subscribed group.</p>
1218
+ * @public
1219
+ */
1220
+ interface GroupMember {
1221
+ project?: never;
1222
+ user?: never;
1223
+ group: SubscribedGroupInput;
949
1224
  $unknown?: never;
950
1225
  }
951
1226
  /**
@@ -953,6 +1228,8 @@ export declare namespace SubscribedPrincipalInput {
953
1228
  */
954
1229
  interface $UnknownMember {
955
1230
  project?: never;
1231
+ user?: never;
1232
+ group?: never;
956
1233
  $unknown: [string, any];
957
1234
  }
958
1235
  /**
@@ -961,6 +1238,8 @@ export declare namespace SubscribedPrincipalInput {
961
1238
  */
962
1239
  interface Visitor<T> {
963
1240
  project: (value: SubscribedProjectInput) => T;
1241
+ user: (value: SubscribedUserInput) => T;
1242
+ group: (value: SubscribedGroupInput) => T;
964
1243
  _: (name: string, value: any) => T;
965
1244
  }
966
1245
  }
@@ -998,6 +1277,16 @@ export interface CreateSubscriptionRequestInput {
998
1277
  * @public
999
1278
  */
1000
1279
  metadataForms?: FormInput[] | undefined;
1280
+ /**
1281
+ * <p>The asset permissions of the subscription request.</p>
1282
+ * @public
1283
+ */
1284
+ assetPermissions?: AssetPermission[] | undefined;
1285
+ /**
1286
+ * <p>The asset scopes of the subscription request.</p>
1287
+ * @public
1288
+ */
1289
+ assetScopes?: AcceptedAssetScope[] | undefined;
1001
1290
  }
1002
1291
  /**
1003
1292
  * @public
@@ -1263,88 +1552,6 @@ export interface CreateUserProfileInput {
1263
1552
  */
1264
1553
  clientToken?: string | undefined;
1265
1554
  }
1266
- /**
1267
- * <p>The details of an IAM user profile in Amazon DataZone.</p>
1268
- * @public
1269
- */
1270
- export interface IamUserProfileDetails {
1271
- /**
1272
- * <p>The ARN of an IAM user profile in Amazon DataZone.</p>
1273
- * @public
1274
- */
1275
- arn?: string | undefined;
1276
- /**
1277
- * <p>Principal ID of the IAM user.</p>
1278
- * @public
1279
- */
1280
- principalId?: string | undefined;
1281
- }
1282
- /**
1283
- * <p>The single sign-on details of the user profile.</p>
1284
- * @public
1285
- */
1286
- export interface SsoUserProfileDetails {
1287
- /**
1288
- * <p>The username included in the single sign-on details of the user profile.</p>
1289
- * @public
1290
- */
1291
- username?: string | undefined;
1292
- /**
1293
- * <p>The first name included in the single sign-on details of the user profile.</p>
1294
- * @public
1295
- */
1296
- firstName?: string | undefined;
1297
- /**
1298
- * <p>The last name included in the single sign-on details of the user profile.</p>
1299
- * @public
1300
- */
1301
- lastName?: string | undefined;
1302
- }
1303
- /**
1304
- * <p>The details of the user profile in Amazon DataZone.</p>
1305
- * @public
1306
- */
1307
- export type UserProfileDetails = UserProfileDetails.IamMember | UserProfileDetails.SsoMember | UserProfileDetails.$UnknownMember;
1308
- /**
1309
- * @public
1310
- */
1311
- export declare namespace UserProfileDetails {
1312
- /**
1313
- * <p>The IAM details included in the user profile details.</p>
1314
- * @public
1315
- */
1316
- interface IamMember {
1317
- iam: IamUserProfileDetails;
1318
- sso?: never;
1319
- $unknown?: never;
1320
- }
1321
- /**
1322
- * <p>The single sign-on details included in the user profile details.</p>
1323
- * @public
1324
- */
1325
- interface SsoMember {
1326
- iam?: never;
1327
- sso: SsoUserProfileDetails;
1328
- $unknown?: never;
1329
- }
1330
- /**
1331
- * @public
1332
- */
1333
- interface $UnknownMember {
1334
- iam?: never;
1335
- sso?: never;
1336
- $unknown: [string, any];
1337
- }
1338
- /**
1339
- * @deprecated unused in schema-serde mode.
1340
- *
1341
- */
1342
- interface Visitor<T> {
1343
- iam: (value: IamUserProfileDetails) => T;
1344
- sso: (value: SsoUserProfileDetails) => T;
1345
- _: (name: string, value: any) => T;
1346
- }
1347
- }
1348
1555
  /**
1349
1556
  * @public
1350
1557
  * @enum
@@ -1396,7 +1603,7 @@ export interface CreateUserProfileOutput {
1396
1603
  */
1397
1604
  status?: UserProfileStatus | undefined;
1398
1605
  /**
1399
- * <p>The details of the user profile in Amazon DataZone.</p>
1606
+ * <p>The user profile details.</p>
1400
1607
  * @public
1401
1608
  */
1402
1609
  details?: UserProfileDetails | undefined;
@@ -3229,6 +3436,11 @@ export interface DeleteSubscriptionGrantOutput {
3229
3436
  * @public
3230
3437
  */
3231
3438
  updatedAt: Date | undefined;
3439
+ /**
3440
+ * <p>The ID of the environment in which the subscription grant is deleted.</p>
3441
+ * @public
3442
+ */
3443
+ environmentId?: string | undefined;
3232
3444
  /**
3233
3445
  * <p>The ID of the subscription target associated with the subscription grant that is deleted.</p>
3234
3446
  * @public
@@ -5679,6 +5891,11 @@ export interface GetSubscriptionGrantOutput {
5679
5891
  * @public
5680
5892
  */
5681
5893
  updatedAt: Date | undefined;
5894
+ /**
5895
+ * <p>The environment ID of the subscription grant.</p>
5896
+ * @public
5897
+ */
5898
+ environmentId?: string | undefined;
5682
5899
  /**
5683
5900
  * <p>The subscription target ID associated with the subscription grant.</p>
5684
5901
  * @public
@@ -6038,7 +6255,7 @@ export interface GetUserProfileOutput {
6038
6255
  */
6039
6256
  status?: UserProfileStatus | undefined;
6040
6257
  /**
6041
- * <p>The details of the user profile in Amazon DataZone.</p>
6258
+ * <p>The user profile details.</p>
6042
6259
  * @public
6043
6260
  */
6044
6261
  details?: UserProfileDetails | undefined;
@@ -8600,8 +8817,20 @@ export interface ListSubscriptionGrantsInput {
8600
8817
  * @public
8601
8818
  */
8602
8819
  owningProjectId?: string | undefined;
8820
+ /**
8821
+ * <p>The ID of the owning user.</p>
8822
+ * @public
8823
+ */
8824
+ owningUserId?: string | undefined;
8825
+ /**
8826
+ * <p>The ID of the owning group.</p>
8827
+ * @public
8828
+ */
8829
+ owningGroupId?: string | undefined;
8603
8830
  /**
8604
8831
  * <p>Specifies the way of sorting the results of this action.</p>
8832
+ *
8833
+ * @deprecated Results are always sorted by updatedAt
8605
8834
  * @public
8606
8835
  */
8607
8836
  sortBy?: SortKey | undefined;
@@ -8656,6 +8885,11 @@ export interface SubscriptionGrantSummary {
8656
8885
  * @public
8657
8886
  */
8658
8887
  updatedAt: Date | undefined;
8888
+ /**
8889
+ * <p>The environment ID of the subscription grant.</p>
8890
+ * @public
8891
+ */
8892
+ environmentId?: string | undefined;
8659
8893
  /**
8660
8894
  * <p>The identifier of the target of the subscription grant.</p>
8661
8895
  * @public
@@ -8684,296 +8918,3 @@ export interface SubscriptionGrantSummary {
8684
8918
  */
8685
8919
  subscriptionId?: string | undefined;
8686
8920
  }
8687
- /**
8688
- * @public
8689
- */
8690
- export interface ListSubscriptionGrantsOutput {
8691
- /**
8692
- * <p>The results of the <code>ListSubscriptionGrants</code> action. </p>
8693
- * @public
8694
- */
8695
- items: SubscriptionGrantSummary[] | undefined;
8696
- /**
8697
- * <p>When the number of subscription grants is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription grants, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionGrants</code> to list the next set of subscription grants.</p>
8698
- * @public
8699
- */
8700
- nextToken?: string | undefined;
8701
- }
8702
- /**
8703
- * @public
8704
- */
8705
- export interface ListSubscriptionRequestsInput {
8706
- /**
8707
- * <p>The identifier of the Amazon DataZone domain.</p>
8708
- * @public
8709
- */
8710
- domainIdentifier: string | undefined;
8711
- /**
8712
- * <p>Specifies the status of the subscription requests.</p> <note> <p>This is not a required parameter, but if not specified, by default, Amazon DataZone returns only <code>PENDING</code> subscription requests. </p> </note>
8713
- * @public
8714
- */
8715
- status?: SubscriptionRequestStatus | undefined;
8716
- /**
8717
- * <p>The identifier of the subscribed listing.</p>
8718
- * @public
8719
- */
8720
- subscribedListingId?: string | undefined;
8721
- /**
8722
- * <p>The identifier of the project for the subscription requests.</p>
8723
- * @public
8724
- */
8725
- owningProjectId?: string | undefined;
8726
- /**
8727
- * <p>The identifier of the subscription request approver's project.</p>
8728
- * @public
8729
- */
8730
- approverProjectId?: string | undefined;
8731
- /**
8732
- * <p>Specifies the way to sort the results of this action.</p>
8733
- * @public
8734
- */
8735
- sortBy?: SortKey | undefined;
8736
- /**
8737
- * <p>Specifies the sort order for the results of this action.</p>
8738
- * @public
8739
- */
8740
- sortOrder?: SortOrder | undefined;
8741
- /**
8742
- * <p>The maximum number of subscription requests to return in a single call to <code>ListSubscriptionRequests</code>. When the number of subscription requests to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
8743
- * @public
8744
- */
8745
- maxResults?: number | undefined;
8746
- /**
8747
- * <p>When the number of subscription requests is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription requests, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
8748
- * @public
8749
- */
8750
- nextToken?: string | undefined;
8751
- }
8752
- /**
8753
- * <p>The summary of the metadata form.</p>
8754
- * @public
8755
- */
8756
- export interface MetadataFormSummary {
8757
- /**
8758
- * <p>The form name of the metadata form.</p>
8759
- * @public
8760
- */
8761
- formName?: string | undefined;
8762
- /**
8763
- * <p>The type name of the metadata form.</p>
8764
- * @public
8765
- */
8766
- typeName: string | undefined;
8767
- /**
8768
- * <p>The type revision of the metadata form.</p>
8769
- * @public
8770
- */
8771
- typeRevision: string | undefined;
8772
- }
8773
- /**
8774
- * <p>The details of the subscription request.</p>
8775
- * @public
8776
- */
8777
- export interface SubscriptionRequestSummary {
8778
- /**
8779
- * <p>The identifier of the subscription request.</p>
8780
- * @public
8781
- */
8782
- id: string | undefined;
8783
- /**
8784
- * <p>The Amazon DataZone user who created the subscription request.</p>
8785
- * @public
8786
- */
8787
- createdBy: string | undefined;
8788
- /**
8789
- * <p>The identifier of the Amazon DataZone user who updated the subscription request.</p>
8790
- * @public
8791
- */
8792
- updatedBy?: string | undefined;
8793
- /**
8794
- * <p>The identifier of the Amazon DataZone domain in which a subscription request exists.</p>
8795
- * @public
8796
- */
8797
- domainId: string | undefined;
8798
- /**
8799
- * <p>The status of the subscription request.</p>
8800
- * @public
8801
- */
8802
- status: SubscriptionRequestStatus | undefined;
8803
- /**
8804
- * <p>The timestamp of when a subscription request was created.</p>
8805
- * @public
8806
- */
8807
- createdAt: Date | undefined;
8808
- /**
8809
- * <p>The timestamp of when the subscription request was updated.</p>
8810
- * @public
8811
- */
8812
- updatedAt: Date | undefined;
8813
- /**
8814
- * <p>The reason for the subscription request.</p>
8815
- * @public
8816
- */
8817
- requestReason: string | undefined;
8818
- /**
8819
- * <p>The principals included in the subscription request. </p>
8820
- * @public
8821
- */
8822
- subscribedPrincipals: SubscribedPrincipal[] | undefined;
8823
- /**
8824
- * <p>The listings included in the subscription request.</p>
8825
- * @public
8826
- */
8827
- subscribedListings: SubscribedListing[] | undefined;
8828
- /**
8829
- * <p>The identifier of the subscription request reviewer.</p>
8830
- * @public
8831
- */
8832
- reviewerId?: string | undefined;
8833
- /**
8834
- * <p>The decision comment of the subscription request.</p>
8835
- * @public
8836
- */
8837
- decisionComment?: string | undefined;
8838
- /**
8839
- * <p>The ID of the existing subscription.</p>
8840
- * @public
8841
- */
8842
- existingSubscriptionId?: string | undefined;
8843
- /**
8844
- * <p>The summary of the metadata forms.</p>
8845
- * @public
8846
- */
8847
- metadataFormsSummary?: MetadataFormSummary[] | undefined;
8848
- }
8849
- /**
8850
- * @public
8851
- */
8852
- export interface ListSubscriptionRequestsOutput {
8853
- /**
8854
- * <p>The results of the <code>ListSubscriptionRequests</code> action. </p>
8855
- * @public
8856
- */
8857
- items: SubscriptionRequestSummary[] | undefined;
8858
- /**
8859
- * <p>When the number of subscription requests is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscription requests, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
8860
- * @public
8861
- */
8862
- nextToken?: string | undefined;
8863
- }
8864
- /**
8865
- * @public
8866
- */
8867
- export interface ListSubscriptionsInput {
8868
- /**
8869
- * <p>The identifier of the Amazon DataZone domain.</p>
8870
- * @public
8871
- */
8872
- domainIdentifier: string | undefined;
8873
- /**
8874
- * <p>The identifier of the subscription request for the subscriptions that you want to list.</p>
8875
- * @public
8876
- */
8877
- subscriptionRequestIdentifier?: string | undefined;
8878
- /**
8879
- * <p>The status of the subscriptions that you want to list.</p> <note> <p>This is not a required parameter, but if not provided, by default, Amazon DataZone returns only <code>APPROVED</code> subscriptions. </p> </note>
8880
- * @public
8881
- */
8882
- status?: SubscriptionStatus | undefined;
8883
- /**
8884
- * <p>The identifier of the subscribed listing for the subscriptions that you want to list.</p>
8885
- * @public
8886
- */
8887
- subscribedListingId?: string | undefined;
8888
- /**
8889
- * <p>The identifier of the owning project.</p>
8890
- * @public
8891
- */
8892
- owningProjectId?: string | undefined;
8893
- /**
8894
- * <p>The identifier of the project for the subscription's approver.</p>
8895
- * @public
8896
- */
8897
- approverProjectId?: string | undefined;
8898
- /**
8899
- * <p>Specifies the way in which the results of this action are to be sorted.</p>
8900
- * @public
8901
- */
8902
- sortBy?: SortKey | undefined;
8903
- /**
8904
- * <p>Specifies the sort order for the results of this action.</p>
8905
- * @public
8906
- */
8907
- sortOrder?: SortOrder | undefined;
8908
- /**
8909
- * <p>The maximum number of subscriptions to return in a single call to <code>ListSubscriptions</code>. When the number of subscriptions to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListSubscriptions</code> to list the next set of Subscriptions. </p>
8910
- * @public
8911
- */
8912
- maxResults?: number | undefined;
8913
- /**
8914
- * <p>When the number of subscriptions is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of subscriptions, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptions</code> to list the next set of subscriptions.</p>
8915
- * @public
8916
- */
8917
- nextToken?: string | undefined;
8918
- }
8919
- /**
8920
- * <p>The details of the subscription.</p>
8921
- * @public
8922
- */
8923
- export interface SubscriptionSummary {
8924
- /**
8925
- * <p>The identifier of the subscription.</p>
8926
- * @public
8927
- */
8928
- id: string | undefined;
8929
- /**
8930
- * <p>The Amazon DataZone user who created the subscription.</p>
8931
- * @public
8932
- */
8933
- createdBy: string | undefined;
8934
- /**
8935
- * <p>The Amazon DataZone user who updated the subscription.</p>
8936
- * @public
8937
- */
8938
- updatedBy?: string | undefined;
8939
- /**
8940
- * <p>The identifier of the Amazon DataZone domain in which a subscription exists.</p>
8941
- * @public
8942
- */
8943
- domainId: string | undefined;
8944
- /**
8945
- * <p>The status of the subscription.</p>
8946
- * @public
8947
- */
8948
- status: SubscriptionStatus | undefined;
8949
- /**
8950
- * <p>The timestamp of when the subscription was created.</p>
8951
- * @public
8952
- */
8953
- createdAt: Date | undefined;
8954
- /**
8955
- * <p>The timestamp of when the subscription was updated.</p>
8956
- * @public
8957
- */
8958
- updatedAt: Date | undefined;
8959
- /**
8960
- * <p>The principal included in the subscription.</p>
8961
- * @public
8962
- */
8963
- subscribedPrincipal: SubscribedPrincipal | undefined;
8964
- /**
8965
- * <p>The listing included in the subscription.</p>
8966
- * @public
8967
- */
8968
- subscribedListing: SubscribedListing | undefined;
8969
- /**
8970
- * <p>The identifier of the subscription request for the subscription.</p>
8971
- * @public
8972
- */
8973
- subscriptionRequestId?: string | undefined;
8974
- /**
8975
- * <p>The retain permissions included in the subscription.</p>
8976
- * @public
8977
- */
8978
- retainPermissions?: boolean | undefined;
8979
- }