Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getTheme

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.quicksight.getTheme

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of the AWS::QuickSight::Theme Resource Type.

    Using getTheme

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTheme(args: GetThemeArgs, opts?: InvokeOptions): Promise<GetThemeResult>
function getThemeOutput(args: GetThemeOutputArgs, opts?: InvokeOptions): Output<GetThemeResult>
    def get_theme(aws_account_id: Optional[str] = None,
              theme_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetThemeResult
def get_theme_output(aws_account_id: Optional[pulumi.Input[str]] = None,
              theme_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetThemeResult]
    func LookupTheme(ctx *Context, args *LookupThemeArgs, opts ...InvokeOption) (*LookupThemeResult, error)
func LookupThemeOutput(ctx *Context, args *LookupThemeOutputArgs, opts ...InvokeOption) LookupThemeResultOutput

    > Note: This function is named LookupTheme in the Go SDK.

    public static class GetTheme 
{
    public static Task<GetThemeResult> InvokeAsync(GetThemeArgs args, InvokeOptions? opts = null)
    public static Output<GetThemeResult> Invoke(GetThemeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetThemeResult> getTheme(GetThemeArgs args, InvokeOptions options)
public static Output<GetThemeResult> getTheme(GetThemeArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:quicksight:getTheme
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AwsAccountId string
    The ID of the AWS account where you want to store the new theme.
    ThemeId string
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    AwsAccountId string
    The ID of the AWS account where you want to store the new theme.
    ThemeId string
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    awsAccountId String
    The ID of the AWS account where you want to store the new theme.
    themeId String
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    awsAccountId string
    The ID of the AWS account where you want to store the new theme.
    themeId string
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    aws_account_id str
    The ID of the AWS account where you want to store the new theme.
    theme_id str
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    awsAccountId String
    The ID of the AWS account where you want to store the new theme.
    themeId String
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.

    getTheme Result

    The following output properties are available:

    Arn string
    BaseThemeId string
    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 an analysis.
    Configuration Pulumi.AwsNative.QuickSight.Outputs.ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    CreatedTime string
    LastUpdatedTime string
    Name string
    A display name for the theme.
    Permissions List<Pulumi.AwsNative.QuickSight.Outputs.ThemeResourcePermission>
    A valid grouping of resource permissions to apply to the new theme.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    Type Pulumi.AwsNative.QuickSight.ThemeType
    Theme type.
    Version Pulumi.AwsNative.QuickSight.Outputs.ThemeVersion
    VersionDescription string
    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.
    Arn string
    BaseThemeId string
    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 an analysis.
    Configuration ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    CreatedTime string
    LastUpdatedTime string
    Name string
    A display name for the theme.
    Permissions []ThemeResourcePermission
    A valid grouping of resource permissions to apply to the new theme.
    Tags Tag
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    Type ThemeType
    Theme type.
    Version ThemeVersion
    VersionDescription string
    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.
    arn String
    baseThemeId String
    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 an analysis.
    configuration ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    createdTime String
    lastUpdatedTime String
    name String
    A display name for the theme.
    permissions List<ThemeResourcePermission>
    A valid grouping of resource permissions to apply to the new theme.
    tags List<Tag>
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    type ThemeType
    Theme type.
    version ThemeVersion
    versionDescription String
    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.
    arn string
    baseThemeId string
    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 an analysis.
    configuration ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    createdTime string
    lastUpdatedTime string
    name string
    A display name for the theme.
    permissions ThemeResourcePermission[]
    A valid grouping of resource permissions to apply to the new theme.
    tags Tag[]
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    type ThemeType
    Theme type.
    version ThemeVersion
    versionDescription string
    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.
    arn str
    base_theme_id str
    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 an analysis.
    configuration ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    created_time str
    last_updated_time str
    name str
    A display name for the theme.
    permissions Sequence[ThemeResourcePermission]
    A valid grouping of resource permissions to apply to the new theme.
    tags Sequence[root_Tag]
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    type ThemeType
    Theme type.
    version ThemeVersion
    version_description str
    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.
    arn String
    baseThemeId String
    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 an analysis.
    configuration Property Map
    The theme configuration, which contains the theme display properties.
    createdTime String
    lastUpdatedTime String
    name String
    A display name for the theme.
    permissions List<Property Map>
    A valid grouping of resource permissions to apply to the new theme.
    tags List<Property Map>
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    type "QUICKSIGHT" | "CUSTOM" | "ALL"
    Theme type.
    version Property Map
    versionDescription String
    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.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    ThemeBorderStyle

    Show bool
    Show bool
    show Boolean
    show boolean
    show bool
    show Boolean

    ThemeConfiguration

    DataColorPalette Pulumi.AwsNative.QuickSight.Inputs.ThemeDataColorPalette
    Color properties that apply to chart data colors.
    Sheet Pulumi.AwsNative.QuickSight.Inputs.ThemeSheetStyle
    Display options related to sheets.
    Typography Pulumi.AwsNative.QuickSight.Inputs.ThemeTypography
    Determines the typography options.
    UiColorPalette Pulumi.AwsNative.QuickSight.Inputs.ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    DataColorPalette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    Sheet ThemeSheetStyle
    Display options related to sheets.
    Typography ThemeTypography
    Determines the typography options.
    UiColorPalette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    dataColorPalette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    sheet ThemeSheetStyle
    Display options related to sheets.
    typography ThemeTypography
    Determines the typography options.
    uiColorPalette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    dataColorPalette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    sheet ThemeSheetStyle
    Display options related to sheets.
    typography ThemeTypography
    Determines the typography options.
    uiColorPalette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    data_color_palette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    sheet ThemeSheetStyle
    Display options related to sheets.
    typography ThemeTypography
    Determines the typography options.
    ui_color_palette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    dataColorPalette Property Map
    Color properties that apply to chart data colors.
    sheet Property Map
    Display options related to sheets.
    typography Property Map
    Determines the typography options.
    uiColorPalette Property Map
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.

    ThemeDataColorPalette

    Colors List<string>
    EmptyFillColor string
    MinMaxGradient List<string>
    Colors []string
    EmptyFillColor string
    MinMaxGradient []string
    colors List<String>
    emptyFillColor String
    minMaxGradient List<String>
    colors string[]
    emptyFillColor string
    minMaxGradient string[]
    colors Sequence[str]
    empty_fill_color str
    min_max_gradient Sequence[str]
    colors List<String>
    emptyFillColor String
    minMaxGradient List<String>

    ThemeError

    Message string
    Type ThemeErrorType
    The type of error.
    message String
    type ThemeErrorType
    The type of error.
    message string
    type ThemeErrorType
    The type of error.
    message str
    type ThemeErrorType
    The type of error.
    message String
    type "INTERNAL_FAILURE"
    The type of error.

    ThemeErrorType

    ThemeFont

    FontFamily string
    Determines the font family settings.
    FontFamily string
    Determines the font family settings.
    fontFamily String
    Determines the font family settings.
    fontFamily string
    Determines the font family settings.
    font_family str
    Determines the font family settings.
    fontFamily String
    Determines the font family settings.

    ThemeGutterStyle

    Show bool
    Show bool
    show Boolean
    show boolean
    show bool
    show Boolean

    ThemeMarginStyle

    Show bool
    Show bool
    show Boolean
    show boolean
    show bool
    show Boolean

    ThemeResourcePermission

    Actions List<string>
    Principal string
    Actions []string
    Principal string
    actions List<String>
    principal String
    actions string[]
    principal string
    actions Sequence[str]
    principal str
    actions List<String>
    principal String

    ThemeResourceStatus

    ThemeSheetStyle

    Tile ThemeTileStyle
    The display options for tiles.
    TileLayout ThemeTileLayoutStyle
    The layout options for tiles.
    tile ThemeTileStyle
    The display options for tiles.
    tileLayout ThemeTileLayoutStyle
    The layout options for tiles.
    tile ThemeTileStyle
    The display options for tiles.
    tileLayout ThemeTileLayoutStyle
    The layout options for tiles.
    tile ThemeTileStyle
    The display options for tiles.
    tile_layout ThemeTileLayoutStyle
    The layout options for tiles.
    tile Property Map
    The display options for tiles.
    tileLayout Property Map
    The layout options for tiles.

    ThemeTileLayoutStyle

    Gutter Pulumi.AwsNative.QuickSight.Inputs.ThemeGutterStyle
    The gutter settings that apply between tiles.
    Margin Pulumi.AwsNative.QuickSight.Inputs.ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    Gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    Margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter Property Map
    The gutter settings that apply between tiles.
    margin Property Map
    The margin settings that apply around the outside edge of sheets.

    ThemeTileStyle

    Border ThemeBorderStyle
    The border around a tile.
    border ThemeBorderStyle
    The border around a tile.
    border ThemeBorderStyle
    The border around a tile.
    border ThemeBorderStyle
    The border around a tile.
    border Property Map
    The border around a tile.

    ThemeType

    ThemeTypography

    FontFamilies []ThemeFont
    Determines the list of font families.
    fontFamilies List<ThemeFont>
    Determines the list of font families.
    fontFamilies ThemeFont[]
    Determines the list of font families.
    font_families Sequence[ThemeFont]
    Determines the list of font families.
    fontFamilies List<Property Map>
    Determines the list of font families.

    ThemeUiColorPalette

    ThemeVersion

    Arn string
    BaseThemeId string
    Configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    CreatedTime string
    Description string
    Errors []ThemeError
    Status ThemeResourceStatus
    The status of the theme version.
    VersionNumber float64
    arn String
    baseThemeId String
    configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    createdTime String
    description String
    errors List<ThemeError>
    status ThemeResourceStatus
    The status of the theme version.
    versionNumber Double
    arn string
    baseThemeId string
    configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    createdTime string
    description string
    errors ThemeError[]
    status ThemeResourceStatus
    The status of the theme version.
    versionNumber number
    arn str
    base_theme_id str
    configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    created_time str
    description str
    errors Sequence[ThemeError]
    status ThemeResourceStatus
    The status of the theme version.
    version_number float

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native