CreateTheme - AmplifyUIBuilder


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

Request Syntax

POST /app/appId/environment/environmentName/themes?clientToken=clientToken HTTP/1.1 Content-type: application/json { "themeToCreate": { "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } }

URI Request Parameters

The request uses the following URI parameters.


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

Required: Yes


The unique client token.


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

Required: Yes

Request Body

The request accepts the following data in JSON format.


Represents the configuration of the theme to create.

Type: CreateThemeData object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "entity": { "appId": "string", "createdAt": number, "environmentName": "string", "id": "string", "modifiedAt": number, "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Describes the configuration of the new theme.

Type: Theme object


For information about the errors that are common to all actions, see Common Errors.


An internal error has occurred. Please retry your request.

HTTP Status Code: 500


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

HTTP Status Code: 400


The resource specified in the request conflicts with an existing resource.

HTTP Status Code: 409


You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

HTTP Status Code: 402

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: