AmplifyUIBuilder / Client / export_themes

export_themes#

AmplifyUIBuilder.Client.export_themes(**kwargs)#

Exports theme configurations to code that is ready to integrate into an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.export_themes(
    appId='string',
    environmentName='string',
    nextToken='string'
)
Parameters:

  • appId (string) –

    [REQUIRED]

    The unique ID of the Amplify app to export the themes to.

  • environmentName (string) –

    [REQUIRED]

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

  • 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',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'values': [
                {
                    'key': 'string',
                    'value': {
                        'value': 'string',
                        'children': {'... recursive ...'}
                    }
                },
            ],
            'overrides': [
                {
                    'key': 'string',
                    'value': {
                        'value': 'string',
                        'children': {'... recursive ...'}
                    }
                },
            ],
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • entities (list) –

      Represents the configuration of the exported themes.

      • (dict) –

        A theme is a collection of style settings that apply globally to the components associated with an Amplify application.

        • appId (string) –

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

        • environmentName (string) –

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

        • id (string) –

          The ID for the theme.

        • name (string) –

          The name of the theme.

        • createdAt (datetime) –

          The time that the theme was created.

        • modifiedAt (datetime) –

          The time that the theme was modified.

        • values (list) –

          A list of key-value pairs that defines the properties of the theme.

          • (dict) –

            A key-value pair that defines a property of a theme.

            • key (string) –

              The name of the property.

            • value (dict) –

              The value of the property.

              • value (string) –

                The value of a theme property.

              • children (list) –

                A list of key-value pairs that define the theme’s properties.

        • overrides (list) –

          Describes the properties that can be overriden to customize a theme.

          • (dict) –

            A key-value pair that defines a property of a theme.

            • key (string) –

              The name of the property.

            • value (dict) –

              The value of the property.

              • value (string) –

                The value of a theme property.

              • children (list) –

                A list of key-value pairs that define the theme’s properties.

        • tags (dict) –

          One or more key-value pairs to use when tagging the theme.

          • (string) –

            • (string) –

    • nextToken (string) –

      The pagination token that’s included if more results are available.

Exceptions