CleanRoomsService / Paginator / ListAnalysisTemplates

ListAnalysisTemplates#

class CleanRoomsService.Paginator.ListAnalysisTemplates#
paginator = client.get_paginator('list_analysis_templates')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CleanRoomsService.Client.list_analysis_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]

    The identifier for a membership resource.

  • 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

{
    'analysisTemplateSummaries': [
        {
            'arn': 'string',
            'createTime': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'updateTime': datetime(2015, 1, 1),
            'membershipArn': 'string',
            'membershipId': 'string',
            'collaborationArn': 'string',
            'collaborationId': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • analysisTemplateSummaries (list) –

      Lists analysis template metadata.

      • (dict) –

        The metadata of the analysis template.

        • arn (string) –

          The Amazon Resource Name (ARN) of the analysis template.

        • createTime (datetime) –

          The time that the analysis template summary was created.

        • id (string) –

          The identifier of the analysis template.

        • name (string) –

          The name of the analysis template.

        • updateTime (datetime) –

          The time that the analysis template summary was last updated.

        • membershipArn (string) –

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

        • membershipId (string) –

          The identifier for a membership resource.

        • collaborationArn (string) –

          The unique ARN for the analysis template summary’s associated collaboration.

        • collaborationId (string) –

          A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.

        • description (string) –

          The description of the analysis template.

    • NextToken (string) –

      A token to resume pagination.