CreateTheme -

CreateTheme

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

Request Syntax

POST /accounts/AwsAccountId/themes/ThemeId HTTP/1.1 Content-type: application/json { "BaseThemeId": "string", "Configuration": { "DataColorPalette": { "Colors": [ "string" ], "EmptyFillColor": "string", "MinMaxGradient": [ "string" ] }, "Sheet": { "Tile": { "Border": { "Show": boolean } }, "TileLayout": { "Gutter": { "Show": boolean }, "Margin": { "Show": boolean } } }, "UIColorPalette": { "Accent": "string", "AccentForeground": "string", "Danger": "string", "DangerForeground": "string", "Dimension": "string", "DimensionForeground": "string", "Measure": "string", "MeasureForeground": "string", "PrimaryBackground": "string", "PrimaryForeground": "string", "SecondaryBackground": "string", "SecondaryForeground": "string", "Success": "string", "SuccessForeground": "string", "Warning": "string", "WarningForeground": "string" } }, "Name": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "VersionDescription": "string" }

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account where you want to store the new theme.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

ThemeId

An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

BaseThemeId

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.

Type: String

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

Pattern: [\w\-]+

Required: Yes

Configuration

The theme configuration, which contains the theme display properties.

Type: ThemeConfiguration object

Required: Yes

Name

A display name for the theme.

Type: String

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

Required: Yes

Permissions

A valid grouping of resource permissions to apply to the new theme.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No

Tags

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

VersionDescription

A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "CreationStatus": "string", "RequestId": "string", "ThemeId": "string", "VersionArn": "string" }

Response Elements

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

Status

The HTTP status of the request.

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

Arn

The Amazon Resource Name (ARN) for the theme.

Type: String

CreationStatus

The theme creation status.

Type: String

Valid Values: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED

RequestId

The AWS request ID for this operation.

Type: String

ThemeId

The ID of the theme.

Type: String

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

Pattern: [\w\-]+

VersionArn

The Amazon Resource Name (ARN) for the new theme.

Type: String

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

See Also

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