Describe Theme

quicksight_describe_theme

R Documentation

Describes a theme

Description

Describes a theme.

Usage

quicksight_describe_theme(AwsAccountId, ThemeId, VersionNumber,
  AliasName)

Arguments

AwsAccountId	[required] The ID of the Amazon Web Services account that contains the theme that you're describing.
ThemeId	[required] The ID for the theme.
VersionNumber	The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
AliasName	The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword ⁠$LATEST⁠ in the AliasName parameter. The keyword ⁠$PUBLISHED⁠ doesn't apply to themes.

Value

A list with the following syntax:

list(
  Theme = list(
    Arn = "string",
    Name = "string",
    ThemeId = "string",
    Version = list(
      VersionNumber = 123,
      Arn = "string",
      Description = "string",
      BaseThemeId = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      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(
            BackgroundColor = "string",
            Border = list(
              Color = "string",
              Show = TRUE|FALSE,
              Width = "string"
            ),
            BorderRadius = "string",
            Padding = "string"
          ),
          TileLayout = list(
            Gutter = list(
              Show = TRUE|FALSE
            ),
            Margin = list(
              Show = TRUE|FALSE
            )
          ),
          Background = list(
            Color = "string",
            Gradient = "string"
          )
        ),
        Typography = list(
          FontFamilies = list(
            list(
              FontFamily = "string"
            )
          ),
          AxisTitleFontConfiguration = list(
            FontSize = list(
              Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
              Absolute = "string"
            ),
            FontDecoration = "UNDERLINE"|"NONE",
            FontColor = "string",
            FontWeight = list(
              Name = "NORMAL"|"BOLD"
            ),
            FontStyle = "NORMAL"|"ITALIC",
            FontFamily = "string"
          ),
          AxisLabelFontConfiguration = list(
            FontSize = list(
              Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
              Absolute = "string"
            ),
            FontDecoration = "UNDERLINE"|"NONE",
            FontColor = "string",
            FontWeight = list(
              Name = "NORMAL"|"BOLD"
            ),
            FontStyle = "NORMAL"|"ITALIC",
            FontFamily = "string"
          ),
          LegendTitleFontConfiguration = list(
            FontSize = list(
              Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
              Absolute = "string"
            ),
            FontDecoration = "UNDERLINE"|"NONE",
            FontColor = "string",
            FontWeight = list(
              Name = "NORMAL"|"BOLD"
            ),
            FontStyle = "NORMAL"|"ITALIC",
            FontFamily = "string"
          ),
          LegendValueFontConfiguration = list(
            FontSize = list(
              Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
              Absolute = "string"
            ),
            FontDecoration = "UNDERLINE"|"NONE",
            FontColor = "string",
            FontWeight = list(
              Name = "NORMAL"|"BOLD"
            ),
            FontStyle = "NORMAL"|"ITALIC",
            FontFamily = "string"
          ),
          DataLabelFontConfiguration = list(
            FontSize = list(
              Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
              Absolute = "string"
            ),
            FontDecoration = "UNDERLINE"|"NONE",
            FontColor = "string",
            FontWeight = list(
              Name = "NORMAL"|"BOLD"
            ),
            FontStyle = "NORMAL"|"ITALIC",
            FontFamily = "string"
          ),
          VisualTitleFontConfiguration = list(
            FontConfiguration = list(
              FontSize = list(
                Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
                Absolute = "string"
              ),
              FontDecoration = "UNDERLINE"|"NONE",
              FontColor = "string",
              FontWeight = list(
                Name = "NORMAL"|"BOLD"
              ),
              FontStyle = "NORMAL"|"ITALIC",
              FontFamily = "string"
            ),
            TextAlignment = "LEFT"|"CENTER"|"RIGHT"|"AUTO",
            TextTransform = "CAPITALIZE"
          ),
          VisualSubtitleFontConfiguration = list(
            FontConfiguration = list(
              FontSize = list(
                Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
                Absolute = "string"
              ),
              FontDecoration = "UNDERLINE"|"NONE",
              FontColor = "string",
              FontWeight = list(
                Name = "NORMAL"|"BOLD"
              ),
              FontStyle = "NORMAL"|"ITALIC",
              FontFamily = "string"
            ),
            TextAlignment = "LEFT"|"CENTER"|"RIGHT"|"AUTO",
            TextTransform = "CAPITALIZE"
          ),
          ControlTitleFontConfiguration = list(
            FontConfiguration = list(
              FontSize = list(
                Relative = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE",
                Absolute = "string"
              ),
              FontDecoration = "UNDERLINE"|"NONE",
              FontColor = "string",
              FontWeight = list(
                Name = "NORMAL"|"BOLD"
              ),
              FontStyle = "NORMAL"|"ITALIC",
              FontFamily = "string"
            ),
            TextAlignment = "LEFT"|"CENTER"|"RIGHT"|"AUTO"
          )
        )
      ),
      Errors = list(
        list(
          Type = "INTERNAL_FAILURE",
          Message = "string"
        )
      ),
      Status = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    Type = "QUICKSIGHT"|"CUSTOM"|"ALL"
  ),
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$describe_theme(
  AwsAccountId = "string",
  ThemeId = "string",
  VersionNumber = 123,
  AliasName = "string"
)