[ aws . amplifyuibuilder ]

export-themes

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

export-themes is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: entities

Synopsis

  export-themes
--app-id <value>
--environment-name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

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

--environment-name (string)

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

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

entities -> (list)

Represents the configuration of the exported themes.

(structure)

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.

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.

nextToken -> (string)

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