AmplifyUIBuilder / Client / get_theme

get_theme#

AmplifyUIBuilder.Client.get_theme(**kwargs)#

Returns an existing theme for an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.get_theme(
    appId='string',
    environmentName='string',
    id='string'
)
Parameters:

  • appId (string) –

    [REQUIRED]

    The unique ID of the Amplify app.

  • environmentName (string) –

    [REQUIRED]

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

  • id (string) –

    [REQUIRED]

    The unique ID for the theme.

Return type:

dict

Returns:

Response Syntax

{
    'theme': {
        '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'
        }
    }
}

Response Structure

  • (dict) –

    • theme (dict) –

      Represents the configuration settings for the theme.

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

Exceptions