list_themes

AmplifyUIBuilder.Client.list_themes(**kwargs)

Retrieves a list of themes for a specified Amplify app and backend environment.

See also: AWS API Documentation

Request Syntax

response = client.list_themes(
    appId='string',
    environmentName='string',
    maxResults=123,
    nextToken='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.

• maxResults (integer) -- The maximum number of theme results to return in the response.
• nextToken (string) -- The token to request the next page of results.

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) --

    The pagination token that's returned if more results are available.

Exceptions

• AmplifyUIBuilder.Client.exceptions.InternalServerException
• AmplifyUIBuilder.Client.exceptions.InvalidParameterException