Skip to content

Commit d069dee

Browse files
author
AWS
committed
AWS Clean Rooms Service Update: This release introduces data access budgets to control how many times a table can be used for queries and jobs in a collaboration.
1 parent ee8b65e commit d069dee

File tree

2 files changed

+225
-2
lines changed

2 files changed

+225
-2
lines changed

‎.changes/next-release/feature-AWSCleanRoomsService-d6a1b3a.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Clean Rooms Service",
4+
"contributor": "",
5+
"description": "This release introduces data access budgets to control how many times a table can be used for queries and jobs in a collaboration."
6+
}

‎services/cleanrooms/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 219 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1667,6 +1667,127 @@
16671667
}
16681668
},
16691669
"shapes":{
1670+
"AccessBudget":{
1671+
"type":"structure",
1672+
"required":[
1673+
"resourceArn",
1674+
"details",
1675+
"aggregateRemainingBudget"
1676+
],
1677+
"members":{
1678+
"resourceArn":{
1679+
"shape":"BudgetedResourceArn",
1680+
"documentation":"<p>The Amazon Resource Name (ARN) of the access budget resource.</p>"
1681+
},
1682+
"details":{
1683+
"shape":"AccessBudgetDetailsList",
1684+
"documentation":"<p>Detailed budget information including time bounds, remaining budget, and refresh settings.</p>"
1685+
},
1686+
"aggregateRemainingBudget":{
1687+
"shape":"RemainingBudget",
1688+
"documentation":"<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>"
1689+
}
1690+
},
1691+
"documentation":"<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>"
1692+
},
1693+
"AccessBudgetDetails":{
1694+
"type":"structure",
1695+
"required":[
1696+
"startTime",
1697+
"remainingBudget",
1698+
"budget",
1699+
"budgetType"
1700+
],
1701+
"members":{
1702+
"startTime":{
1703+
"shape":"Timestamp",
1704+
"documentation":"<p>The start time for the access budget period.</p>"
1705+
},
1706+
"endTime":{
1707+
"shape":"Timestamp",
1708+
"documentation":"<p>The end time for the access budget period.</p>"
1709+
},
1710+
"remainingBudget":{
1711+
"shape":"RemainingBudget",
1712+
"documentation":"<p>The remaining budget amount available for use within this access budget.</p>"
1713+
},
1714+
"budget":{
1715+
"shape":"Budget",
1716+
"documentation":"<p>The total budget allocation amount for this access budget.</p>"
1717+
},
1718+
"budgetType":{
1719+
"shape":"AccessBudgetType",
1720+
"documentation":"<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>"
1721+
},
1722+
"autoRefresh":{
1723+
"shape":"AutoRefreshMode",
1724+
"documentation":"<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>"
1725+
}
1726+
},
1727+
"documentation":"<p>Detailed information about an access budget including time bounds, budget allocation, and configuration settings.</p>"
1728+
},
1729+
"AccessBudgetDetailsList":{
1730+
"type":"list",
1731+
"member":{"shape":"AccessBudgetDetails"},
1732+
"max":2,
1733+
"min":1
1734+
},
1735+
"AccessBudgetType":{
1736+
"type":"string",
1737+
"enum":[
1738+
"CALENDAR_DAY",
1739+
"CALENDAR_MONTH",
1740+
"CALENDAR_WEEK",
1741+
"LIFETIME"
1742+
]
1743+
},
1744+
"AccessBudgetsPrivacyTemplateParametersInput":{
1745+
"type":"structure",
1746+
"required":[
1747+
"budgetParameters",
1748+
"resourceArn"
1749+
],
1750+
"members":{
1751+
"budgetParameters":{
1752+
"shape":"BudgetParameters",
1753+
"documentation":"<p>An array of budget parameters that define the access budget configuration for the privacy template.</p>"
1754+
},
1755+
"resourceArn":{
1756+
"shape":"BudgetedResourceArn",
1757+
"documentation":"<p>The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.</p>"
1758+
}
1759+
},
1760+
"documentation":"<p>Input parameters for privacy budget templates that support access budgets functionality, enabling enhanced budget management capabilities.</p>"
1761+
},
1762+
"AccessBudgetsPrivacyTemplateParametersOutput":{
1763+
"type":"structure",
1764+
"required":[
1765+
"budgetParameters",
1766+
"resourceArn"
1767+
],
1768+
"members":{
1769+
"budgetParameters":{
1770+
"shape":"BudgetParameters",
1771+
"documentation":"<p>An array of budget parameters returned from the access budget configuration.</p>"
1772+
},
1773+
"resourceArn":{
1774+
"shape":"BudgetedResourceArn",
1775+
"documentation":"<p>The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.</p>"
1776+
}
1777+
},
1778+
"documentation":"<p>Output parameters for privacy budget templates with access budgets support, containing the configured budget information.</p>"
1779+
},
1780+
"AccessBudgetsPrivacyTemplateUpdateParameters":{
1781+
"type":"structure",
1782+
"required":["budgetParameters"],
1783+
"members":{
1784+
"budgetParameters":{
1785+
"shape":"BudgetParameters",
1786+
"documentation":"<p>Updated array of budget parameters for the access budget configuration.</p>"
1787+
}
1788+
},
1789+
"documentation":"<p>Update parameters for privacy budget templates with access budgets functionality, allowing modification of existing budget configurations.</p>"
1790+
},
16701791
"AccessDeniedException":{
16711792
"type":"structure",
16721793
"members":{
@@ -2478,6 +2599,13 @@
24782599
"type":"list",
24792600
"member":{"shape":"AutoApprovedChangeType"}
24802601
},
2602+
"AutoRefreshMode":{
2603+
"type":"string",
2604+
"enum":[
2605+
"ENABLED",
2606+
"DISABLED"
2607+
]
2608+
},
24812609
"BatchGetCollaborationAnalysisTemplateError":{
24822610
"type":"structure",
24832611
"required":[
@@ -2704,6 +2832,46 @@
27042832
"type":"boolean",
27052833
"box":true
27062834
},
2835+
"Budget":{
2836+
"type":"integer",
2837+
"box":true,
2838+
"max":1000000,
2839+
"min":0
2840+
},
2841+
"BudgetParameter":{
2842+
"type":"structure",
2843+
"required":[
2844+
"type",
2845+
"budget"
2846+
],
2847+
"members":{
2848+
"type":{
2849+
"shape":"AccessBudgetType",
2850+
"documentation":"<p>The type of budget parameter being configured.</p>"
2851+
},
2852+
"budget":{
2853+
"shape":"Budget",
2854+
"documentation":"<p>The budget allocation amount for this specific parameter.</p>"
2855+
},
2856+
"autoRefresh":{
2857+
"shape":"AutoRefreshMode",
2858+
"documentation":"<p>Whether this individual budget parameter automatically refreshes when the budget period resets.</p>"
2859+
}
2860+
},
2861+
"documentation":"<p>Individual budget parameter configuration that defines specific budget allocation settings for access budgets.</p>"
2862+
},
2863+
"BudgetParameters":{
2864+
"type":"list",
2865+
"member":{"shape":"BudgetParameter"},
2866+
"max":2,
2867+
"min":1
2868+
},
2869+
"BudgetedResourceArn":{
2870+
"type":"string",
2871+
"max":200,
2872+
"min":0,
2873+
"pattern":"arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredtableassociation/[\\d\\w-]+"
2874+
},
27072875
"Change":{
27082876
"type":"structure",
27092877
"required":[
@@ -5031,7 +5199,6 @@
50315199
"type":"structure",
50325200
"required":[
50335201
"membershipIdentifier",
5034-
"autoRefresh",
50355202
"privacyBudgetType",
50365203
"parameters"
50375204
],
@@ -7124,6 +7291,12 @@
71247291
"documentation":"<p>The pagination token that's used to fetch the next set of results.</p>",
71257292
"location":"querystring",
71267293
"locationName":"nextToken"
7294+
},
7295+
"accessBudgetResourceArn":{
7296+
"shape":"BudgetedResourceArn",
7297+
"documentation":"<p>The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.</p>",
7298+
"location":"querystring",
7299+
"locationName":"accessBudgetResourceArn"
71277300
}
71287301
}
71297302
},
@@ -7504,6 +7677,12 @@
75047677
"documentation":"<p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p>",
75057678
"location":"querystring",
75067679
"locationName":"maxResults"
7680+
},
7681+
"accessBudgetResourceArn":{
7682+
"shape":"BudgetedResourceArn",
7683+
"documentation":"<p>The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.</p>",
7684+
"location":"querystring",
7685+
"locationName":"accessBudgetResourceArn"
75077686
}
75087687
}
75097688
},
@@ -8353,6 +8532,10 @@
83538532
"differentialPrivacy":{
83548533
"shape":"DifferentialPrivacyPrivacyBudget",
83558534
"documentation":"<p>An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.</p>"
8535+
},
8536+
"accessBudget":{
8537+
"shape":"AccessBudget",
8538+
"documentation":"<p>Access budget information associated with this privacy budget.</p>"
83568539
}
83578540
},
83588541
"documentation":"<p>The epsilon parameter value and number of each aggregation function that you can perform.</p>",
@@ -8513,6 +8696,10 @@
85138696
"differentialPrivacy":{
85148697
"shape":"DifferentialPrivacyTemplateParametersInput",
85158698
"documentation":"<p>An object that specifies the epsilon and noise parameters.</p>"
8699+
},
8700+
"accessBudget":{
8701+
"shape":"AccessBudgetsPrivacyTemplateParametersInput",
8702+
"documentation":"<p>Access budget configuration for the privacy budget template input, enabling integration with access budget functionality.</p>"
85168703
}
85178704
},
85188705
"documentation":"<p>The epsilon and noise parameters that you want to use for the privacy budget template.</p>",
@@ -8524,6 +8711,10 @@
85248711
"differentialPrivacy":{
85258712
"shape":"DifferentialPrivacyTemplateParametersOutput",
85268713
"documentation":"<p>The epsilon and noise parameters.</p>"
8714+
},
8715+
"accessBudget":{
8716+
"shape":"AccessBudgetsPrivacyTemplateParametersOutput",
8717+
"documentation":"<p>Access budget configuration returned from the privacy budget template, containing the configured access budget settings.</p>"
85278718
}
85288719
},
85298720
"documentation":"<p>The epsilon and noise parameters that were used in the privacy budget template.</p>",
@@ -8592,14 +8783,21 @@
85928783
"differentialPrivacy":{
85938784
"shape":"DifferentialPrivacyTemplateUpdateParameters",
85948785
"documentation":"<p>An object that specifies the new values for the epsilon and noise parameters.</p>"
8786+
},
8787+
"accessBudget":{
8788+
"shape":"AccessBudgetsPrivacyTemplateUpdateParameters",
8789+
"documentation":"<p> The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.</p>"
85958790
}
85968791
},
85978792
"documentation":"<p>The epsilon and noise parameters that you want to update in the privacy budget template.</p>",
85988793
"union":true
85998794
},
86008795
"PrivacyBudgetType":{
86018796
"type":"string",
8602-
"enum":["DIFFERENTIAL_PRIVACY"]
8797+
"enum":[
8798+
"DIFFERENTIAL_PRIVACY",
8799+
"ACCESS_BUDGET"
8800+
]
86038801
},
86048802
"PrivacyImpact":{
86058803
"type":"structure",
@@ -9439,6 +9637,11 @@
94399637
"type":"list",
94409638
"member":{"shape":"ReceiverConfiguration"}
94419639
},
9640+
"RemainingBudget":{
9641+
"type":"integer",
9642+
"box":true,
9643+
"min":0
9644+
},
94429645
"ResourceAlias":{
94439646
"type":"string",
94449647
"max":128,
@@ -9632,6 +9835,10 @@
96329835
"shape":"SchemaStatusDetailList",
96339836
"documentation":"<p>Details about the status of the schema. Currently, only one entry is present.</p>"
96349837
},
9838+
"resourceArn":{
9839+
"shape":"SchemaResourceArn",
9840+
"documentation":"<p>The Amazon Resource Name (ARN) of the schema resource.</p>"
9841+
},
96359842
"schemaTypeProperties":{
96369843
"shape":"SchemaTypeProperties",
96379844
"documentation":"<p>The schema type properties.</p>"
@@ -9683,6 +9890,12 @@
96839890
"max":25,
96849891
"min":0
96859892
},
9893+
"SchemaResourceArn":{
9894+
"type":"string",
9895+
"max":200,
9896+
"min":0,
9897+
"pattern":"arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership\\/[\\d\\w-]+\\/(configuredtableassociation|idmappingtable)\\/[\\d\\w-]+"
9898+
},
96869899
"SchemaStatus":{
96879900
"type":"string",
96889901
"enum":[
@@ -9811,6 +10024,10 @@
981110024
"shape":"AnalysisMethod",
981210025
"documentation":"<p>The analysis method for the associated schema.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>"
981310026
},
10027+
"resourceArn":{
10028+
"shape":"SchemaResourceArn",
10029+
"documentation":"<p>The Amazon Resource Name (ARN) of the schema summary resource.</p>"
10030+
},
981410031
"selectedAnalysisMethods":{
981510032
"shape":"SelectedAnalysisMethods",
981610033
"documentation":"<p> The selected analysis methods for the schema.</p>"

0 commit comments

Comments
 (0)