CleanRoomsService / Client / list_privacy_budget_templates

list_privacy_budget_templates#

CleanRoomsService.Client.list_privacy_budget_templates(**kwargs)#

Returns detailed information about the privacy budget templates in a specified membership.

See also: AWS API Documentation

Request Syntax

response = client.list_privacy_budget_templates(
    membershipIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.

  • nextToken (string) – The pagination token that’s used to fetch the next set of results.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'privacyBudgetTemplateSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'collaborationId': 'string',
            'collaborationArn': 'string',
            'privacyBudgetType': 'DIFFERENTIAL_PRIVACY',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token that’s used to fetch the next set of results.

    • privacyBudgetTemplateSummaries (list) –

      An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.

      • (dict) –

        A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.

        • id (string) –

          The unique identifier of the privacy budget template.

        • arn (string) –

          The ARN of the privacy budget template.

        • membershipId (string) –

          The identifier for a membership resource.

        • membershipArn (string) –

          The Amazon Resource Name (ARN) of the member who created the privacy budget template.

        • collaborationId (string) –

          The unique ID of the collaboration that contains this privacy budget template.

        • collaborationArn (string) –

          The ARN of the collaboration that contains this privacy budget template.

        • privacyBudgetType (string) –

          The type of the privacy budget template.

        • createTime (datetime) –

          The time at which the privacy budget template was created.

        • updateTime (datetime) –

          The most recent time at which the privacy budget template was updated.

Exceptions