1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getAnalysis

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

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi

aws-native.quicksight.getAnalysis

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi

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

    Using getAnalysis

    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 getAnalysis(args: GetAnalysisArgs, opts?: InvokeOptions): Promise<GetAnalysisResult>
    function getAnalysisOutput(args: GetAnalysisOutputArgs, opts?: InvokeOptions): Output<GetAnalysisResult>
    def get_analysis(analysis_id: Optional[str] = None,
                     aws_account_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAnalysisResult
    def get_analysis_output(analysis_id: Optional[pulumi.Input[str]] = None,
                     aws_account_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAnalysisResult]
    func LookupAnalysis(ctx *Context, args *LookupAnalysisArgs, opts ...InvokeOption) (*LookupAnalysisResult, error)
    func LookupAnalysisOutput(ctx *Context, args *LookupAnalysisOutputArgs, opts ...InvokeOption) LookupAnalysisResultOutput

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

    public static class GetAnalysis 
    {
        public static Task<GetAnalysisResult> InvokeAsync(GetAnalysisArgs args, InvokeOptions? opts = null)
        public static Output<GetAnalysisResult> Invoke(GetAnalysisInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAnalysisResult> getAnalysis(GetAnalysisArgs args, InvokeOptions options)
    public static Output<GetAnalysisResult> getAnalysis(GetAnalysisArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:quicksight:getAnalysis
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AnalysisId string
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    AwsAccountId string
    The ID of the AWS account where you are creating an analysis.
    AnalysisId string
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    AwsAccountId string
    The ID of the AWS account where you are creating an analysis.
    analysisId String
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    awsAccountId String
    The ID of the AWS account where you are creating an analysis.
    analysisId string
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    awsAccountId string
    The ID of the AWS account where you are creating an analysis.
    analysis_id str
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    aws_account_id str
    The ID of the AWS account where you are creating an analysis.
    analysisId String
    The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
    awsAccountId String
    The ID of the AWS account where you are creating an analysis.

    getAnalysis Result

    The following output properties are available:

    Arn string
    CreatedTime string
    DataSetArns List<string>
    Errors List<Pulumi.AwsNative.QuickSight.Outputs.AnalysisError>
    LastUpdatedTime string
    Name string
    Permissions List<Pulumi.AwsNative.QuickSight.Outputs.AnalysisResourcePermission>

    A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    Sheets List<Pulumi.AwsNative.QuickSight.Outputs.AnalysisSheet>
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    ThemeArn string
    Arn string
    CreatedTime string
    DataSetArns []string
    Errors []AnalysisError
    LastUpdatedTime string
    Name string
    Permissions []AnalysisResourcePermission

    A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    Sheets []AnalysisSheet
    Tags Tag
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    ThemeArn string
    arn String
    createdTime String
    dataSetArns List<String>
    errors List<AnalysisError>
    lastUpdatedTime String
    name String
    permissions List<AnalysisResourcePermission>

    A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets List<AnalysisSheet>
    tags List<Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    themeArn String
    arn string
    createdTime string
    dataSetArns string[]
    errors AnalysisError[]
    lastUpdatedTime string
    name string
    permissions AnalysisResourcePermission[]

    A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets AnalysisSheet[]
    tags Tag[]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    themeArn string
    arn str
    created_time str
    data_set_arns Sequence[str]
    errors Sequence[AnalysisError]
    last_updated_time str
    name str
    permissions Sequence[AnalysisResourcePermission]

    A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets Sequence[AnalysisSheet]
    tags Sequence[root_Tag]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    theme_arn str
    arn String
    createdTime String
    dataSetArns List<String>
    errors List<Property Map>
    lastUpdatedTime String
    name String
    permissions List<Property Map>

    A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

    To specify no permissions, omit Permissions .

    sheets List<Property Map>
    tags List<Property Map>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    themeArn String

    Supporting Types

    AnalysisColumnIdentifier

    ColumnName string
    The name of the column.
    DataSetIdentifier string
    The data set that the column belongs to.
    ColumnName string
    The name of the column.
    DataSetIdentifier string
    The data set that the column belongs to.
    columnName String
    The name of the column.
    dataSetIdentifier String
    The data set that the column belongs to.
    columnName string
    The name of the column.
    dataSetIdentifier string
    The data set that the column belongs to.
    column_name str
    The name of the column.
    data_set_identifier str
    The data set that the column belongs to.
    columnName String
    The name of the column.
    dataSetIdentifier String
    The data set that the column belongs to.

    AnalysisCustomActionNavigationOperation

    LocalNavigationConfiguration AnalysisLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    localNavigationConfiguration AnalysisLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    localNavigationConfiguration AnalysisLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    local_navigation_configuration AnalysisLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    localNavigationConfiguration Property Map
    The configuration that chooses the navigation target.

    AnalysisCustomActionSetParametersOperation

    ParameterValueConfigurations []AnalysisSetParameterValueConfiguration
    The parameter that determines the value configuration.
    parameterValueConfigurations List<AnalysisSetParameterValueConfiguration>
    The parameter that determines the value configuration.
    parameterValueConfigurations AnalysisSetParameterValueConfiguration[]
    The parameter that determines the value configuration.
    parameter_value_configurations Sequence[AnalysisSetParameterValueConfiguration]
    The parameter that determines the value configuration.
    parameterValueConfigurations List<Property Map>
    The parameter that determines the value configuration.

    AnalysisCustomActionUrlOperation

    UrlTarget Pulumi.AwsNative.QuickSight.AnalysisUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    UrlTemplate string
    THe URL link of the CustomActionURLOperation .
    UrlTarget AnalysisUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    UrlTemplate string
    THe URL link of the CustomActionURLOperation .
    urlTarget AnalysisUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    urlTemplate String
    THe URL link of the CustomActionURLOperation .
    urlTarget AnalysisUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    urlTemplate string
    THe URL link of the CustomActionURLOperation .
    url_target AnalysisUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    url_template str
    THe URL link of the CustomActionURLOperation .
    urlTarget "NEW_TAB" | "NEW_WINDOW" | "SAME_TAB"

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    urlTemplate String
    THe URL link of the CustomActionURLOperation .

    AnalysisCustomParameterValues

    DateTimeValues List<string>
    A list of datetime-type parameter values.
    DecimalValues List<double>
    A list of decimal-type parameter values.
    IntegerValues List<double>
    A list of integer-type parameter values.
    StringValues List<string>
    A list of string-type parameter values.
    DateTimeValues []string
    A list of datetime-type parameter values.
    DecimalValues []float64
    A list of decimal-type parameter values.
    IntegerValues []float64
    A list of integer-type parameter values.
    StringValues []string
    A list of string-type parameter values.
    dateTimeValues List<String>
    A list of datetime-type parameter values.
    decimalValues List<Double>
    A list of decimal-type parameter values.
    integerValues List<Double>
    A list of integer-type parameter values.
    stringValues List<String>
    A list of string-type parameter values.
    dateTimeValues string[]
    A list of datetime-type parameter values.
    decimalValues number[]
    A list of decimal-type parameter values.
    integerValues number[]
    A list of integer-type parameter values.
    stringValues string[]
    A list of string-type parameter values.
    date_time_values Sequence[str]
    A list of datetime-type parameter values.
    decimal_values Sequence[float]
    A list of decimal-type parameter values.
    integer_values Sequence[float]
    A list of integer-type parameter values.
    string_values Sequence[str]
    A list of string-type parameter values.
    dateTimeValues List<String>
    A list of datetime-type parameter values.
    decimalValues List<Number>
    A list of decimal-type parameter values.
    integerValues List<Number>
    A list of integer-type parameter values.
    stringValues List<String>
    A list of string-type parameter values.

    AnalysisCustomValuesConfiguration

    CustomValues Pulumi.AwsNative.QuickSight.Inputs.AnalysisCustomParameterValues
    IncludeNullValue bool
    Includes the null value in custom action parameter values.
    CustomValues AnalysisCustomParameterValues
    IncludeNullValue bool
    Includes the null value in custom action parameter values.
    customValues AnalysisCustomParameterValues
    includeNullValue Boolean
    Includes the null value in custom action parameter values.
    customValues AnalysisCustomParameterValues
    includeNullValue boolean
    Includes the null value in custom action parameter values.
    custom_values AnalysisCustomParameterValues
    include_null_value bool
    Includes the null value in custom action parameter values.
    customValues Property Map
    includeNullValue Boolean
    Includes the null value in custom action parameter values.

    AnalysisDestinationParameterValueConfiguration

    CustomValuesConfiguration Pulumi.AwsNative.QuickSight.Inputs.AnalysisCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    SelectAllValueOptions Pulumi.AwsNative.QuickSight.AnalysisSelectAllValueOptions
    The configuration that selects all options.
    SourceColumn Pulumi.AwsNative.QuickSight.Inputs.AnalysisColumnIdentifier
    A column of a data set.
    SourceField string
    The source field ID of the destination parameter.
    SourceParameterName string
    The source parameter name of the destination parameter.
    CustomValuesConfiguration AnalysisCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    SelectAllValueOptions AnalysisSelectAllValueOptions
    The configuration that selects all options.
    SourceColumn AnalysisColumnIdentifier
    A column of a data set.
    SourceField string
    The source field ID of the destination parameter.
    SourceParameterName string
    The source parameter name of the destination parameter.
    customValuesConfiguration AnalysisCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions AnalysisSelectAllValueOptions
    The configuration that selects all options.
    sourceColumn AnalysisColumnIdentifier
    A column of a data set.
    sourceField String
    The source field ID of the destination parameter.
    sourceParameterName String
    The source parameter name of the destination parameter.
    customValuesConfiguration AnalysisCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions AnalysisSelectAllValueOptions
    The configuration that selects all options.
    sourceColumn AnalysisColumnIdentifier
    A column of a data set.
    sourceField string
    The source field ID of the destination parameter.
    sourceParameterName string
    The source parameter name of the destination parameter.
    custom_values_configuration AnalysisCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    select_all_value_options AnalysisSelectAllValueOptions
    The configuration that selects all options.
    source_column AnalysisColumnIdentifier
    A column of a data set.
    source_field str
    The source field ID of the destination parameter.
    source_parameter_name str
    The source parameter name of the destination parameter.
    customValuesConfiguration Property Map
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions "ALL_VALUES"
    The configuration that selects all options.
    sourceColumn Property Map
    A column of a data set.
    sourceField String
    The source field ID of the destination parameter.
    sourceParameterName String
    The source parameter name of the destination parameter.

    AnalysisEntity

    Path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    Path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path String
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path str
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path String
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

    AnalysisError

    Message string
    Type AnalysisErrorType
    The type of the analysis error.
    ViolatedEntities []AnalysisEntity
    message string
    type AnalysisErrorType
    The type of the analysis error.
    violatedEntities AnalysisEntity[]

    AnalysisErrorType

    AnalysisImageCustomAction

    ActionOperations List<Pulumi.AwsNative.QuickSight.Inputs.AnalysisImageCustomActionOperation>

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    CustomActionId string
    The ID of the custom action.
    Name string
    The name of the custom action.
    Trigger Pulumi.AwsNative.QuickSight.AnalysisImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    Status Pulumi.AwsNative.QuickSight.AnalysisWidgetStatus
    The status of the custom action.
    ActionOperations []AnalysisImageCustomActionOperation

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    CustomActionId string
    The ID of the custom action.
    Name string
    The name of the custom action.
    Trigger AnalysisImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    Status AnalysisWidgetStatus
    The status of the custom action.
    actionOperations List<AnalysisImageCustomActionOperation>

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    customActionId String
    The ID of the custom action.
    name String
    The name of the custom action.
    trigger AnalysisImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status AnalysisWidgetStatus
    The status of the custom action.
    actionOperations AnalysisImageCustomActionOperation[]

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    customActionId string
    The ID of the custom action.
    name string
    The name of the custom action.
    trigger AnalysisImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status AnalysisWidgetStatus
    The status of the custom action.
    action_operations Sequence[AnalysisImageCustomActionOperation]

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    custom_action_id str
    The ID of the custom action.
    name str
    The name of the custom action.
    trigger AnalysisImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status AnalysisWidgetStatus
    The status of the custom action.
    actionOperations List<Property Map>

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    customActionId String
    The ID of the custom action.
    name String
    The name of the custom action.
    trigger "CLICK" | "MENU"

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status "ENABLED" | "DISABLED"
    The status of the custom action.

    AnalysisImageCustomActionOperation

    AnalysisImageCustomActionTrigger

    AnalysisImageInteractionOptions

    ImageMenuOption AnalysisImageMenuOption
    The menu options for the image.
    imageMenuOption AnalysisImageMenuOption
    The menu options for the image.
    imageMenuOption AnalysisImageMenuOption
    The menu options for the image.
    image_menu_option AnalysisImageMenuOption
    The menu options for the image.
    imageMenuOption Property Map
    The menu options for the image.

    AnalysisImageMenuOption

    AvailabilityStatus object
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    AvailabilityStatus interface{}
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availabilityStatus Object
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availabilityStatus any
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availability_status Any
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availabilityStatus Any
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.

    AnalysisLocalNavigationConfiguration

    TargetSheetId string
    The sheet that is targeted for navigation in the same analysis.
    TargetSheetId string
    The sheet that is targeted for navigation in the same analysis.
    targetSheetId String
    The sheet that is targeted for navigation in the same analysis.
    targetSheetId string
    The sheet that is targeted for navigation in the same analysis.
    target_sheet_id str
    The sheet that is targeted for navigation in the same analysis.
    targetSheetId String
    The sheet that is targeted for navigation in the same analysis.

    AnalysisResourcePermission

    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

    AnalysisSelectAllValueOptions

    AnalysisSetParameterValueConfiguration

    DestinationParameterName string
    The destination parameter name of the SetParameterValueConfiguration .
    Value Pulumi.AwsNative.QuickSight.Inputs.AnalysisDestinationParameterValueConfiguration
    DestinationParameterName string
    The destination parameter name of the SetParameterValueConfiguration .
    Value AnalysisDestinationParameterValueConfiguration
    destinationParameterName String
    The destination parameter name of the SetParameterValueConfiguration .
    value AnalysisDestinationParameterValueConfiguration
    destinationParameterName string
    The destination parameter name of the SetParameterValueConfiguration .
    value AnalysisDestinationParameterValueConfiguration
    destination_parameter_name str
    The destination parameter name of the SetParameterValueConfiguration .
    value AnalysisDestinationParameterValueConfiguration
    destinationParameterName String
    The destination parameter name of the SetParameterValueConfiguration .
    value Property Map

    AnalysisSheet

    Images []AnalysisSheetImage
    A list of images on a sheet.
    Name string
    SheetId string
    images List<AnalysisSheetImage>
    A list of images on a sheet.
    name String
    sheetId String
    images AnalysisSheetImage[]
    A list of images on a sheet.
    name string
    sheetId string
    images Sequence[AnalysisSheetImage]
    A list of images on a sheet.
    name str
    sheet_id str
    images List<Property Map>
    A list of images on a sheet.
    name String
    sheetId String

    AnalysisSheetImage

    SheetImageId string
    The ID of the sheet image.
    Source Pulumi.AwsNative.QuickSight.Inputs.AnalysisSheetImageSource
    The source of the image.
    Actions List<Pulumi.AwsNative.QuickSight.Inputs.AnalysisImageCustomAction>
    A list of custom actions that are configured for an image.
    ImageContentAltText string
    The alt text for the image.
    Interactions Pulumi.AwsNative.QuickSight.Inputs.AnalysisImageInteractionOptions
    The general image interactions setup for an image.
    Scaling Pulumi.AwsNative.QuickSight.Inputs.AnalysisSheetImageScalingConfiguration
    Determines how the image is scaled.
    Tooltip Pulumi.AwsNative.QuickSight.Inputs.AnalysisSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    SheetImageId string
    The ID of the sheet image.
    Source AnalysisSheetImageSource
    The source of the image.
    Actions []AnalysisImageCustomAction
    A list of custom actions that are configured for an image.
    ImageContentAltText string
    The alt text for the image.
    Interactions AnalysisImageInteractionOptions
    The general image interactions setup for an image.
    Scaling AnalysisSheetImageScalingConfiguration
    Determines how the image is scaled.
    Tooltip AnalysisSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId String
    The ID of the sheet image.
    source AnalysisSheetImageSource
    The source of the image.
    actions List<AnalysisImageCustomAction>
    A list of custom actions that are configured for an image.
    imageContentAltText String
    The alt text for the image.
    interactions AnalysisImageInteractionOptions
    The general image interactions setup for an image.
    scaling AnalysisSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip AnalysisSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId string
    The ID of the sheet image.
    source AnalysisSheetImageSource
    The source of the image.
    actions AnalysisImageCustomAction[]
    A list of custom actions that are configured for an image.
    imageContentAltText string
    The alt text for the image.
    interactions AnalysisImageInteractionOptions
    The general image interactions setup for an image.
    scaling AnalysisSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip AnalysisSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheet_image_id str
    The ID of the sheet image.
    source AnalysisSheetImageSource
    The source of the image.
    actions Sequence[AnalysisImageCustomAction]
    A list of custom actions that are configured for an image.
    image_content_alt_text str
    The alt text for the image.
    interactions AnalysisImageInteractionOptions
    The general image interactions setup for an image.
    scaling AnalysisSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip AnalysisSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId String
    The ID of the sheet image.
    source Property Map
    The source of the image.
    actions List<Property Map>
    A list of custom actions that are configured for an image.
    imageContentAltText String
    The alt text for the image.
    interactions Property Map
    The general image interactions setup for an image.
    scaling Property Map
    Determines how the image is scaled.
    tooltip Property Map
    The tooltip to be shown when hovering over the image.

    AnalysisSheetImageScalingConfiguration

    ScalingType Pulumi.AwsNative.QuickSight.AnalysisSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    ScalingType AnalysisSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scalingType AnalysisSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scalingType AnalysisSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scaling_type AnalysisSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scalingType "SCALE_TO_WIDTH" | "SCALE_TO_HEIGHT" | "SCALE_TO_CONTAINER" | "SCALE_NONE"

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.

    AnalysisSheetImageScalingType

    AnalysisSheetImageSource

    SheetImageStaticFileSource AnalysisSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheetImageStaticFileSource AnalysisSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheetImageStaticFileSource AnalysisSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheet_image_static_file_source AnalysisSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheetImageStaticFileSource Property Map
    The source of the static file that contains the image.

    AnalysisSheetImageStaticFileSource

    StaticFileId string
    The ID of the static file that contains the image.
    StaticFileId string
    The ID of the static file that contains the image.
    staticFileId String
    The ID of the static file that contains the image.
    staticFileId string
    The ID of the static file that contains the image.
    static_file_id str
    The ID of the static file that contains the image.
    staticFileId String
    The ID of the static file that contains the image.

    AnalysisSheetImageTooltipConfiguration

    TooltipText AnalysisSheetImageTooltipText
    The text that appears in the tooltip.
    Visibility AnalysisVisibility
    The visibility of the tooltip.
    tooltipText AnalysisSheetImageTooltipText
    The text that appears in the tooltip.
    visibility AnalysisVisibility
    The visibility of the tooltip.
    tooltipText AnalysisSheetImageTooltipText
    The text that appears in the tooltip.
    visibility AnalysisVisibility
    The visibility of the tooltip.
    tooltip_text AnalysisSheetImageTooltipText
    The text that appears in the tooltip.
    visibility AnalysisVisibility
    The visibility of the tooltip.
    tooltipText Property Map
    The text that appears in the tooltip.
    visibility "HIDDEN" | "VISIBLE"
    The visibility of the tooltip.

    AnalysisSheetImageTooltipText

    PlainText string
    The plain text format.
    PlainText string
    The plain text format.
    plainText String
    The plain text format.
    plainText string
    The plain text format.
    plain_text str
    The plain text format.
    plainText String
    The plain text format.

    AnalysisUrlTargetConfiguration

    AnalysisVisibility

    AnalysisWidgetStatus

    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

    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.25.0 published on Monday, Feb 3, 2025 by Pulumi