AmplifyUIBuilder / Paginator / ListThemes

ListThemes#

class AmplifyUIBuilder.Paginator.ListThemes#
paginator = client.get_paginator('list_themes')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from AmplifyUIBuilder.Client.list_themes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    appId='string',
    environmentName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • appId (string) –

    [REQUIRED]

    The unique ID for the Amplify app.

  • environmentName (string) –

    [REQUIRED]

    The name of the backend environment that is a part of the Amplify app.

  • 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

{
    'entities': [
        {
            'appId': 'string',
            'environmentName': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • entities (list) –

      The list of themes for the Amplify app.

      • (dict) –

        Describes the basic information about a theme.

        • appId (string) –

          The unique ID for the app associated with the theme summary.

        • environmentName (string) –

          The name of the backend environment that is part of the Amplify app.

        • id (string) –

          The ID of the theme.

        • name (string) –

          The name of the theme.

    • NextToken (string) –

      A token to resume pagination.