UpdateTheme - AmplifyUIBuilder

UpdateTheme

Updates an existing theme.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for the Amplify app.

Required: Yes

clientToken

The unique client token.

environmentName

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

Required: Yes

id

The unique ID for the theme.

Required: Yes

Request Body

The request accepts the following data in JSON format.

id

The unique ID of the theme to update.

Type: String

Required: No

name

The name of the theme to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

overrides

Describes the properties that can be overriden to customize the theme.

Type: Array of ThemeValues objects

Required: No

values

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

Type: Array of ThemeValues objects

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "appId": "string", "createdAt": "string", "environmentName": "string", "id": "string", "modifiedAt": "string", "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.

appId

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

Type: String

createdAt

The time that the theme was created.

Type: Timestamp

environmentName

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

Type: String

id

The ID for the theme.

Type: String

modifiedAt

The time that the theme was modified.

Type: Timestamp

name

The name of the theme.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

overrides

Describes the properties that can be overriden to customize a theme.

Type: Array of ThemeValues objects

tags

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 1. Maximum length of 256.

values

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

Type: Array of ThemeValues objects

Errors

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

InternalServerException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

InvalidParameterException

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

HTTP Status Code: 400

ResourceConflictException

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

HTTP Status Code: 409

See Also

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