AmplifyUIBuilder / Client / create_theme

create_theme#

AmplifyUIBuilder.Client.create_theme(**kwargs)#

Creates a theme to apply to the components in an Amplify app.

See also: AWS API Documentation

Request Syntax

response = client.create_theme(
    appId='string',
    environmentName='string',
    clientToken='string',
    themeToCreate={
        'name': 'string',
        'values': [
            {
                'key': 'string',
                'value': {
                    'value': 'string',
                    'children': {'... recursive ...'}
                }
            },
        ],
        'overrides': [
            {
                'key': 'string',
                'value': {
                    'value': 'string',
                    'children': {'... recursive ...'}
                }
            },
        ],
        'tags': {
            'string': 'string'
        }
    }
)
Parameters:

  • appId (string) –

    [REQUIRED]

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

  • environmentName (string) –

    [REQUIRED]

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

  • clientToken (string) –

    The unique client token.

    This field is autopopulated if not provided.

  • themeToCreate (dict) –

    [REQUIRED]

    Represents the configuration of the theme to create.

    • name (string) – [REQUIRED]

      The name of the theme.

    • values (list) – [REQUIRED]

      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 an instance 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.

    • tags (dict) –

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

      • (string) –

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'entity': {
        '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) –

    • entity (dict) –

      Describes the configuration of the new 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