AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::UpdateThemeRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass UpdateThemeRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  name: "ThemeName",
  base_theme_id: "RestrictiveResourceId", # required
  version_description: "VersionDescription",
  configuration: {
    data_color_palette: {
      colors: ["HexColor"],
      min_max_gradient: ["HexColor"],
      empty_fill_color: "HexColor",
    },
    ui_color_palette: {
      primary_foreground: "HexColor",
      primary_background: "HexColor",
      secondary_foreground: "HexColor",
      secondary_background: "HexColor",
      accent: "HexColor",
      accent_foreground: "HexColor",
      danger: "HexColor",
      danger_foreground: "HexColor",
      warning: "HexColor",
      warning_foreground: "HexColor",
      success: "HexColor",
      success_foreground: "HexColor",
      dimension: "HexColor",
      dimension_foreground: "HexColor",
      measure: "HexColor",
      measure_foreground: "HexColor",
    },
    sheet: {
      tile: {
        border: {
          show: false,
        },
      },
      tile_layout: {
        gutter: {
          show: false,
        },
        margin: {
          show: false,
        },
      },
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The ID of the Amazon Web Services account that contains the theme that you're updating.

Returns:

  • (String)


14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14793

class UpdateThemeRequest < Struct.new(
  :aws_account_id,
  :theme_id,
  :name,
  :base_theme_id,
  :version_description,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#base_theme_idString

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

Returns:

  • (String)


14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14793

class UpdateThemeRequest < Struct.new(
  :aws_account_id,
  :theme_id,
  :name,
  :base_theme_id,
  :version_description,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#configurationTypes::ThemeConfiguration

The theme configuration, which contains the theme display properties.



14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14793

class UpdateThemeRequest < Struct.new(
  :aws_account_id,
  :theme_id,
  :name,
  :base_theme_id,
  :version_description,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name for the theme.

Returns:

  • (String)


14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14793

class UpdateThemeRequest < Struct.new(
  :aws_account_id,
  :theme_id,
  :name,
  :base_theme_id,
  :version_description,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#theme_idString

The ID for the theme.

Returns:

  • (String)


14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14793

class UpdateThemeRequest < Struct.new(
  :aws_account_id,
  :theme_id,
  :name,
  :base_theme_id,
  :version_description,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end

#version_descriptionString

A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

Returns:

  • (String)


14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 14793

class UpdateThemeRequest < Struct.new(
  :aws_account_id,
  :theme_id,
  :name,
  :base_theme_id,
  :version_description,
  :configuration)
  SENSITIVE = []
  include Aws::Structure
end