CleanRoomsService / Paginator / ListPrivacyBudgetTemplates

ListPrivacyBudgetTemplates#

class CleanRoomsService.Paginator.ListPrivacyBudgetTemplates#
paginator = client.get_paginator('list_privacy_budget_templates')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CleanRoomsService.Client.list_privacy_budget_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    membershipIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

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

    • NextToken (string) –

      A token to resume pagination.