aws_quicksight_analysis

account_id

Type: STRING

analysis

Type: STRUCT
Provider name: Analysis
Description: A metadata structure that contains summary information for the analysis that you’re describing.

• analysis_id
  Type: STRING
  Provider name: AnalysisId
  Description: The ID of the analysis.
  
• arn
  Type: STRING
  Provider name: Arn
  Description: The Amazon Resource Name (ARN) of the analysis.
  
• created_time
  Type: TIMESTAMP
  Provider name: CreatedTime
  Description: The time that the analysis was created.
  
• data_set_arns
  Type: UNORDERED_LIST_STRING
  Provider name: DataSetArns
  Description: The ARNs of the datasets of the analysis.
  
• errors
  Type: UNORDERED_LIST_STRUCT
  Provider name: Errors
  Description: Errors associated with the analysis.
  
  • message
    Type: STRING
    Provider name: Message
    Description: The message associated with the analysis error.
    
  • type
    Type: STRING
    Provider name: Type
    Description: The type of the analysis error.
    
  • violated_entities
    Type: UNORDERED_LIST_STRUCT
    Provider name: ViolatedEntities
    Description: Lists the violated entities that caused the analysis error
    
    • path
      Type: STRING
      Provider name: Path
      Description: The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
      
• last_updated_time
  Type: TIMESTAMP
  Provider name: LastUpdatedTime
  Description: The time that the analysis was last updated.
  
• name
  Type: STRING
  Provider name: Name
  Description: The descriptive name of the analysis.
  
• sheets
  Type: UNORDERED_LIST_STRUCT
  Provider name: Sheets
  Description: A list of the associated sheets with the unique identifier and name of each sheet.
  
  • images
    Type: UNORDERED_LIST_STRUCT
    Provider name: Images
    Description: A list of images on a sheet.
    
    • actions
      Type: UNORDERED_LIST_STRUCT
      Provider name: Actions
      Description: A list of custom actions that are configured for an image.
      
      • action_operations
        Type: UNORDERED_LIST_STRUCT
        Provider name: ActionOperations
        Description: A list of ImageCustomActionOperations. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
        
        • navigation_operation
          Type: STRUCT
          Provider name: NavigationOperation
          
          • local_navigation_configuration
            Type: STRUCT
            Provider name: LocalNavigationConfiguration
            Description: The configuration that chooses the navigation target.
            
            • target_sheet_id
              Type: STRING
              Provider name: TargetSheetId
              Description: The sheet that is targeted for navigation in the same analysis.
              
        • set_parameters_operation
          Type: STRUCT
          Provider name: SetParametersOperation
          
          • parameter_value_configurations
            Type: UNORDERED_LIST_STRUCT
            Provider name: ParameterValueConfigurations
            Description: The parameter that determines the value configuration.
            
            • destination_parameter_name
              Type: STRING
              Provider name: DestinationParameterName
              Description: The destination parameter name of the SetParameterValueConfiguration.
              
            • value
              Type: STRUCT
              Provider name: Value
              
              • custom_values_configuration
                Type: STRUCT
                Provider name: CustomValuesConfiguration
                Description: The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.
                
                • custom_values
                  Type: STRUCT
                  Provider name: CustomValues
                  
                  • date_time_values
                    Type: UNORDERED_LIST_TIMESTAMP
                    Provider name: DateTimeValues
                    Description: A list of datetime-type parameter values.
                    
                  • decimal_values
                    Type: UNORDERED_LIST_DOUBLE
                    Provider name: DecimalValues
                    Description: A list of decimal-type parameter values.
                    
                  • integer_values
                    Type: UNORDERED_LIST_INT64
                    Provider name: IntegerValues
                    Description: A list of integer-type parameter values.
                    
                  • string_values
                    Type: UNORDERED_LIST_STRING
                    Provider name: StringValues
                    Description: A list of string-type parameter values.
                    
                • include_null_value
                  Type: BOOLEAN
                  Provider name: IncludeNullValue
                  Description: Includes the null value in custom action parameter values.
                  
              • select_all_value_options
                Type: STRING
                Provider name: SelectAllValueOptions
                Description: The configuration that selects all options.
                
              • source_column
                Type: STRUCT
                Provider name: SourceColumn
                
                • column_name
                  Type: STRING
                  Provider name: ColumnName
                  Description: The name of the column.
                  
                • data_set_identifier
                  Type: STRING
                  Provider name: DataSetIdentifier
                  Description: The data set that the column belongs to.
                  
              • source_field
                Type: STRING
                Provider name: SourceField
                Description: The source field ID of the destination parameter.
                
              • source_parameter_name
                Type: STRING
                Provider name: SourceParameterName
                Description: The source parameter name of the destination parameter.
                
        • url_operation
          Type: STRUCT
          Provider name: URLOperation
          
          • url_target
            Type: STRING
            Provider name: URLTarget
            Description: 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
            Type: STRING
            Provider name: URLTemplate
            Description: THe URL link of the CustomActionURLOperation.
            
      • custom_action_id
        Type: STRING
        Provider name: CustomActionId
        Description: The ID of the custom action.
        
      • name
        Type: STRING
        Provider name: Name
        Description: The name of the custom action.
        
      • status
        Type: STRING
        Provider name: Status
        Description: The status of the custom action.
        
      • trigger
        Type: STRING
        Provider name: Trigger
        Description: 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.
    • image_content_alt_text
      Type: STRING
      Provider name: ImageContentAltText
      Description: The alt text for the image.
      
    • interactions
      Type: STRUCT
      Provider name: Interactions
      Description: The general image interactions setup for an image.
      
      • image_menu_option
        Type: STRUCT
        Provider name: ImageMenuOption
        Description: The menu options for the image.
        
        • availability_status
          Type: STRING
          Provider name: AvailabilityStatus
          Description: 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.
          
    • scaling
      Type: STRUCT
      Provider name: Scaling
      Description: Determines how the image is scaled.
      
      • scaling_type
        Type: STRING
        Provider name: ScalingType
        Description: 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.
    • sheet_image_id
      Type: STRING
      Provider name: SheetImageId
      Description: The ID of the sheet image.
      
    • source
      Type: STRUCT
      Provider name: Source
      Description: The source of the image.
      
      • sheet_image_static_file_source
        Type: STRUCT
        Provider name: SheetImageStaticFileSource
        Description: The source of the static file that contains the image.
        
        • static_file_id
          Type: STRING
          Provider name: StaticFileId
          Description: The ID of the static file that contains the image.
          
    • tooltip
      Type: STRUCT
      Provider name: Tooltip
      Description: The tooltip to be shown when hovering over the image.
      
      • tooltip_text
        Type: STRUCT
        Provider name: TooltipText
        Description: The text that appears in the tooltip.
        
        • plain_text
          Type: STRING
          Provider name: PlainText
          Description: The plain text format.
          
      • visibility
        Type: STRING
        Provider name: Visibility
        Description: The visibility of the tooltip.
        
  • name
    Type: STRING
    Provider name: Name
    Description: The name of a sheet. This name is displayed on the sheet’s tab in the Amazon QuickSight console.
    
  • sheet_id
    Type: STRING
    Provider name: SheetId
    Description: The unique identifier associated with a sheet.
    
• status
  Type: STRING
  Provider name: Status
  Description: Status associated with the analysis.
  
• theme_arn
  Type: STRING
  Provider name: ThemeArn
  Description: The ARN of the theme of the analysis.
  

request_id

Type: STRING
Provider name: RequestId
Description: The Amazon Web Services request ID for this operation.

status

Type: INT32
Provider name: Status
Description: The HTTP status of the request.

tags

Type: UNORDERED_LIST_STRING