[ aws . amplifyuibuilder ]

create-theme

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-theme
--app-id <value>
[--client-token <value>]
--environment-name <value>
--theme-to-create <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

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

--client-token (string)

The unique client token.

--environment-name (string)

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

--theme-to-create (structure)

Represents the configuration of the theme to create.

name -> (string)

The name of the theme.

overrides -> (list)

Describes the properties that can be overriden to customize an instance of the theme.

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

children -> (list)

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

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

value -> (string)

The value of a theme property.

value -> (string)

The value of a theme property.

tags -> (map)

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

key -> (string)

value -> (string)

values -> (list)

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

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

children -> (list)

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

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

value -> (string)

The value of a theme property.

value -> (string)

The value of a theme property.

JSON Syntax:

{
  "name": "string",
  "overrides": [
    {
      "key": "string",
      "value": {
        "children": [
          {
            "key": "string",
            "value": {
              "children": ,
              "value": "string"
            }
          }
          ...
        ],
        "value": "string"
      }
    }
    ...
  ],
  "tags": {"string": "string"
    ...},
  "values": [
    {
      "key": "string",
      "value": {
        "children": [
          {
            "key": "string",
            "value": {
              "children": ,
              "value": "string"
            }
          }
          ...
        ],
        "value": "string"
      }
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

entity -> (structure)

Describes the configuration of the new theme.

appId -> (string)

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

createdAt -> (timestamp)

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

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.

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

children -> (list)

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

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

value -> (string)

The value of a theme property.

value -> (string)

The value of a theme property.

tags -> (map)

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

key -> (string)

value -> (string)

values -> (list)

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

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

children -> (list)

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

(structure)

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

key -> (string)

The name of the property.

value -> (structure)

The value of the property.

value -> (string)

The value of a theme property.

value -> (string)

The value of a theme property.