CodeCatalyst / Paginator / ListProjects


class CodeCatalyst.Paginator.ListProjects#
paginator = client.get_paginator('list_projects')

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_projects().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'key': 'hasAccessTo'|'name',
            'values': [
            'comparisonOperator': 'EQ'|'GT'|'GE'|'LT'|'LE'|'BEGINS_WITH'
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • spaceName (string) –


    The name of the space.

  • filters (list) –

    Information about filters to apply to narrow the results returned in the list.

    • (dict) –

      nformation about the filter used to narrow the results returned in a list of projects.

      • key (string) – [REQUIRED]

        A key that can be used to sort results.

      • values (list) – [REQUIRED]

        The values of the key.

        • (string) –

      • comparisonOperator (string) –

        The operator used to compare the fields.

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



Response Syntax

    'items': [
            'name': 'string',
            'displayName': 'string',
            'description': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • items (list) –

      Information about the projects.

      • (dict) –

        Information about a project.

        • name (string) –

          The name of the project in the space.

        • displayName (string) –

          The friendly name displayed to users of the project in Amazon CodeCatalyst.

        • description (string) –

          The description of the project.

    • NextToken (string) –

      A token to resume pagination.