@aws-sdk/client-cleanrooms 3.899.0 → 3.901.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/dist-cjs/index.js +71 -11
- package/dist-es/models/models_0.js +15 -4
- package/dist-es/models/models_1.js +8 -0
- package/dist-es/protocols/Aws_restJson1.js +45 -2
- package/dist-types/commands/BatchGetSchemaCommand.d.ts +1 -0
- package/dist-types/commands/CreatePrivacyBudgetTemplateCommand.d.ts +23 -3
- package/dist-types/commands/GetCollaborationPrivacyBudgetTemplateCommand.d.ts +11 -1
- package/dist-types/commands/GetPrivacyBudgetTemplateCommand.d.ts +11 -1
- package/dist-types/commands/GetSchemaCommand.d.ts +1 -0
- package/dist-types/commands/ListCollaborationPrivacyBudgetTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListCollaborationPrivacyBudgetsCommand.d.ts +17 -2
- package/dist-types/commands/ListPrivacyBudgetTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListPrivacyBudgetsCommand.d.ts +17 -2
- package/dist-types/commands/ListSchemasCommand.d.ts +1 -0
- package/dist-types/commands/UpdatePrivacyBudgetTemplateCommand.d.ts +21 -2
- package/dist-types/models/models_0.d.ts +189 -111
- package/dist-types/models/models_1.d.ts +142 -4
- package/dist-types/ts3.4/models/models_0.d.ts +65 -31
- package/dist-types/ts3.4/models/models_1.d.ts +54 -4
- package/package.json +37 -37
|
@@ -39,12 +39,21 @@ declare const UpdatePrivacyBudgetTemplateCommand_base: {
|
|
|
39
39
|
* const input = { // UpdatePrivacyBudgetTemplateInput
|
|
40
40
|
* membershipIdentifier: "STRING_VALUE", // required
|
|
41
41
|
* privacyBudgetTemplateIdentifier: "STRING_VALUE", // required
|
|
42
|
-
* privacyBudgetType: "DIFFERENTIAL_PRIVACY", // required
|
|
42
|
+
* privacyBudgetType: "DIFFERENTIAL_PRIVACY" || "ACCESS_BUDGET", // required
|
|
43
43
|
* parameters: { // PrivacyBudgetTemplateUpdateParameters Union: only one key present
|
|
44
44
|
* differentialPrivacy: { // DifferentialPrivacyTemplateUpdateParameters
|
|
45
45
|
* epsilon: Number("int"),
|
|
46
46
|
* usersNoisePerQuery: Number("int"),
|
|
47
47
|
* },
|
|
48
|
+
* accessBudget: { // AccessBudgetsPrivacyTemplateUpdateParameters
|
|
49
|
+
* budgetParameters: [ // BudgetParameters // required
|
|
50
|
+
* { // BudgetParameter
|
|
51
|
+
* type: "CALENDAR_DAY" || "CALENDAR_MONTH" || "CALENDAR_WEEK" || "LIFETIME", // required
|
|
52
|
+
* budget: Number("int"), // required
|
|
53
|
+
* autoRefresh: "ENABLED" || "DISABLED",
|
|
54
|
+
* },
|
|
55
|
+
* ],
|
|
56
|
+
* },
|
|
48
57
|
* },
|
|
49
58
|
* };
|
|
50
59
|
* const command = new UpdatePrivacyBudgetTemplateCommand(input);
|
|
@@ -59,13 +68,23 @@ declare const UpdatePrivacyBudgetTemplateCommand_base: {
|
|
|
59
68
|
* // collaborationArn: "STRING_VALUE", // required
|
|
60
69
|
* // createTime: new Date("TIMESTAMP"), // required
|
|
61
70
|
* // updateTime: new Date("TIMESTAMP"), // required
|
|
62
|
-
* // privacyBudgetType: "DIFFERENTIAL_PRIVACY", // required
|
|
71
|
+
* // privacyBudgetType: "DIFFERENTIAL_PRIVACY" || "ACCESS_BUDGET", // required
|
|
63
72
|
* // autoRefresh: "CALENDAR_MONTH" || "NONE", // required
|
|
64
73
|
* // parameters: { // PrivacyBudgetTemplateParametersOutput Union: only one key present
|
|
65
74
|
* // differentialPrivacy: { // DifferentialPrivacyTemplateParametersOutput
|
|
66
75
|
* // epsilon: Number("int"), // required
|
|
67
76
|
* // usersNoisePerQuery: Number("int"), // required
|
|
68
77
|
* // },
|
|
78
|
+
* // accessBudget: { // AccessBudgetsPrivacyTemplateParametersOutput
|
|
79
|
+
* // budgetParameters: [ // BudgetParameters // required
|
|
80
|
+
* // { // BudgetParameter
|
|
81
|
+
* // type: "CALENDAR_DAY" || "CALENDAR_MONTH" || "CALENDAR_WEEK" || "LIFETIME", // required
|
|
82
|
+
* // budget: Number("int"), // required
|
|
83
|
+
* // autoRefresh: "ENABLED" || "DISABLED",
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // resourceArn: "STRING_VALUE", // required
|
|
87
|
+
* // },
|
|
69
88
|
* // },
|
|
70
89
|
* // },
|
|
71
90
|
* // };
|
|
@@ -1,6 +1,153 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
3
|
import { CleanRoomsServiceException as __BaseException } from "./CleanRoomsServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* @enum
|
|
7
|
+
*/
|
|
8
|
+
export declare const AutoRefreshMode: {
|
|
9
|
+
readonly DISABLED: "DISABLED";
|
|
10
|
+
readonly ENABLED: "ENABLED";
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
export type AutoRefreshMode = (typeof AutoRefreshMode)[keyof typeof AutoRefreshMode];
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* @enum
|
|
19
|
+
*/
|
|
20
|
+
export declare const AccessBudgetType: {
|
|
21
|
+
readonly CALENDAR_DAY: "CALENDAR_DAY";
|
|
22
|
+
readonly CALENDAR_MONTH: "CALENDAR_MONTH";
|
|
23
|
+
readonly CALENDAR_WEEK: "CALENDAR_WEEK";
|
|
24
|
+
readonly LIFETIME: "LIFETIME";
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export type AccessBudgetType = (typeof AccessBudgetType)[keyof typeof AccessBudgetType];
|
|
30
|
+
/**
|
|
31
|
+
* <p>Detailed information about an access budget including time bounds, budget allocation, and configuration settings.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export interface AccessBudgetDetails {
|
|
35
|
+
/**
|
|
36
|
+
* <p>The start time for the access budget period.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
startTime: Date | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The end time for the access budget period.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
endTime?: Date | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The remaining budget amount available for use within this access budget.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
remainingBudget: number | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The total budget allocation amount for this access budget.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
budget: number | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:</p> <p> <code>CALENDAR_DAY</code> - Limit table usage per day.</p> <p> <code>CALENDAR_WEEK</code> - Limit table usage per week.</p> <p> <code>CALENDAR_MONTH</code> - Limit table usage per month.</p> <p> <code>LIFETIME</code> - Limit total table usage for the collaboration duration.</p>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
budgetType: AccessBudgetType | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* <p>Indicates whether the budget automatically refreshes for each time period specified in <code>budgetType</code>. Valid values are:</p> <p> <code>ENABLED</code> - The budget refreshes automatically at the start of each period.</p> <p> <code>DISABLED</code> - The budget must be refreshed manually.</p> <p> <code>NULL</code> - The value is null when <code>budgetType</code> is set to <code>LIFETIME</code>.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
autoRefresh?: AutoRefreshMode | undefined;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* <p>Controls and tracks usage limits for associated configured tables within a collaboration across queries and job. Supports both period-based budgets that can renew (daily, weekly, or monthly) and fixed lifetime budgets. Contains the resource ARN, remaining budget information, and up to two budget configurations (period-based and lifetime). By default, table usage is unlimited unless a budget is configured.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
export interface AccessBudget {
|
|
71
|
+
/**
|
|
72
|
+
* <p>The Amazon Resource Name (ARN) of the access budget resource.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
resourceArn: string | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>Detailed budget information including time bounds, remaining budget, and refresh settings.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
details: AccessBudgetDetails[] | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see <code>remainingBudget</code>.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
aggregateRemainingBudget: number | undefined;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* <p>Individual budget parameter configuration that defines specific budget allocation settings for access budgets.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export interface BudgetParameter {
|
|
92
|
+
/**
|
|
93
|
+
* <p>The type of budget parameter being configured.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
type: AccessBudgetType | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* <p>The budget allocation amount for this specific parameter.</p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
budget: number | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* <p>Whether this individual budget parameter automatically refreshes when the budget period resets.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
autoRefresh?: AutoRefreshMode | undefined;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* <p>Input parameters for privacy budget templates that support access budgets functionality, enabling enhanced budget management capabilities.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export interface AccessBudgetsPrivacyTemplateParametersInput {
|
|
113
|
+
/**
|
|
114
|
+
* <p>An array of budget parameters that define the access budget configuration for the privacy template.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
budgetParameters: BudgetParameter[] | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <p>The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
resourceArn: string | undefined;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* <p>Output parameters for privacy budget templates with access budgets support, containing the configured budget information.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export interface AccessBudgetsPrivacyTemplateParametersOutput {
|
|
129
|
+
/**
|
|
130
|
+
* <p>An array of budget parameters returned from the access budget configuration.</p>
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
budgetParameters: BudgetParameter[] | undefined;
|
|
134
|
+
/**
|
|
135
|
+
* <p>The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
resourceArn: string | undefined;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* <p>Update parameters for privacy budget templates with access budgets functionality, allowing modification of existing budget configurations.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
export interface AccessBudgetsPrivacyTemplateUpdateParameters {
|
|
145
|
+
/**
|
|
146
|
+
* <p>Updated array of budget parameters for the access budget configuration.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
budgetParameters: BudgetParameter[] | undefined;
|
|
150
|
+
}
|
|
4
151
|
/**
|
|
5
152
|
* @public
|
|
6
153
|
* @enum
|
|
@@ -2184,6 +2331,11 @@ export interface Schema {
|
|
|
2184
2331
|
* @public
|
|
2185
2332
|
*/
|
|
2186
2333
|
schemaStatusDetails: SchemaStatusDetail[] | undefined;
|
|
2334
|
+
/**
|
|
2335
|
+
* <p>The Amazon Resource Name (ARN) of the schema resource.</p>
|
|
2336
|
+
* @public
|
|
2337
|
+
*/
|
|
2338
|
+
resourceArn?: string | undefined;
|
|
2187
2339
|
/**
|
|
2188
2340
|
* <p>The schema type properties.</p>
|
|
2189
2341
|
* @public
|
|
@@ -3213,7 +3365,7 @@ export interface DifferentialPrivacyTemplateParametersOutput {
|
|
|
3213
3365
|
* <p>The epsilon and noise parameters that were used in the privacy budget template.</p>
|
|
3214
3366
|
* @public
|
|
3215
3367
|
*/
|
|
3216
|
-
export type PrivacyBudgetTemplateParametersOutput = PrivacyBudgetTemplateParametersOutput.DifferentialPrivacyMember | PrivacyBudgetTemplateParametersOutput.$UnknownMember;
|
|
3368
|
+
export type PrivacyBudgetTemplateParametersOutput = PrivacyBudgetTemplateParametersOutput.AccessBudgetMember | PrivacyBudgetTemplateParametersOutput.DifferentialPrivacyMember | PrivacyBudgetTemplateParametersOutput.$UnknownMember;
|
|
3217
3369
|
/**
|
|
3218
3370
|
* @public
|
|
3219
3371
|
*/
|
|
@@ -3224,6 +3376,16 @@ export declare namespace PrivacyBudgetTemplateParametersOutput {
|
|
|
3224
3376
|
*/
|
|
3225
3377
|
interface DifferentialPrivacyMember {
|
|
3226
3378
|
differentialPrivacy: DifferentialPrivacyTemplateParametersOutput;
|
|
3379
|
+
accessBudget?: never;
|
|
3380
|
+
$unknown?: never;
|
|
3381
|
+
}
|
|
3382
|
+
/**
|
|
3383
|
+
* <p>Access budget configuration returned from the privacy budget template, containing the configured access budget settings.</p>
|
|
3384
|
+
* @public
|
|
3385
|
+
*/
|
|
3386
|
+
interface AccessBudgetMember {
|
|
3387
|
+
differentialPrivacy?: never;
|
|
3388
|
+
accessBudget: AccessBudgetsPrivacyTemplateParametersOutput;
|
|
3227
3389
|
$unknown?: never;
|
|
3228
3390
|
}
|
|
3229
3391
|
/**
|
|
@@ -3231,10 +3393,12 @@ export declare namespace PrivacyBudgetTemplateParametersOutput {
|
|
|
3231
3393
|
*/
|
|
3232
3394
|
interface $UnknownMember {
|
|
3233
3395
|
differentialPrivacy?: never;
|
|
3396
|
+
accessBudget?: never;
|
|
3234
3397
|
$unknown: [string, any];
|
|
3235
3398
|
}
|
|
3236
3399
|
interface Visitor<T> {
|
|
3237
3400
|
differentialPrivacy: (value: DifferentialPrivacyTemplateParametersOutput) => T;
|
|
3401
|
+
accessBudget: (value: AccessBudgetsPrivacyTemplateParametersOutput) => T;
|
|
3238
3402
|
_: (name: string, value: any) => T;
|
|
3239
3403
|
}
|
|
3240
3404
|
const visit: <T>(value: PrivacyBudgetTemplateParametersOutput, visitor: Visitor<T>) => T;
|
|
@@ -3244,6 +3408,7 @@ export declare namespace PrivacyBudgetTemplateParametersOutput {
|
|
|
3244
3408
|
* @enum
|
|
3245
3409
|
*/
|
|
3246
3410
|
export declare const PrivacyBudgetType: {
|
|
3411
|
+
readonly ACCESS_BUDGET: "ACCESS_BUDGET";
|
|
3247
3412
|
readonly DIFFERENTIAL_PRIVACY: "DIFFERENTIAL_PRIVACY";
|
|
3248
3413
|
};
|
|
3249
3414
|
/**
|
|
@@ -3755,6 +3920,11 @@ export interface ListCollaborationPrivacyBudgetsInput {
|
|
|
3755
3920
|
* @public
|
|
3756
3921
|
*/
|
|
3757
3922
|
nextToken?: string | undefined;
|
|
3923
|
+
/**
|
|
3924
|
+
* <p>The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.</p>
|
|
3925
|
+
* @public
|
|
3926
|
+
*/
|
|
3927
|
+
accessBudgetResourceArn?: string | undefined;
|
|
3758
3928
|
}
|
|
3759
3929
|
/**
|
|
3760
3930
|
* @public
|
|
@@ -3812,7 +3982,7 @@ export interface DifferentialPrivacyPrivacyBudget {
|
|
|
3812
3982
|
* <p>The epsilon parameter value and number of each aggregation function that you can perform.</p>
|
|
3813
3983
|
* @public
|
|
3814
3984
|
*/
|
|
3815
|
-
export type PrivacyBudget = PrivacyBudget.DifferentialPrivacyMember | PrivacyBudget.$UnknownMember;
|
|
3985
|
+
export type PrivacyBudget = PrivacyBudget.AccessBudgetMember | PrivacyBudget.DifferentialPrivacyMember | PrivacyBudget.$UnknownMember;
|
|
3816
3986
|
/**
|
|
3817
3987
|
* @public
|
|
3818
3988
|
*/
|
|
@@ -3823,6 +3993,16 @@ export declare namespace PrivacyBudget {
|
|
|
3823
3993
|
*/
|
|
3824
3994
|
interface DifferentialPrivacyMember {
|
|
3825
3995
|
differentialPrivacy: DifferentialPrivacyPrivacyBudget;
|
|
3996
|
+
accessBudget?: never;
|
|
3997
|
+
$unknown?: never;
|
|
3998
|
+
}
|
|
3999
|
+
/**
|
|
4000
|
+
* <p>Access budget information associated with this privacy budget.</p>
|
|
4001
|
+
* @public
|
|
4002
|
+
*/
|
|
4003
|
+
interface AccessBudgetMember {
|
|
4004
|
+
differentialPrivacy?: never;
|
|
4005
|
+
accessBudget: AccessBudget;
|
|
3826
4006
|
$unknown?: never;
|
|
3827
4007
|
}
|
|
3828
4008
|
/**
|
|
@@ -3830,10 +4010,12 @@ export declare namespace PrivacyBudget {
|
|
|
3830
4010
|
*/
|
|
3831
4011
|
interface $UnknownMember {
|
|
3832
4012
|
differentialPrivacy?: never;
|
|
4013
|
+
accessBudget?: never;
|
|
3833
4014
|
$unknown: [string, any];
|
|
3834
4015
|
}
|
|
3835
4016
|
interface Visitor<T> {
|
|
3836
4017
|
differentialPrivacy: (value: DifferentialPrivacyPrivacyBudget) => T;
|
|
4018
|
+
accessBudget: (value: AccessBudget) => T;
|
|
3837
4019
|
_: (name: string, value: any) => T;
|
|
3838
4020
|
}
|
|
3839
4021
|
const visit: <T>(value: PrivacyBudget, visitor: Visitor<T>) => T;
|
|
@@ -4264,6 +4446,11 @@ export interface SchemaSummary {
|
|
|
4264
4446
|
* @public
|
|
4265
4447
|
*/
|
|
4266
4448
|
analysisMethod?: AnalysisMethod | undefined;
|
|
4449
|
+
/**
|
|
4450
|
+
* <p>The Amazon Resource Name (ARN) of the schema summary resource.</p>
|
|
4451
|
+
* @public
|
|
4452
|
+
*/
|
|
4453
|
+
resourceArn?: string | undefined;
|
|
4267
4454
|
/**
|
|
4268
4455
|
* <p> The selected analysis methods for the schema.</p>
|
|
4269
4456
|
* @public
|
|
@@ -6545,115 +6732,6 @@ export declare namespace MembershipProtectedQueryOutputConfiguration {
|
|
|
6545
6732
|
}
|
|
6546
6733
|
const visit: <T>(value: MembershipProtectedQueryOutputConfiguration, visitor: Visitor<T>) => T;
|
|
6547
6734
|
}
|
|
6548
|
-
/**
|
|
6549
|
-
* <p>Contains configurations for protected query results.</p>
|
|
6550
|
-
* @public
|
|
6551
|
-
*/
|
|
6552
|
-
export interface MembershipProtectedQueryResultConfiguration {
|
|
6553
|
-
/**
|
|
6554
|
-
* <p>Configuration for protected query results.</p>
|
|
6555
|
-
* @public
|
|
6556
|
-
*/
|
|
6557
|
-
outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined;
|
|
6558
|
-
/**
|
|
6559
|
-
* <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.</p>
|
|
6560
|
-
* @public
|
|
6561
|
-
*/
|
|
6562
|
-
roleArn?: string | undefined;
|
|
6563
|
-
}
|
|
6564
|
-
/**
|
|
6565
|
-
* @public
|
|
6566
|
-
* @enum
|
|
6567
|
-
*/
|
|
6568
|
-
export declare const MembershipJobLogStatus: {
|
|
6569
|
-
readonly DISABLED: "DISABLED";
|
|
6570
|
-
readonly ENABLED: "ENABLED";
|
|
6571
|
-
};
|
|
6572
|
-
/**
|
|
6573
|
-
* @public
|
|
6574
|
-
*/
|
|
6575
|
-
export type MembershipJobLogStatus = (typeof MembershipJobLogStatus)[keyof typeof MembershipJobLogStatus];
|
|
6576
|
-
/**
|
|
6577
|
-
* <p>An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.</p>
|
|
6578
|
-
* @public
|
|
6579
|
-
*/
|
|
6580
|
-
export interface MembershipJobComputePaymentConfig {
|
|
6581
|
-
/**
|
|
6582
|
-
* <p>Indicates whether the collaboration member has accepted to pay for job compute costs (<code>TRUE</code>) or has not accepted to pay for query and job compute costs (<code>FALSE</code>).</p> <p>There is only one member who pays for queries and jobs. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query and job compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query and job compute costs. </p> </li> </ul>
|
|
6583
|
-
* @public
|
|
6584
|
-
*/
|
|
6585
|
-
isResponsible: boolean | undefined;
|
|
6586
|
-
}
|
|
6587
|
-
/**
|
|
6588
|
-
* <p>An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.</p>
|
|
6589
|
-
* @public
|
|
6590
|
-
*/
|
|
6591
|
-
export interface MembershipModelInferencePaymentConfig {
|
|
6592
|
-
/**
|
|
6593
|
-
* <p>Indicates whether the collaboration member has accepted to pay for model inference costs (<code>TRUE</code>) or has not accepted to pay for model inference costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model inference costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model inference costs. </p> </li> </ul>
|
|
6594
|
-
* @public
|
|
6595
|
-
*/
|
|
6596
|
-
isResponsible: boolean | undefined;
|
|
6597
|
-
}
|
|
6598
|
-
/**
|
|
6599
|
-
* <p>An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.</p>
|
|
6600
|
-
* @public
|
|
6601
|
-
*/
|
|
6602
|
-
export interface MembershipModelTrainingPaymentConfig {
|
|
6603
|
-
/**
|
|
6604
|
-
* <p>Indicates whether the collaboration member has accepted to pay for model training costs (<code>TRUE</code>) or has not accepted to pay for model training costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model training costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model training costs. </p> </li> </ul>
|
|
6605
|
-
* @public
|
|
6606
|
-
*/
|
|
6607
|
-
isResponsible: boolean | undefined;
|
|
6608
|
-
}
|
|
6609
|
-
/**
|
|
6610
|
-
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
|
|
6611
|
-
* @public
|
|
6612
|
-
*/
|
|
6613
|
-
export interface MembershipMLPaymentConfig {
|
|
6614
|
-
/**
|
|
6615
|
-
* <p>The payment responsibilities accepted by the member for model training.</p>
|
|
6616
|
-
* @public
|
|
6617
|
-
*/
|
|
6618
|
-
modelTraining?: MembershipModelTrainingPaymentConfig | undefined;
|
|
6619
|
-
/**
|
|
6620
|
-
* <p>The payment responsibilities accepted by the member for model inference.</p>
|
|
6621
|
-
* @public
|
|
6622
|
-
*/
|
|
6623
|
-
modelInference?: MembershipModelInferencePaymentConfig | undefined;
|
|
6624
|
-
}
|
|
6625
|
-
/**
|
|
6626
|
-
* <p>An object representing the payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
6627
|
-
* @public
|
|
6628
|
-
*/
|
|
6629
|
-
export interface MembershipQueryComputePaymentConfig {
|
|
6630
|
-
/**
|
|
6631
|
-
* <p>Indicates whether the collaboration member has accepted to pay for query compute costs (<code>TRUE</code>) or has not accepted to pay for query compute costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query compute costs. </p> </li> </ul>
|
|
6632
|
-
* @public
|
|
6633
|
-
*/
|
|
6634
|
-
isResponsible: boolean | undefined;
|
|
6635
|
-
}
|
|
6636
|
-
/**
|
|
6637
|
-
* <p>An object representing the payment responsibilities accepted by the collaboration member.</p>
|
|
6638
|
-
* @public
|
|
6639
|
-
*/
|
|
6640
|
-
export interface MembershipPaymentConfiguration {
|
|
6641
|
-
/**
|
|
6642
|
-
* <p>The payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
6643
|
-
* @public
|
|
6644
|
-
*/
|
|
6645
|
-
queryCompute: MembershipQueryComputePaymentConfig | undefined;
|
|
6646
|
-
/**
|
|
6647
|
-
* <p>The payment responsibilities accepted by the collaboration member for machine learning costs.</p>
|
|
6648
|
-
* @public
|
|
6649
|
-
*/
|
|
6650
|
-
machineLearning?: MembershipMLPaymentConfig | undefined;
|
|
6651
|
-
/**
|
|
6652
|
-
* <p>The payment responsibilities accepted by the collaboration member for job compute costs.</p>
|
|
6653
|
-
* @public
|
|
6654
|
-
*/
|
|
6655
|
-
jobCompute?: MembershipJobComputePaymentConfig | undefined;
|
|
6656
|
-
}
|
|
6657
6735
|
/**
|
|
6658
6736
|
* @internal
|
|
6659
6737
|
*/
|
|
@@ -1,4 +1,113 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AccessBudgetsPrivacyTemplateParametersInput, AccessBudgetsPrivacyTemplateUpdateParameters, AnalysisType, DifferentialPrivacyAggregationType, MemberAbility, MembershipProtectedJobResultConfiguration, MembershipProtectedQueryOutputConfiguration, MLMemberAbilities, PrivacyBudget, PrivacyBudgetTemplateAutoRefresh, PrivacyBudgetTemplateParametersOutput, PrivacyBudgetType, ProtectedQueryS3OutputConfiguration } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>Contains configurations for protected query results.</p>
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface MembershipProtectedQueryResultConfiguration {
|
|
7
|
+
/**
|
|
8
|
+
* <p>Configuration for protected query results.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
outputConfiguration: MembershipProtectedQueryOutputConfiguration | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
roleArn?: string | undefined;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* @enum
|
|
21
|
+
*/
|
|
22
|
+
export declare const MembershipJobLogStatus: {
|
|
23
|
+
readonly DISABLED: "DISABLED";
|
|
24
|
+
readonly ENABLED: "ENABLED";
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export type MembershipJobLogStatus = (typeof MembershipJobLogStatus)[keyof typeof MembershipJobLogStatus];
|
|
30
|
+
/**
|
|
31
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export interface MembershipJobComputePaymentConfig {
|
|
35
|
+
/**
|
|
36
|
+
* <p>Indicates whether the collaboration member has accepted to pay for job compute costs (<code>TRUE</code>) or has not accepted to pay for query and job compute costs (<code>FALSE</code>).</p> <p>There is only one member who pays for queries and jobs. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query and job compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query and job compute costs. </p> </li> </ul>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
isResponsible: boolean | undefined;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* <p>An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
export interface MembershipModelInferencePaymentConfig {
|
|
46
|
+
/**
|
|
47
|
+
* <p>Indicates whether the collaboration member has accepted to pay for model inference costs (<code>TRUE</code>) or has not accepted to pay for model inference costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model inference costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model inference costs. </p> </li> </ul>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
isResponsible: boolean | undefined;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* <p>An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface MembershipModelTrainingPaymentConfig {
|
|
57
|
+
/**
|
|
58
|
+
* <p>Indicates whether the collaboration member has accepted to pay for model training costs (<code>TRUE</code>) or has not accepted to pay for model training costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for model training costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for model training costs. </p> </li> </ul>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
isResponsible: boolean | undefined;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* <p>An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export interface MembershipMLPaymentConfig {
|
|
68
|
+
/**
|
|
69
|
+
* <p>The payment responsibilities accepted by the member for model training.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
modelTraining?: MembershipModelTrainingPaymentConfig | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The payment responsibilities accepted by the member for model inference.</p>
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
modelInference?: MembershipModelInferencePaymentConfig | undefined;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export interface MembershipQueryComputePaymentConfig {
|
|
84
|
+
/**
|
|
85
|
+
* <p>Indicates whether the collaboration member has accepted to pay for query compute costs (<code>TRUE</code>) or has not accepted to pay for query compute costs (<code>FALSE</code>).</p> <p>If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. </p> <p>An error message is returned for the following reasons: </p> <ul> <li> <p>If you set the value to <code>FALSE</code> but you are responsible to pay for query compute costs. </p> </li> <li> <p>If you set the value to <code>TRUE</code> but you are not responsible to pay for query compute costs. </p> </li> </ul>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
isResponsible: boolean | undefined;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* <p>An object representing the payment responsibilities accepted by the collaboration member.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export interface MembershipPaymentConfiguration {
|
|
95
|
+
/**
|
|
96
|
+
* <p>The payment responsibilities accepted by the collaboration member for query compute costs.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
queryCompute: MembershipQueryComputePaymentConfig | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The payment responsibilities accepted by the collaboration member for machine learning costs.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
machineLearning?: MembershipMLPaymentConfig | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* <p>The payment responsibilities accepted by the collaboration member for job compute costs.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
jobCompute?: MembershipJobComputePaymentConfig | undefined;
|
|
110
|
+
}
|
|
2
111
|
/**
|
|
3
112
|
* @public
|
|
4
113
|
* @enum
|
|
@@ -1207,6 +1316,11 @@ export interface ListPrivacyBudgetsInput {
|
|
|
1207
1316
|
* @public
|
|
1208
1317
|
*/
|
|
1209
1318
|
maxResults?: number | undefined;
|
|
1319
|
+
/**
|
|
1320
|
+
* <p>The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.</p>
|
|
1321
|
+
* @public
|
|
1322
|
+
*/
|
|
1323
|
+
accessBudgetResourceArn?: string | undefined;
|
|
1210
1324
|
}
|
|
1211
1325
|
/**
|
|
1212
1326
|
* <p>An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.</p>
|
|
@@ -1985,7 +2099,7 @@ export interface DifferentialPrivacyTemplateParametersInput {
|
|
|
1985
2099
|
* <p>The epsilon and noise parameters that you want to use for the privacy budget template.</p>
|
|
1986
2100
|
* @public
|
|
1987
2101
|
*/
|
|
1988
|
-
export type PrivacyBudgetTemplateParametersInput = PrivacyBudgetTemplateParametersInput.DifferentialPrivacyMember | PrivacyBudgetTemplateParametersInput.$UnknownMember;
|
|
2102
|
+
export type PrivacyBudgetTemplateParametersInput = PrivacyBudgetTemplateParametersInput.AccessBudgetMember | PrivacyBudgetTemplateParametersInput.DifferentialPrivacyMember | PrivacyBudgetTemplateParametersInput.$UnknownMember;
|
|
1989
2103
|
/**
|
|
1990
2104
|
* @public
|
|
1991
2105
|
*/
|
|
@@ -1996,6 +2110,16 @@ export declare namespace PrivacyBudgetTemplateParametersInput {
|
|
|
1996
2110
|
*/
|
|
1997
2111
|
interface DifferentialPrivacyMember {
|
|
1998
2112
|
differentialPrivacy: DifferentialPrivacyTemplateParametersInput;
|
|
2113
|
+
accessBudget?: never;
|
|
2114
|
+
$unknown?: never;
|
|
2115
|
+
}
|
|
2116
|
+
/**
|
|
2117
|
+
* <p>Access budget configuration for the privacy budget template input, enabling integration with access budget functionality.</p>
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
interface AccessBudgetMember {
|
|
2121
|
+
differentialPrivacy?: never;
|
|
2122
|
+
accessBudget: AccessBudgetsPrivacyTemplateParametersInput;
|
|
1999
2123
|
$unknown?: never;
|
|
2000
2124
|
}
|
|
2001
2125
|
/**
|
|
@@ -2003,10 +2127,12 @@ export declare namespace PrivacyBudgetTemplateParametersInput {
|
|
|
2003
2127
|
*/
|
|
2004
2128
|
interface $UnknownMember {
|
|
2005
2129
|
differentialPrivacy?: never;
|
|
2130
|
+
accessBudget?: never;
|
|
2006
2131
|
$unknown: [string, any];
|
|
2007
2132
|
}
|
|
2008
2133
|
interface Visitor<T> {
|
|
2009
2134
|
differentialPrivacy: (value: DifferentialPrivacyTemplateParametersInput) => T;
|
|
2135
|
+
accessBudget: (value: AccessBudgetsPrivacyTemplateParametersInput) => T;
|
|
2010
2136
|
_: (name: string, value: any) => T;
|
|
2011
2137
|
}
|
|
2012
2138
|
const visit: <T>(value: PrivacyBudgetTemplateParametersInput, visitor: Visitor<T>) => T;
|
|
@@ -2024,7 +2150,7 @@ export interface CreatePrivacyBudgetTemplateInput {
|
|
|
2024
2150
|
* <p>How often the privacy budget refreshes.</p> <important> <p>If you plan to regularly bring new data into the collaboration, you can use <code>CALENDAR_MONTH</code> to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.</p> </important>
|
|
2025
2151
|
* @public
|
|
2026
2152
|
*/
|
|
2027
|
-
autoRefresh
|
|
2153
|
+
autoRefresh?: PrivacyBudgetTemplateAutoRefresh | undefined;
|
|
2028
2154
|
/**
|
|
2029
2155
|
* <p>Specifies the type of the privacy budget template.</p>
|
|
2030
2156
|
* @public
|
|
@@ -2263,7 +2389,7 @@ export interface DifferentialPrivacyTemplateUpdateParameters {
|
|
|
2263
2389
|
* <p>The epsilon and noise parameters that you want to update in the privacy budget template.</p>
|
|
2264
2390
|
* @public
|
|
2265
2391
|
*/
|
|
2266
|
-
export type PrivacyBudgetTemplateUpdateParameters = PrivacyBudgetTemplateUpdateParameters.DifferentialPrivacyMember | PrivacyBudgetTemplateUpdateParameters.$UnknownMember;
|
|
2392
|
+
export type PrivacyBudgetTemplateUpdateParameters = PrivacyBudgetTemplateUpdateParameters.AccessBudgetMember | PrivacyBudgetTemplateUpdateParameters.DifferentialPrivacyMember | PrivacyBudgetTemplateUpdateParameters.$UnknownMember;
|
|
2267
2393
|
/**
|
|
2268
2394
|
* @public
|
|
2269
2395
|
*/
|
|
@@ -2274,6 +2400,16 @@ export declare namespace PrivacyBudgetTemplateUpdateParameters {
|
|
|
2274
2400
|
*/
|
|
2275
2401
|
interface DifferentialPrivacyMember {
|
|
2276
2402
|
differentialPrivacy: DifferentialPrivacyTemplateUpdateParameters;
|
|
2403
|
+
accessBudget?: never;
|
|
2404
|
+
$unknown?: never;
|
|
2405
|
+
}
|
|
2406
|
+
/**
|
|
2407
|
+
* <p> The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.</p>
|
|
2408
|
+
* @public
|
|
2409
|
+
*/
|
|
2410
|
+
interface AccessBudgetMember {
|
|
2411
|
+
differentialPrivacy?: never;
|
|
2412
|
+
accessBudget: AccessBudgetsPrivacyTemplateUpdateParameters;
|
|
2277
2413
|
$unknown?: never;
|
|
2278
2414
|
}
|
|
2279
2415
|
/**
|
|
@@ -2281,10 +2417,12 @@ export declare namespace PrivacyBudgetTemplateUpdateParameters {
|
|
|
2281
2417
|
*/
|
|
2282
2418
|
interface $UnknownMember {
|
|
2283
2419
|
differentialPrivacy?: never;
|
|
2420
|
+
accessBudget?: never;
|
|
2284
2421
|
$unknown: [string, any];
|
|
2285
2422
|
}
|
|
2286
2423
|
interface Visitor<T> {
|
|
2287
2424
|
differentialPrivacy: (value: DifferentialPrivacyTemplateUpdateParameters) => T;
|
|
2425
|
+
accessBudget: (value: AccessBudgetsPrivacyTemplateUpdateParameters) => T;
|
|
2288
2426
|
_: (name: string, value: any) => T;
|
|
2289
2427
|
}
|
|
2290
2428
|
const visit: <T>(value: PrivacyBudgetTemplateUpdateParameters, visitor: Visitor<T>) => T;
|