Skip to content

Create Theme

quicksight_create_theme R Documentation

Creates a theme

Description

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.

Usage

quicksight_create_theme(AwsAccountId, ThemeId, Name, BaseThemeId,
  VersionDescription, Configuration, Permissions, Tags)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account where you want to store the new theme.

ThemeId

[required] An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

Name

[required] A display name for the theme.

BaseThemeId

[required] 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 list_themes or choose Themes from within an analysis.

VersionDescription

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

Configuration

[required] The theme configuration, which contains the theme display properties.

Permissions

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

Tags

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

Value

A list with the following syntax: 

list(
  Arn = "string",
  VersionArn = "string",
  ThemeId = "string",
  CreationStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$create_theme(
  AwsAccountId = "string",
  ThemeId = "string",
  Name = "string",
  BaseThemeId = "string",
  VersionDescription = "string",
  Configuration = list(
    DataColorPalette = list(
      Colors = list(
        "string"
      ),
      MinMaxGradient = list(
        "string"
      ),
      EmptyFillColor = "string"
    ),
    UIColorPalette = list(
      PrimaryForeground = "string",
      PrimaryBackground = "string",
      SecondaryForeground = "string",
      SecondaryBackground = "string",
      Accent = "string",
      AccentForeground = "string",
      Danger = "string",
      DangerForeground = "string",
      Warning = "string",
      WarningForeground = "string",
      Success = "string",
      SuccessForeground = "string",
      Dimension = "string",
      DimensionForeground = "string",
      Measure = "string",
      MeasureForeground = "string"
    ),
    Sheet = list(
      Tile = list(
        Border = list(
          Show = TRUE|FALSE
        )
      ),
      TileLayout = list(
        Gutter = list(
          Show = TRUE|FALSE
        ),
        Margin = list(
          Show = TRUE|FALSE
        )
      )
    ),
    Typography = list(
      FontFamilies = list(
        list(
          FontFamily = "string"
        )
      )
    )
  ),
  Permissions = list(
    list(
      Principal = "string",
      Actions = list(
        "string"
      )
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)