ExportThemesCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AmplifyUIBuilderClient, ExportThemesCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
// const { AmplifyUIBuilderClient, ExportThemesCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
const client = new AmplifyUIBuilderClient(config);
const input = { // ExportThemesRequest
  appId: "STRING_VALUE", // required
  environmentName: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
};
const command = new ExportThemesCommand(input);
const response = await client.send(command);
// { // ExportThemesResponse
//   entities: [ // ThemeList // required
//     { // Theme
//       appId: "STRING_VALUE", // required
//       environmentName: "STRING_VALUE", // required
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       modifiedAt: new Date("TIMESTAMP"),
//       values: [ // ThemeValuesList // required
//         { // ThemeValues
//           key: "STRING_VALUE",
//           value: { // ThemeValue
//             value: "STRING_VALUE",
//             children: [
//               {
//                 key: "STRING_VALUE",
//                 value: {
//                   value: "STRING_VALUE",
//                   children: "<ThemeValuesList>",
//                 },
//               },
//             ],
//           },
//         },
//       ],
//       overrides: "<ThemeValuesList>",
//       tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ExportThemesCommand Input

See ExportThemesCommandInput for more details

Parameter
Type
Description
appId
Required
string | undefined

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

environmentName
Required
string | undefined

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

nextToken
string | undefined

The token to request the next page of results.

ExportThemesCommand Output

See ExportThemesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
entities
Required
Theme[] | undefined

Represents the configuration of the exported themes.

nextToken
string | undefined

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

Throws

Name
Fault
Details
InternalServerException
server

An internal error has occurred. Please retry your request.

InvalidParameterException
client

An invalid or out-of-range value was supplied for the input parameter.

AmplifyUIBuilderServiceException
Base exception class for all service exceptions from AmplifyUIBuilder service.