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::CreateThemeRequest

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 CreateThemeRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  theme_id: "RestrictiveResourceId", # required
  name: "ThemeName", # required
  base_theme_id: "RestrictiveResourceId", # required
  version_description: "VersionDescription",
  configuration: { # required
    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,
        },
      },
    },
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#base_theme_idString

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 Amazon QuickSight analysis.

Returns:

  • (String)


2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#configurationTypes::ThemeConfiguration

The theme configuration, which contains the theme display properties.



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#nameString

A display name for the theme.

Returns:

  • (String)


2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#permissionsArray<Types::ResourcePermission>

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

Returns:



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#tagsArray<Types::Tag>

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

Returns:



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#theme_idString

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.

Returns:

  • (String)


2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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

#version_descriptionString

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.

Returns:

  • (String)


2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2947

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