@aws-sdk/client-cleanrooms 3.953.0 → 3.955.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 +8 -0
- package/dist-cjs/index.js +85 -5
- package/dist-es/CleanRooms.js +2 -0
- package/dist-es/commands/UpdateCollaborationChangeRequestCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/index.js +2 -0
- package/dist-es/models/enums.js +17 -0
- package/dist-es/schemas/schemas_0.js +47 -5
- package/dist-types/CleanRooms.d.ts +7 -0
- package/dist-types/CleanRoomsClient.d.ts +3 -2
- package/dist-types/commands/CreateCollaborationChangeRequestCommand.d.ts +18 -3
- package/dist-types/commands/CreateCollaborationCommand.d.ts +2 -2
- package/dist-types/commands/GetCollaborationChangeRequestCommand.d.ts +12 -2
- package/dist-types/commands/GetCollaborationCommand.d.ts +1 -1
- package/dist-types/commands/ListCollaborationChangeRequestsCommand.d.ts +12 -2
- package/dist-types/commands/UpdateCollaborationChangeRequestCommand.d.ts +128 -0
- package/dist-types/commands/UpdateCollaborationCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/enums.d.ts +33 -0
- package/dist-types/models/models_0.d.ts +76 -128
- package/dist-types/models/models_1.d.ts +127 -1
- package/dist-types/schemas/schemas_0.d.ts +5 -0
- package/dist-types/ts3.4/CleanRooms.d.ts +17 -0
- package/dist-types/ts3.4/CleanRoomsClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/UpdateCollaborationChangeRequestCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +21 -0
- package/dist-types/ts3.4/models/models_0.d.ts +27 -69
- package/dist-types/ts3.4/models/models_1.d.ts +72 -3
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +5 -0
- package/package.json +10 -10
|
@@ -52,7 +52,7 @@ declare const GetCollaborationChangeRequestCommand_base: {
|
|
|
52
52
|
* // isAutoApproved: true || false, // required
|
|
53
53
|
* // changes: [ // ChangeList // required
|
|
54
54
|
* // { // Change
|
|
55
|
-
* // specificationType: "MEMBER", // required
|
|
55
|
+
* // specificationType: "MEMBER" || "COLLABORATION", // required
|
|
56
56
|
* // specification: { // ChangeSpecification Union: only one key present
|
|
57
57
|
* // member: { // MemberChangeSpecification
|
|
58
58
|
* // accountId: "STRING_VALUE", // required
|
|
@@ -61,12 +61,22 @@ declare const GetCollaborationChangeRequestCommand_base: {
|
|
|
61
61
|
* // ],
|
|
62
62
|
* // displayName: "STRING_VALUE",
|
|
63
63
|
* // },
|
|
64
|
+
* // collaboration: { // CollaborationChangeSpecification
|
|
65
|
+
* // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
|
|
66
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
|
|
67
|
+
* // ],
|
|
68
|
+
* // },
|
|
64
69
|
* // },
|
|
65
70
|
* // types: [ // ChangeTypeList // required
|
|
66
|
-
* // "ADD_MEMBER",
|
|
71
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "EDIT_AUTO_APPROVED_CHANGE_TYPES",
|
|
67
72
|
* // ],
|
|
68
73
|
* // },
|
|
69
74
|
* // ],
|
|
75
|
+
* // approvals: { // ApprovalStatuses
|
|
76
|
+
* // "<keys>": { // ApprovalStatusDetails
|
|
77
|
+
* // status: "APPROVED" || "DENIED" || "PENDING", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
70
80
|
* // },
|
|
71
81
|
* // };
|
|
72
82
|
*
|
|
@@ -64,7 +64,7 @@ declare const GetCollaborationCommand_base: {
|
|
|
64
64
|
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
65
65
|
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
|
|
66
66
|
* // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
|
|
67
|
-
* // "ADD_MEMBER",
|
|
67
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
|
|
68
68
|
* // ],
|
|
69
69
|
* // allowedResultRegions: [ // AllowedResultRegions
|
|
70
70
|
* // "us-west-1" || "us-west-2" || "us-east-1" || "us-east-2" || "af-south-1" || "ap-east-1" || "ap-east-2" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-5" || "ap-southeast-4" || "ap-southeast-7" || "ap-south-1" || "ap-northeast-3" || "ap-northeast-1" || "ap-northeast-2" || "ca-central-1" || "ca-west-1" || "eu-south-1" || "eu-west-3" || "eu-south-2" || "eu-central-2" || "eu-central-1" || "eu-north-1" || "eu-west-1" || "eu-west-2" || "me-south-1" || "me-central-1" || "il-central-1" || "sa-east-1" || "mx-central-1",
|
|
@@ -55,7 +55,7 @@ declare const ListCollaborationChangeRequestsCommand_base: {
|
|
|
55
55
|
* // isAutoApproved: true || false, // required
|
|
56
56
|
* // changes: [ // ChangeList // required
|
|
57
57
|
* // { // Change
|
|
58
|
-
* // specificationType: "MEMBER", // required
|
|
58
|
+
* // specificationType: "MEMBER" || "COLLABORATION", // required
|
|
59
59
|
* // specification: { // ChangeSpecification Union: only one key present
|
|
60
60
|
* // member: { // MemberChangeSpecification
|
|
61
61
|
* // accountId: "STRING_VALUE", // required
|
|
@@ -64,12 +64,22 @@ declare const ListCollaborationChangeRequestsCommand_base: {
|
|
|
64
64
|
* // ],
|
|
65
65
|
* // displayName: "STRING_VALUE",
|
|
66
66
|
* // },
|
|
67
|
+
* // collaboration: { // CollaborationChangeSpecification
|
|
68
|
+
* // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
|
|
69
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
|
|
70
|
+
* // ],
|
|
71
|
+
* // },
|
|
67
72
|
* // },
|
|
68
73
|
* // types: [ // ChangeTypeList // required
|
|
69
|
-
* // "ADD_MEMBER",
|
|
74
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "EDIT_AUTO_APPROVED_CHANGE_TYPES",
|
|
70
75
|
* // ],
|
|
71
76
|
* // },
|
|
72
77
|
* // ],
|
|
78
|
+
* // approvals: { // ApprovalStatuses
|
|
79
|
+
* // "<keys>": { // ApprovalStatusDetails
|
|
80
|
+
* // status: "APPROVED" || "DENIED" || "PENDING", // required
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
73
83
|
* // },
|
|
74
84
|
* // ],
|
|
75
85
|
* // nextToken: "STRING_VALUE",
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsClient";
|
|
4
|
+
import type { UpdateCollaborationChangeRequestInput, UpdateCollaborationChangeRequestOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateCollaborationChangeRequestCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateCollaborationChangeRequestCommandInput extends UpdateCollaborationChangeRequestInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateCollaborationChangeRequestCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateCollaborationChangeRequestCommandOutput extends UpdateCollaborationChangeRequestOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateCollaborationChangeRequestCommand_base: {
|
|
25
|
+
new (input: UpdateCollaborationChangeRequestCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCollaborationChangeRequestCommandInput, UpdateCollaborationChangeRequestCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateCollaborationChangeRequestCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCollaborationChangeRequestCommandInput, UpdateCollaborationChangeRequestCommandOutput, CleanRoomsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL, COMMIT).</p> <p>For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CleanRoomsClient, UpdateCollaborationChangeRequestCommand } from "@aws-sdk/client-cleanrooms"; // ES Modules import
|
|
35
|
+
* // const { CleanRoomsClient, UpdateCollaborationChangeRequestCommand } = require("@aws-sdk/client-cleanrooms"); // CommonJS import
|
|
36
|
+
* // import type { CleanRoomsClientConfig } from "@aws-sdk/client-cleanrooms";
|
|
37
|
+
* const config = {}; // type is CleanRoomsClientConfig
|
|
38
|
+
* const client = new CleanRoomsClient(config);
|
|
39
|
+
* const input = { // UpdateCollaborationChangeRequestInput
|
|
40
|
+
* collaborationIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* changeRequestIdentifier: "STRING_VALUE", // required
|
|
42
|
+
* action: "APPROVE" || "DENY" || "CANCEL" || "COMMIT", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new UpdateCollaborationChangeRequestCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // UpdateCollaborationChangeRequestOutput
|
|
47
|
+
* // collaborationChangeRequest: { // CollaborationChangeRequest
|
|
48
|
+
* // id: "STRING_VALUE", // required
|
|
49
|
+
* // collaborationId: "STRING_VALUE", // required
|
|
50
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // status: "PENDING" || "APPROVED" || "CANCELLED" || "DENIED" || "COMMITTED", // required
|
|
53
|
+
* // isAutoApproved: true || false, // required
|
|
54
|
+
* // changes: [ // ChangeList // required
|
|
55
|
+
* // { // Change
|
|
56
|
+
* // specificationType: "MEMBER" || "COLLABORATION", // required
|
|
57
|
+
* // specification: { // ChangeSpecification Union: only one key present
|
|
58
|
+
* // member: { // MemberChangeSpecification
|
|
59
|
+
* // accountId: "STRING_VALUE", // required
|
|
60
|
+
* // memberAbilities: [ // MemberAbilities // required
|
|
61
|
+
* // "CAN_QUERY" || "CAN_RECEIVE_RESULTS" || "CAN_RUN_JOB",
|
|
62
|
+
* // ],
|
|
63
|
+
* // displayName: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // collaboration: { // CollaborationChangeSpecification
|
|
66
|
+
* // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
|
|
67
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
|
|
68
|
+
* // ],
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // types: [ // ChangeTypeList // required
|
|
72
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY" || "EDIT_AUTO_APPROVED_CHANGE_TYPES",
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // approvals: { // ApprovalStatuses
|
|
77
|
+
* // "<keys>": { // ApprovalStatusDetails
|
|
78
|
+
* // status: "APPROVED" || "DENIED" || "PENDING", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // };
|
|
83
|
+
*
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* @param UpdateCollaborationChangeRequestCommandInput - {@link UpdateCollaborationChangeRequestCommandInput}
|
|
87
|
+
* @returns {@link UpdateCollaborationChangeRequestCommandOutput}
|
|
88
|
+
* @see {@link UpdateCollaborationChangeRequestCommandInput} for command's `input` shape.
|
|
89
|
+
* @see {@link UpdateCollaborationChangeRequestCommandOutput} for command's `response` shape.
|
|
90
|
+
* @see {@link CleanRoomsClientResolvedConfig | config} for CleanRoomsClient's `config` shape.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
93
|
+
* <p>Caller does not have sufficient access to perform this action.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ConflictException} (client fault)
|
|
96
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InternalServerException} (server fault)
|
|
99
|
+
* <p>Unexpected error during processing of request.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
102
|
+
* <p>Request references a resource which does not exist.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
105
|
+
* <p>Request was denied due to request throttling.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ValidationException} (client fault)
|
|
108
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link CleanRoomsServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from CleanRooms service.</p>
|
|
112
|
+
*
|
|
113
|
+
*
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
export declare class UpdateCollaborationChangeRequestCommand extends UpdateCollaborationChangeRequestCommand_base {
|
|
117
|
+
/** @internal type navigation helper, not in runtime. */
|
|
118
|
+
protected static __types: {
|
|
119
|
+
api: {
|
|
120
|
+
input: UpdateCollaborationChangeRequestInput;
|
|
121
|
+
output: UpdateCollaborationChangeRequestOutput;
|
|
122
|
+
};
|
|
123
|
+
sdk: {
|
|
124
|
+
input: UpdateCollaborationChangeRequestCommandInput;
|
|
125
|
+
output: UpdateCollaborationChangeRequestCommandOutput;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
}
|
|
@@ -67,7 +67,7 @@ declare const UpdateCollaborationCommand_base: {
|
|
|
67
67
|
* // jobLogStatus: "ENABLED" || "DISABLED",
|
|
68
68
|
* // analyticsEngine: "SPARK" || "CLEAN_ROOMS_SQL",
|
|
69
69
|
* // autoApprovedChangeTypes: [ // AutoApprovedChangeTypeList
|
|
70
|
-
* // "ADD_MEMBER",
|
|
70
|
+
* // "ADD_MEMBER" || "GRANT_RECEIVE_RESULTS_ABILITY" || "REVOKE_RECEIVE_RESULTS_ABILITY",
|
|
71
71
|
* // ],
|
|
72
72
|
* // allowedResultRegions: [ // AllowedResultRegions
|
|
73
73
|
* // "us-west-1" || "us-west-2" || "us-east-1" || "us-east-2" || "af-south-1" || "ap-east-1" || "ap-east-2" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-5" || "ap-southeast-4" || "ap-southeast-7" || "ap-south-1" || "ap-northeast-3" || "ap-northeast-1" || "ap-northeast-2" || "ca-central-1" || "ca-west-1" || "eu-south-1" || "eu-west-3" || "eu-south-2" || "eu-central-2" || "eu-central-1" || "eu-north-1" || "eu-west-1" || "eu-west-2" || "me-south-1" || "me-central-1" || "il-central-1" || "sa-east-1" || "mx-central-1",
|
|
@@ -73,6 +73,7 @@ export * from "./StartProtectedQueryCommand";
|
|
|
73
73
|
export * from "./TagResourceCommand";
|
|
74
74
|
export * from "./UntagResourceCommand";
|
|
75
75
|
export * from "./UpdateAnalysisTemplateCommand";
|
|
76
|
+
export * from "./UpdateCollaborationChangeRequestCommand";
|
|
76
77
|
export * from "./UpdateCollaborationCommand";
|
|
77
78
|
export * from "./UpdateConfiguredAudienceModelAssociationCommand";
|
|
78
79
|
export * from "./UpdateConfiguredTableAnalysisRuleCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -13,6 +13,6 @@ export * from "./schemas/schemas_0";
|
|
|
13
13
|
export * from "./pagination";
|
|
14
14
|
export * from "./models/enums";
|
|
15
15
|
export * from "./models/errors";
|
|
16
|
-
export
|
|
17
|
-
export
|
|
16
|
+
export * from "./models/models_0";
|
|
17
|
+
export * from "./models/models_1";
|
|
18
18
|
export { CleanRoomsServiceException } from "./models/CleanRoomsServiceException";
|
|
@@ -363,6 +363,19 @@ export declare const AnalyticsEngine: {
|
|
|
363
363
|
* @public
|
|
364
364
|
*/
|
|
365
365
|
export type AnalyticsEngine = (typeof AnalyticsEngine)[keyof typeof AnalyticsEngine];
|
|
366
|
+
/**
|
|
367
|
+
* @public
|
|
368
|
+
* @enum
|
|
369
|
+
*/
|
|
370
|
+
export declare const ApprovalStatus: {
|
|
371
|
+
readonly APPROVED: "APPROVED";
|
|
372
|
+
readonly DENIED: "DENIED";
|
|
373
|
+
readonly PENDING: "PENDING";
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
export type ApprovalStatus = (typeof ApprovalStatus)[keyof typeof ApprovalStatus];
|
|
366
379
|
/**
|
|
367
380
|
* @public
|
|
368
381
|
* @enum
|
|
@@ -412,6 +425,8 @@ export type CommercialRegion = (typeof CommercialRegion)[keyof typeof Commercial
|
|
|
412
425
|
*/
|
|
413
426
|
export declare const AutoApprovedChangeType: {
|
|
414
427
|
readonly ADD_MEMBER: "ADD_MEMBER";
|
|
428
|
+
readonly GRANT_RECEIVE_RESULTS_ABILITY: "GRANT_RECEIVE_RESULTS_ABILITY";
|
|
429
|
+
readonly REVOKE_RECEIVE_RESULTS_ABILITY: "REVOKE_RECEIVE_RESULTS_ABILITY";
|
|
415
430
|
};
|
|
416
431
|
/**
|
|
417
432
|
* @public
|
|
@@ -565,6 +580,7 @@ export type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus];
|
|
|
565
580
|
* @enum
|
|
566
581
|
*/
|
|
567
582
|
export declare const ChangeSpecificationType: {
|
|
583
|
+
readonly COLLABORATION: "COLLABORATION";
|
|
568
584
|
readonly MEMBER: "MEMBER";
|
|
569
585
|
};
|
|
570
586
|
/**
|
|
@@ -577,6 +593,9 @@ export type ChangeSpecificationType = (typeof ChangeSpecificationType)[keyof typ
|
|
|
577
593
|
*/
|
|
578
594
|
export declare const ChangeType: {
|
|
579
595
|
readonly ADD_MEMBER: "ADD_MEMBER";
|
|
596
|
+
readonly EDIT_AUTO_APPROVED_CHANGE_TYPES: "EDIT_AUTO_APPROVED_CHANGE_TYPES";
|
|
597
|
+
readonly GRANT_RECEIVE_RESULTS_ABILITY: "GRANT_RECEIVE_RESULTS_ABILITY";
|
|
598
|
+
readonly REVOKE_RECEIVE_RESULTS_ABILITY: "REVOKE_RECEIVE_RESULTS_ABILITY";
|
|
580
599
|
};
|
|
581
600
|
/**
|
|
582
601
|
* @public
|
|
@@ -648,6 +667,20 @@ export declare const FilterableMemberStatus: {
|
|
|
648
667
|
* @public
|
|
649
668
|
*/
|
|
650
669
|
export type FilterableMemberStatus = (typeof FilterableMemberStatus)[keyof typeof FilterableMemberStatus];
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
* @enum
|
|
673
|
+
*/
|
|
674
|
+
export declare const ChangeRequestAction: {
|
|
675
|
+
readonly APPROVE: "APPROVE";
|
|
676
|
+
readonly CANCEL: "CANCEL";
|
|
677
|
+
readonly COMMIT: "COMMIT";
|
|
678
|
+
readonly DENY: "DENY";
|
|
679
|
+
};
|
|
680
|
+
/**
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
683
|
+
export type ChangeRequestAction = (typeof ChangeRequestAction)[keyof typeof ChangeRequestAction];
|
|
651
684
|
/**
|
|
652
685
|
* @public
|
|
653
686
|
* @enum
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import { AccessBudgetType, AdditionalAnalyses, AggregateFunctionName, AggregationType, AnalysisFormat, AnalysisMethod, AnalysisRuleType, AnalysisTemplateValidationStatus, AnalysisTemplateValidationType, AnalysisType, AnalyticsEngine, AutoApprovedChangeType, AutoRefreshMode, ChangeRequestStatus, ChangeSpecificationType, ChangeType, CollaborationJobLogStatus, CollaborationQueryLogStatus, CommercialRegion, ConfiguredTableAnalysisRuleType, ConfiguredTableAssociationAnalysisRuleType, CustomMLMemberAbility, DifferentialPrivacyAggregationType, ErrorMessageType, FilterableMemberStatus, IdNamespaceType, JobType, JoinOperator, JoinRequiredOption, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, MembershipStatus, MemberStatus, ParameterType, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobStatus, ProtectedJobWorkerComputeType, ResultFormat, ScalarFunctions, SchemaConfiguration, SchemaStatus, SchemaStatusReasonCode, SchemaType, SelectedAnalysisMethod, SupportedS3Region, SyntheticDataColumnType, WorkerComputeType } from "./enums";
|
|
2
|
+
import { AccessBudgetType, AdditionalAnalyses, AggregateFunctionName, AggregationType, AnalysisFormat, AnalysisMethod, AnalysisRuleType, AnalysisTemplateValidationStatus, AnalysisTemplateValidationType, AnalysisType, AnalyticsEngine, ApprovalStatus, AutoApprovedChangeType, AutoRefreshMode, ChangeRequestAction, ChangeRequestStatus, ChangeSpecificationType, ChangeType, CollaborationJobLogStatus, CollaborationQueryLogStatus, CommercialRegion, ConfiguredTableAnalysisRuleType, ConfiguredTableAssociationAnalysisRuleType, CustomMLMemberAbility, DifferentialPrivacyAggregationType, ErrorMessageType, FilterableMemberStatus, IdNamespaceType, JobType, JoinOperator, JoinRequiredOption, MemberAbility, MembershipJobLogStatus, MembershipQueryLogStatus, MembershipStatus, MemberStatus, ParameterType, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetType, ProtectedJobStatus, ProtectedJobWorkerComputeType, ResultFormat, ScalarFunctions, SchemaConfiguration, SchemaStatus, SchemaStatusReasonCode, SchemaType, SelectedAnalysisMethod, SupportedS3Region, SyntheticDataColumnType, WorkerComputeType } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* <p>Detailed information about an access budget including time bounds, budget allocation, and configuration settings.</p>
|
|
5
5
|
* @public
|
|
@@ -1529,6 +1529,17 @@ export interface UpdateAnalysisTemplateOutput {
|
|
|
1529
1529
|
*/
|
|
1530
1530
|
analysisTemplate: AnalysisTemplate | undefined;
|
|
1531
1531
|
}
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>Contains detailed information about the approval state of a given member in the collaboration for a given collaboration change request.</p>
|
|
1534
|
+
* @public
|
|
1535
|
+
*/
|
|
1536
|
+
export interface ApprovalStatusDetails {
|
|
1537
|
+
/**
|
|
1538
|
+
* <p>The approval status of a member's vote on the change request. Valid values are PENDING (if they haven't voted), APPROVED, or DENIED.</p>
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
status: ApprovalStatus | undefined;
|
|
1542
|
+
}
|
|
1532
1543
|
/**
|
|
1533
1544
|
* <p> A reference to a table within Athena.</p>
|
|
1534
1545
|
* @public
|
|
@@ -2375,6 +2386,17 @@ export interface CreateCollaborationOutput {
|
|
|
2375
2386
|
*/
|
|
2376
2387
|
collaboration: Collaboration | undefined;
|
|
2377
2388
|
}
|
|
2389
|
+
/**
|
|
2390
|
+
* <p>Defines the specific changes being requested for a collaboration, including configuration modifications and approval requirements.</p>
|
|
2391
|
+
* @public
|
|
2392
|
+
*/
|
|
2393
|
+
export interface CollaborationChangeSpecification {
|
|
2394
|
+
/**
|
|
2395
|
+
* <p>Defines requested updates to properties of the collaboration. Currently, this only supports modifying which change types are auto-approved for the collaboration.</p>
|
|
2396
|
+
* @public
|
|
2397
|
+
*/
|
|
2398
|
+
autoApprovedChangeTypes?: AutoApprovedChangeType[] | undefined;
|
|
2399
|
+
}
|
|
2378
2400
|
/**
|
|
2379
2401
|
* <p>Specifies changes to collaboration membership, including adding new members with their abilities and display names.</p>
|
|
2380
2402
|
* @public
|
|
@@ -2400,7 +2422,7 @@ export interface MemberChangeSpecification {
|
|
|
2400
2422
|
* <p>A union that contains the specification details for different types of changes.</p>
|
|
2401
2423
|
* @public
|
|
2402
2424
|
*/
|
|
2403
|
-
export type ChangeSpecification = ChangeSpecification.MemberMember | ChangeSpecification.$UnknownMember;
|
|
2425
|
+
export type ChangeSpecification = ChangeSpecification.CollaborationMember | ChangeSpecification.MemberMember | ChangeSpecification.$UnknownMember;
|
|
2404
2426
|
/**
|
|
2405
2427
|
* @public
|
|
2406
2428
|
*/
|
|
@@ -2411,6 +2433,16 @@ export declare namespace ChangeSpecification {
|
|
|
2411
2433
|
*/
|
|
2412
2434
|
interface MemberMember {
|
|
2413
2435
|
member: MemberChangeSpecification;
|
|
2436
|
+
collaboration?: never;
|
|
2437
|
+
$unknown?: never;
|
|
2438
|
+
}
|
|
2439
|
+
/**
|
|
2440
|
+
* <p>The collaboration configuration changes being requested. Currently, this only supports modifying which change types are auto-approved for the collaboration.</p>
|
|
2441
|
+
* @public
|
|
2442
|
+
*/
|
|
2443
|
+
interface CollaborationMember {
|
|
2444
|
+
member?: never;
|
|
2445
|
+
collaboration: CollaborationChangeSpecification;
|
|
2414
2446
|
$unknown?: never;
|
|
2415
2447
|
}
|
|
2416
2448
|
/**
|
|
@@ -2418,6 +2450,7 @@ export declare namespace ChangeSpecification {
|
|
|
2418
2450
|
*/
|
|
2419
2451
|
interface $UnknownMember {
|
|
2420
2452
|
member?: never;
|
|
2453
|
+
collaboration?: never;
|
|
2421
2454
|
$unknown: [string, any];
|
|
2422
2455
|
}
|
|
2423
2456
|
/**
|
|
@@ -2426,6 +2459,7 @@ export declare namespace ChangeSpecification {
|
|
|
2426
2459
|
*/
|
|
2427
2460
|
interface Visitor<T> {
|
|
2428
2461
|
member: (value: MemberChangeSpecification) => T;
|
|
2462
|
+
collaboration: (value: CollaborationChangeSpecification) => T;
|
|
2429
2463
|
_: (name: string, value: any) => T;
|
|
2430
2464
|
}
|
|
2431
2465
|
}
|
|
@@ -2521,6 +2555,11 @@ export interface CollaborationChangeRequest {
|
|
|
2521
2555
|
* @public
|
|
2522
2556
|
*/
|
|
2523
2557
|
changes: Change[] | undefined;
|
|
2558
|
+
/**
|
|
2559
|
+
* <p>A list of approval details from collaboration members, including approval status and multi-party approval workflow information.</p>
|
|
2560
|
+
* @public
|
|
2561
|
+
*/
|
|
2562
|
+
approvals?: Record<string, ApprovalStatusDetails> | undefined;
|
|
2524
2563
|
}
|
|
2525
2564
|
/**
|
|
2526
2565
|
* @public
|
|
@@ -3205,6 +3244,11 @@ export interface CollaborationChangeRequestSummary {
|
|
|
3205
3244
|
* @public
|
|
3206
3245
|
*/
|
|
3207
3246
|
changes: Change[] | undefined;
|
|
3247
|
+
/**
|
|
3248
|
+
* <p>Summary of approval statuses from all collaboration members for this change request.</p>
|
|
3249
|
+
* @public
|
|
3250
|
+
*/
|
|
3251
|
+
approvals?: Record<string, ApprovalStatusDetails> | undefined;
|
|
3208
3252
|
}
|
|
3209
3253
|
/**
|
|
3210
3254
|
* @public
|
|
@@ -4001,6 +4045,36 @@ export interface UpdateCollaborationOutput {
|
|
|
4001
4045
|
*/
|
|
4002
4046
|
collaboration: Collaboration | undefined;
|
|
4003
4047
|
}
|
|
4048
|
+
/**
|
|
4049
|
+
* @public
|
|
4050
|
+
*/
|
|
4051
|
+
export interface UpdateCollaborationChangeRequestInput {
|
|
4052
|
+
/**
|
|
4053
|
+
* <p>The unique identifier of the collaboration that contains the change request to be updated.</p>
|
|
4054
|
+
* @public
|
|
4055
|
+
*/
|
|
4056
|
+
collaborationIdentifier: string | undefined;
|
|
4057
|
+
/**
|
|
4058
|
+
* <p>The unique identifier of the specific change request to be updated within the collaboration.</p>
|
|
4059
|
+
* @public
|
|
4060
|
+
*/
|
|
4061
|
+
changeRequestIdentifier: string | undefined;
|
|
4062
|
+
/**
|
|
4063
|
+
* <p>The action to perform on the change request. Valid values include APPROVE (approve the change), DENY (reject the change), CANCEL (cancel the request), and COMMIT (commit after the request is approved).</p> <p>For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.</p>
|
|
4064
|
+
* @public
|
|
4065
|
+
*/
|
|
4066
|
+
action: ChangeRequestAction | undefined;
|
|
4067
|
+
}
|
|
4068
|
+
/**
|
|
4069
|
+
* @public
|
|
4070
|
+
*/
|
|
4071
|
+
export interface UpdateCollaborationChangeRequestOutput {
|
|
4072
|
+
/**
|
|
4073
|
+
* <p>Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.</p>
|
|
4074
|
+
* @public
|
|
4075
|
+
*/
|
|
4076
|
+
collaborationChangeRequest: CollaborationChangeRequest | undefined;
|
|
4077
|
+
}
|
|
4004
4078
|
/**
|
|
4005
4079
|
* @public
|
|
4006
4080
|
*/
|
|
@@ -7035,129 +7109,3 @@ export interface ProtectedQueryDistributeOutput {
|
|
|
7035
7109
|
*/
|
|
7036
7110
|
memberList?: ProtectedQuerySingleMemberOutput[] | undefined;
|
|
7037
7111
|
}
|
|
7038
|
-
/**
|
|
7039
|
-
* <p>Contains details about the protected query output.</p>
|
|
7040
|
-
* @public
|
|
7041
|
-
*/
|
|
7042
|
-
export type ProtectedQueryOutput = ProtectedQueryOutput.DistributeMember | ProtectedQueryOutput.MemberListMember | ProtectedQueryOutput.S3Member | ProtectedQueryOutput.$UnknownMember;
|
|
7043
|
-
/**
|
|
7044
|
-
* @public
|
|
7045
|
-
*/
|
|
7046
|
-
export declare namespace ProtectedQueryOutput {
|
|
7047
|
-
/**
|
|
7048
|
-
* <p>If present, the output for a protected query with an <code>S3</code> output type.</p>
|
|
7049
|
-
* @public
|
|
7050
|
-
*/
|
|
7051
|
-
interface S3Member {
|
|
7052
|
-
s3: ProtectedQueryS3Output;
|
|
7053
|
-
memberList?: never;
|
|
7054
|
-
distribute?: never;
|
|
7055
|
-
$unknown?: never;
|
|
7056
|
-
}
|
|
7057
|
-
/**
|
|
7058
|
-
* <p>The list of member Amazon Web Services account(s) that received the results of the query. </p>
|
|
7059
|
-
* @public
|
|
7060
|
-
*/
|
|
7061
|
-
interface MemberListMember {
|
|
7062
|
-
s3?: never;
|
|
7063
|
-
memberList: ProtectedQuerySingleMemberOutput[];
|
|
7064
|
-
distribute?: never;
|
|
7065
|
-
$unknown?: never;
|
|
7066
|
-
}
|
|
7067
|
-
/**
|
|
7068
|
-
* <p>Contains output information for protected queries that use a <code>distribute</code> output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members. </p> <note> <p> You can only use the <code>distribute</code> output type with the Spark analytics engine. </p> </note>
|
|
7069
|
-
* @public
|
|
7070
|
-
*/
|
|
7071
|
-
interface DistributeMember {
|
|
7072
|
-
s3?: never;
|
|
7073
|
-
memberList?: never;
|
|
7074
|
-
distribute: ProtectedQueryDistributeOutput;
|
|
7075
|
-
$unknown?: never;
|
|
7076
|
-
}
|
|
7077
|
-
/**
|
|
7078
|
-
* @public
|
|
7079
|
-
*/
|
|
7080
|
-
interface $UnknownMember {
|
|
7081
|
-
s3?: never;
|
|
7082
|
-
memberList?: never;
|
|
7083
|
-
distribute?: never;
|
|
7084
|
-
$unknown: [string, any];
|
|
7085
|
-
}
|
|
7086
|
-
/**
|
|
7087
|
-
* @deprecated unused in schema-serde mode.
|
|
7088
|
-
*
|
|
7089
|
-
*/
|
|
7090
|
-
interface Visitor<T> {
|
|
7091
|
-
s3: (value: ProtectedQueryS3Output) => T;
|
|
7092
|
-
memberList: (value: ProtectedQuerySingleMemberOutput[]) => T;
|
|
7093
|
-
distribute: (value: ProtectedQueryDistributeOutput) => T;
|
|
7094
|
-
_: (name: string, value: any) => T;
|
|
7095
|
-
}
|
|
7096
|
-
}
|
|
7097
|
-
/**
|
|
7098
|
-
* <p>Details about the query results.</p>
|
|
7099
|
-
* @public
|
|
7100
|
-
*/
|
|
7101
|
-
export interface ProtectedQueryResult {
|
|
7102
|
-
/**
|
|
7103
|
-
* <p>The output of the protected query.</p>
|
|
7104
|
-
* @public
|
|
7105
|
-
*/
|
|
7106
|
-
output: ProtectedQueryOutput | undefined;
|
|
7107
|
-
}
|
|
7108
|
-
/**
|
|
7109
|
-
* <p> Contains configuration details for the protected query member output.</p>
|
|
7110
|
-
* @public
|
|
7111
|
-
*/
|
|
7112
|
-
export interface ProtectedQueryMemberOutputConfiguration {
|
|
7113
|
-
/**
|
|
7114
|
-
* <p>The unique identifier for the account.</p>
|
|
7115
|
-
* @public
|
|
7116
|
-
*/
|
|
7117
|
-
accountId: string | undefined;
|
|
7118
|
-
}
|
|
7119
|
-
/**
|
|
7120
|
-
* <p> Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.</p>
|
|
7121
|
-
* @public
|
|
7122
|
-
*/
|
|
7123
|
-
export type ProtectedQueryDistributeOutputConfigurationLocation = ProtectedQueryDistributeOutputConfigurationLocation.MemberMember | ProtectedQueryDistributeOutputConfigurationLocation.S3Member | ProtectedQueryDistributeOutputConfigurationLocation.$UnknownMember;
|
|
7124
|
-
/**
|
|
7125
|
-
* @public
|
|
7126
|
-
*/
|
|
7127
|
-
export declare namespace ProtectedQueryDistributeOutputConfigurationLocation {
|
|
7128
|
-
/**
|
|
7129
|
-
* <p>Contains the configuration to write the query results to S3.</p>
|
|
7130
|
-
* @public
|
|
7131
|
-
*/
|
|
7132
|
-
interface S3Member {
|
|
7133
|
-
s3: ProtectedQueryS3OutputConfiguration;
|
|
7134
|
-
member?: never;
|
|
7135
|
-
$unknown?: never;
|
|
7136
|
-
}
|
|
7137
|
-
/**
|
|
7138
|
-
* <p> Contains configuration details for the protected query member output.</p>
|
|
7139
|
-
* @public
|
|
7140
|
-
*/
|
|
7141
|
-
interface MemberMember {
|
|
7142
|
-
s3?: never;
|
|
7143
|
-
member: ProtectedQueryMemberOutputConfiguration;
|
|
7144
|
-
$unknown?: never;
|
|
7145
|
-
}
|
|
7146
|
-
/**
|
|
7147
|
-
* @public
|
|
7148
|
-
*/
|
|
7149
|
-
interface $UnknownMember {
|
|
7150
|
-
s3?: never;
|
|
7151
|
-
member?: never;
|
|
7152
|
-
$unknown: [string, any];
|
|
7153
|
-
}
|
|
7154
|
-
/**
|
|
7155
|
-
* @deprecated unused in schema-serde mode.
|
|
7156
|
-
*
|
|
7157
|
-
*/
|
|
7158
|
-
interface Visitor<T> {
|
|
7159
|
-
s3: (value: ProtectedQueryS3OutputConfiguration) => T;
|
|
7160
|
-
member: (value: ProtectedQueryMemberOutputConfiguration) => T;
|
|
7161
|
-
_: (name: string, value: any) => T;
|
|
7162
|
-
}
|
|
7163
|
-
}
|