CleanRoomsService / Client / list_collaboration_privacy_budgets
list_collaboration_privacy_budgets#
- CleanRoomsService.Client.list_collaboration_privacy_budgets(**kwargs)#
Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
See also: AWS API Documentation
Request Syntax
response = client.list_collaboration_privacy_budgets( collaborationIdentifier='string', privacyBudgetType='DIFFERENTIAL_PRIVACY', maxResults=123, nextToken='string' )
- Parameters:
collaborationIdentifier (string) –
[REQUIRED]
A unique identifier for one of your collaborations.
privacyBudgetType (string) –
[REQUIRED]
Specifies the type of the privacy budget.
maxResults (integer) – 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.
nextToken (string) – The pagination token that’s used to fetch the next set of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'collaborationPrivacyBudgetSummaries': [ { 'id': 'string', 'privacyBudgetTemplateId': 'string', 'privacyBudgetTemplateArn': 'string', 'collaborationId': 'string', 'collaborationArn': 'string', 'creatorAccountId': 'string', 'type': 'DIFFERENTIAL_PRIVACY', 'createTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'budget': { 'differentialPrivacy': { 'aggregations': [ { 'type': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV', 'maxCount': 123, 'remainingCount': 123 }, ], 'epsilon': 123 } } }, ], 'nextToken': 'string' }
Response Structure
(dict) –
collaborationPrivacyBudgetSummaries (list) –
Summaries of the collaboration privacy budgets.
(dict) –
A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.
id (string) –
The unique identifier of the collaboration privacy budget.
privacyBudgetTemplateId (string) –
The unique identifier of the collaboration privacy budget template.
privacyBudgetTemplateArn (string) –
The ARN of the collaboration privacy budget template.
collaborationId (string) –
The unique identifier of the collaboration that includes this privacy budget.
collaborationArn (string) –
The ARN of the collaboration that includes this privacy budget.
creatorAccountId (string) –
The unique identifier of the account that created this privacy budget.
type (string) –
The type of privacy budget template.
createTime (datetime) –
The time at which the privacy budget was created.
updateTime (datetime) –
The most recent time at which the privacy budget was updated.
budget (dict) –
The includes epsilon provided and utility in terms of aggregations.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
differentialPrivacy
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
differentialPrivacy (dict) –
An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
aggregations (list) –
This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.
(dict) –
Information about the total number of aggregations, as well as the remaining aggregations.
type (string) –
The different types of aggregation functions that you can perform.
maxCount (integer) –
The maximum number of aggregation functions that you can perform with the given privacy budget.
remainingCount (integer) –
The remaining number of aggregation functions that can be run with the available privacy budget.
epsilon (integer) –
The epsilon value that you configured.
nextToken (string) –
The pagination token that’s used to fetch the next set of results.
Exceptions