create_theme

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',
    clientToken='string',
    environmentName='string',
    themeToCreate={
        'name': 'string',
        'overrides': [
            {
                'key': 'string',
                'value': {
                    'children': {'... recursive ...'},
                    'value': 'string'
                }
            },
        ],
        'tags': {
            'string': 'string'
        },
        'values': [
            {
                'key': 'string',
                'value': {
                    'children': {'... recursive ...'},
                    'value': 'string'
                }
            },
        ]
    }
)
Parameters
  • appId (string) --

    [REQUIRED]

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

  • clientToken (string) --

    The unique client token.

    This field is autopopulated if not provided.

  • environmentName (string) --

    [REQUIRED]

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

  • themeToCreate (dict) --

    [REQUIRED]

    Represents the configuration of the theme to create.

    • name (string) -- [REQUIRED]

      The name of the theme.

    • 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.

          • children (list) --

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

          • value (string) --

            The value of a theme property.

    • tags (dict) --

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

      • (string) --
        • (string) --
    • 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.

          • children (list) --

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

          • value (string) --

            The value of a theme property.

Return type

dict

Returns

Response Syntax

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

      • createdAt (datetime) --

        The time that the theme was created.

      • environmentName (string) --

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

      • id (string) --

        The ID for the theme.

      • modifiedAt (datetime) --

        The time that the theme was modified.

      • name (string) --

        The name of the theme.

      • 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.

            • children (list) --

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

            • value (string) --

              The value of a theme property.

      • tags (dict) --

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

        • (string) --
          • (string) --
      • 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.

            • children (list) --

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

            • value (string) --

              The value of a theme property.

Exceptions

  • AmplifyUIBuilder.Client.exceptions.ServiceQuotaExceededException
  • AmplifyUIBuilder.Client.exceptions.ResourceConflictException
  • AmplifyUIBuilder.Client.exceptions.InternalServerException
  • AmplifyUIBuilder.Client.exceptions.InvalidParameterException