# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::QuickSight module Types # You don't have access to this item. The provided credentials # couldn't be validated. You might not be authorized to carry out the # request. Make sure that your account is authorized to use the Amazon # QuickSight service, that your policies have the correct permissions, # and that you are using the correct credentials. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :message, :request_id) SENSITIVE = [] include Aws::Structure end # The Amazon QuickSight customizations associated with your Amazon Web # Services account or a QuickSight namespace in a specific Amazon Web # Services Region. # # @!attribute [rw] default_theme # The default theme for this Amazon QuickSight subscription. # @return [String] # # @!attribute [rw] default_email_customization_template # The default email customization template. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation # class AccountCustomization < Struct.new( :default_theme, :default_email_customization_template) SENSITIVE = [] include Aws::Structure end # A structure that contains the following account information elements: # # * Your Amazon QuickSight account name. # # * The edition of Amazon QuickSight that your account is using. # # * The notification email address that is associated with the Amazon # QuickSight account. # # * The authentication type of the Amazon QuickSight account. # # * The status of the Amazon QuickSight account's subscription. # # @!attribute [rw] account_name # The account name that you provided for the Amazon QuickSight # subscription in your Amazon Web Services account. You create this # name when you sign up for Amazon QuickSight. It's unique over all # of Amazon Web Services, and it appears only when users sign in. # @return [String] # # @!attribute [rw] edition # The edition of your Amazon QuickSight account. # @return [String] # # @!attribute [rw] notification_email # The email address that will be used for Amazon QuickSight to send # notifications regarding your Amazon Web Services account or Amazon # QuickSight subscription. # @return [String] # # @!attribute [rw] authentication_type # The way that your Amazon QuickSight account is authenticated. # @return [String] # # @!attribute [rw] account_subscription_status # The status of your account subscription. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountInfo AWS API Documentation # class AccountInfo < Struct.new( :account_name, :edition, :notification_email, :authentication_type, :account_subscription_status) SENSITIVE = [] include Aws::Structure end # The Amazon QuickSight settings associated with your Amazon Web # Services account. # # @!attribute [rw] account_name # The "account name" you provided for the Amazon QuickSight # subscription in your Amazon Web Services account. You create this # name when you sign up for Amazon QuickSight. It is unique in all of # Amazon Web Services and it appears only when users sign in. # @return [String] # # @!attribute [rw] edition # The edition of Amazon QuickSight that you're currently subscribed # to: Enterprise edition or Standard edition. # @return [String] # # @!attribute [rw] default_namespace # The default Amazon QuickSight namespace for your Amazon Web Services # account. # @return [String] # # @!attribute [rw] notification_email # The main notification email for your Amazon QuickSight subscription. # @return [String] # # @!attribute [rw] public_sharing_enabled # A Boolean value that indicates whether public sharing is turned on # for an Amazon QuickSight account. For more information about turning # on public sharing, see [UpdatePublicSharingSettings][1]. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html # @return [Boolean] # # @!attribute [rw] termination_protection_enabled # A boolean value that determines whether or not an Amazon QuickSight # account can be deleted. A `True` value doesn't allow the account to # be deleted and results in an error message if a user tries to make a # `DeleteAccountSubsctiption` request. A `False` value will allow the # ccount to be deleted. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation # class AccountSettings < Struct.new( :account_name, :edition, :default_namespace, :notification_email, :public_sharing_enabled, :termination_protection_enabled) SENSITIVE = [] include Aws::Structure end # The active Identity and Access Management (IAM) policy assignment. # # @!attribute [rw] assignment_name # A name for the IAM policy assignment. # @return [String] # # @!attribute [rw] policy_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ActiveIAMPolicyAssignment AWS API Documentation # class ActiveIAMPolicyAssignment < Struct.new( :assignment_name, :policy_arn) SENSITIVE = [] include Aws::Structure end # An ad hoc (one-time) filtering option. # # @!attribute [rw] availability_status # Availability status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AdHocFilteringOption AWS API Documentation # class AdHocFilteringOption < Struct.new( :availability_status) SENSITIVE = [] include Aws::Structure end # An aggregation function aggregates values from a dimension or measure. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] numerical_aggregation_function # Aggregation for numerical values. # @return [Types::NumericalAggregationFunction] # # @!attribute [rw] categorical_aggregation_function # Aggregation for categorical values. # # * `COUNT`: Aggregate by the total number of values, including # duplicates. # # * `DISTINCT_COUNT`: Aggregate by the total number of distinct # values. # @return [String] # # @!attribute [rw] date_aggregation_function # Aggregation for date values. # # * `COUNT`: Aggregate by the total number of values, including # duplicates. # # * `DISTINCT_COUNT`: Aggregate by the total number of distinct # values. # # * `MIN`: Select the smallest date value. # # * `MAX`: Select the largest date value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AggregationFunction AWS API Documentation # class AggregationFunction < Struct.new( :numerical_aggregation_function, :categorical_aggregation_function, :date_aggregation_function) SENSITIVE = [] include Aws::Structure end # The configuration options to sort aggregated values. # # @!attribute [rw] column # The column that determines the sort order of aggregated values. # @return [Types::ColumnIdentifier] # # @!attribute [rw] sort_direction # The sort direction of values. # # * `ASC`: Sort in ascending order. # # * `DESC`: Sort in descending order. # @return [String] # # @!attribute [rw] aggregation_function # The function that aggregates the values in `Column`. # @return [Types::AggregationFunction] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AggregationSortConfiguration AWS API Documentation # class AggregationSortConfiguration < Struct.new( :column, :sort_direction, :aggregation_function) SENSITIVE = [] include Aws::Structure end # The parameters for OpenSearch. # # @!attribute [rw] domain # The OpenSearch domain. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonElasticsearchParameters AWS API Documentation # class AmazonElasticsearchParameters < Struct.new( :domain) SENSITIVE = [] include Aws::Structure end # The parameters for OpenSearch. # # @!attribute [rw] domain # The OpenSearch domain. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonOpenSearchParameters AWS API Documentation # class AmazonOpenSearchParameters < Struct.new( :domain) SENSITIVE = [] include Aws::Structure end # Metadata structure for an analysis in Amazon QuickSight # # @!attribute [rw] analysis_id # The ID of the analysis. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the analysis. # @return [String] # # @!attribute [rw] name # The descriptive name of the analysis. # @return [String] # # @!attribute [rw] status # Status associated with the analysis. # @return [String] # # @!attribute [rw] errors # Errors associated with the analysis. # @return [Array] # # @!attribute [rw] data_set_arns # The ARNs of the datasets of the analysis. # @return [Array] # # @!attribute [rw] theme_arn # The ARN of the theme of the analysis. # @return [String] # # @!attribute [rw] created_time # The time that the analysis was created. # @return [Time] # # @!attribute [rw] last_updated_time # The time that the analysis was last updated. # @return [Time] # # @!attribute [rw] sheets # A list of the associated sheets with the unique identifier and name # of each sheet. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Analysis AWS API Documentation # class Analysis < Struct.new( :analysis_id, :arn, :name, :status, :errors, :data_set_arns, :theme_arn, :created_time, :last_updated_time, :sheets) SENSITIVE = [] include Aws::Structure end # The configuration for default analysis settings. # # @!attribute [rw] default_new_sheet_configuration # The configuration for default new sheet settings. # @return [Types::DefaultNewSheetConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisDefaults AWS API Documentation # class AnalysisDefaults < Struct.new( :default_new_sheet_configuration) SENSITIVE = [] include Aws::Structure end # The definition of an analysis. # # @!attribute [rw] data_set_identifier_declarations # An array of dataset identifier declarations. This mapping allows the # usage of dataset identifiers instead of dataset ARNs throughout # analysis sub-structures. # @return [Array] # # @!attribute [rw] sheets # An array of sheet definitions for an analysis. Each # `SheetDefinition` provides detailed information about a sheet within # this analysis. # @return [Array] # # @!attribute [rw] calculated_fields # An array of calculated field definitions for the analysis. # @return [Array] # # @!attribute [rw] parameter_declarations # An array of parameter declarations for an analysis. # # Parameters are named variables that can transfer a value for use by # an action or an object. # # For more information, see [Parameters in Amazon QuickSight][1] in # the *Amazon QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html # @return [Array] # # @!attribute [rw] filter_groups # Filter definitions for an analysis. # # For more information, see [Filtering Data in Amazon QuickSight][1] # in the *Amazon QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html # @return [Array] # # @!attribute [rw] column_configurations # An array of analysis-level column configurations. Column # configurations can be used to set default formatting for a column to # be used throughout an analysis. # @return [Array] # # @!attribute [rw] analysis_defaults # The configuration for default analysis settings. # @return [Types::AnalysisDefaults] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisDefinition AWS API Documentation # class AnalysisDefinition < Struct.new( :data_set_identifier_declarations, :sheets, :calculated_fields, :parameter_declarations, :filter_groups, :column_configurations, :analysis_defaults) SENSITIVE = [] include Aws::Structure end # Analysis error. # # @!attribute [rw] type # The type of the analysis error. # @return [String] # # @!attribute [rw] message # The message associated with the analysis error. # @return [String] # # @!attribute [rw] violated_entities # Lists the violated entities that caused the analysis error # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisError AWS API Documentation # class AnalysisError < Struct.new( :type, :message, :violated_entities) SENSITIVE = [] include Aws::Structure end # A filter that you apply when searching for one or more analyses. # # @!attribute [rw] operator # The comparison operator that you want to use as a filter, for # example `"Operator": "StringEquals"`. Valid values are # `"StringEquals"` and `"StringLike"`. # # If you set the operator value to `"StringEquals"`, you need to # provide an ownership related filter in the `"NAME"` field and the # arn of the user or group whose folders you want to search in the # `"Value"` field. For example, `"Name":"DIRECT_QUICKSIGHT_OWNER", # "Operator": "StringEquals", "Value": # "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`. # # If you set the value to `"StringLike"`, you need to provide the name # of the folders you are searching for. For example, # `"Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"`. # The `"StringLike"` operator only supports the `NAME` value # `ANALYSIS_NAME`. # @return [String] # # @!attribute [rw] name # The name of the value that you want to use as a filter, for example # `"Name": "QUICKSIGHT_OWNER"`. # # Valid values are defined as follows: # # * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group, # and any analyses with that ARN listed as one of the analysis' # owners or viewers are returned. Implicit permissions from folders # or groups are considered. # # * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any # analyses with that ARN listed as one of the owners of the analyses # are returned. Implicit permissions from folders or groups are # considered. # # * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group, # and any analyses with that ARN listed as the only owner of the # analysis are returned. Implicit permissions from folders or groups # are not considered. # # * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and # any analyses with that ARN listed as one of the owners of the # analyses are returned. Implicit permissions from folders or groups # are not considered. # # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or # group, and any analyses with that ARN listed as one of the owners # or viewers of the analyses are returned. Implicit permissions from # folders or groups are not considered. # # * `ANALYSIS_NAME`: Any analyses whose names have a substring match # to this value will be returned. # @return [String] # # @!attribute [rw] value # The value of the named item, in this case `QUICKSIGHT_USER`, that # you want to use as a filter, for example `"Value"`. An example is # `"arn:aws:quicksight:us-east-1:1:user/default/UserName1"`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSearchFilter AWS API Documentation # class AnalysisSearchFilter < Struct.new( :operator, :name, :value) SENSITIVE = [] include Aws::Structure end # The source entity of an analysis. # # @!attribute [rw] source_template # The source template for the source entity of the analysis. # @return [Types::AnalysisSourceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceEntity AWS API Documentation # class AnalysisSourceEntity < Struct.new( :source_template) SENSITIVE = [] include Aws::Structure end # The source template of an analysis. # # @!attribute [rw] data_set_references # The dataset references of the source template of an analysis. # @return [Array] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the source template of an # analysis. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceTemplate AWS API Documentation # class AnalysisSourceTemplate < Struct.new( :data_set_references, :arn) SENSITIVE = [] include Aws::Structure end # The summary metadata that describes an analysis. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the analysis. # @return [String] # # @!attribute [rw] analysis_id # The ID of the analysis. This ID displays in the URL. # @return [String] # # @!attribute [rw] name # The name of the analysis. This name is displayed in the Amazon # QuickSight console. # @return [String] # # @!attribute [rw] status # The last known status for the analysis. # @return [String] # # @!attribute [rw] created_time # The time that the analysis was created. # @return [Time] # # @!attribute [rw] last_updated_time # The time that the analysis was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSummary AWS API Documentation # class AnalysisSummary < Struct.new( :arn, :analysis_id, :name, :status, :created_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end # The date configuration of the filter. # # @!attribute [rw] anchor_option # The options for the date configuration. Choose one of the options # below: # # * `NOW` # # ^ # @return [String] # # @!attribute [rw] parameter_name # The name of the parameter that is used for the anchor date # configuration. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnchorDateConfiguration AWS API Documentation # class AnchorDateConfiguration < Struct.new( :anchor_option, :parameter_name) SENSITIVE = [] include Aws::Structure end # Information about the dashboard that you want to embed. # # @!attribute [rw] initial_dashboard_id # The dashboard ID for the dashboard that you want the user to see # first. This ID is included in the output URL. When the URL in # response is accessed, Amazon QuickSight renders this dashboard. # # The Amazon Resource Name (ARN) of this dashboard must be included in # the `AuthorizedResourceArns` parameter. Otherwise, the request will # fail with `InvalidParameterValueException`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserDashboardEmbeddingConfiguration AWS API Documentation # class AnonymousUserDashboardEmbeddingConfiguration < Struct.new( :initial_dashboard_id) SENSITIVE = [] include Aws::Structure end # The experience that you are embedding. You can use this object to # generate a url that embeds a visual into your application. # # @!attribute [rw] initial_dashboard_visual_id # The visual ID for the visual that you want the user to see. This ID # is included in the output URL. When the URL in response is accessed, # Amazon QuickSight renders this visual. # # The Amazon Resource Name (ARN) of the dashboard that the visual # belongs to must be included in the `AuthorizedResourceArns` # parameter. Otherwise, the request will fail with # `InvalidParameterValueException`. # @return [Types::DashboardVisualId] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserDashboardVisualEmbeddingConfiguration AWS API Documentation # class AnonymousUserDashboardVisualEmbeddingConfiguration < Struct.new( :initial_dashboard_visual_id) SENSITIVE = [] include Aws::Structure end # The type of experience you want to embed. For anonymous users, you can # embed Amazon QuickSight dashboards. # # @!attribute [rw] dashboard # The type of embedding experience. In this case, Amazon QuickSight # dashboards. # @return [Types::AnonymousUserDashboardEmbeddingConfiguration] # # @!attribute [rw] dashboard_visual # The type of embedding experience. In this case, Amazon QuickSight # visuals. # @return [Types::AnonymousUserDashboardVisualEmbeddingConfiguration] # # @!attribute [rw] q_search_bar # The Q search bar that you want to use for anonymous user embedding. # @return [Types::AnonymousUserQSearchBarEmbeddingConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation # class AnonymousUserEmbeddingExperienceConfiguration < Struct.new( :dashboard, :dashboard_visual, :q_search_bar) SENSITIVE = [] include Aws::Structure end # The settings that you want to use with the Q search bar. # # @!attribute [rw] initial_topic_id # The QuickSight Q topic ID of the topic that you want the anonymous # user to see first. This ID is included in the output URL. When the # URL in response is accessed, Amazon QuickSight renders the Q search # bar with this topic pre-selected. # # The Amazon Resource Name (ARN) of this Q topic must be included in # the `AuthorizedResourceArns` parameter. Otherwise, the request will # fail with `InvalidParameterValueException`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserQSearchBarEmbeddingConfiguration AWS API Documentation # class AnonymousUserQSearchBarEmbeddingConfiguration < Struct.new( :initial_topic_id) SENSITIVE = [] include Aws::Structure end # The arc axis configuration of a `GaugeChartVisual`. # # @!attribute [rw] range # The arc axis range of a `GaugeChartVisual`. # @return [Types::ArcAxisDisplayRange] # # @!attribute [rw] reserve_range # The reserved range of the arc axis. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ArcAxisConfiguration AWS API Documentation # class ArcAxisConfiguration < Struct.new( :range, :reserve_range) SENSITIVE = [] include Aws::Structure end # The arc axis range of a `GaugeChartVisual`. # # @!attribute [rw] min # The minimum value of the arc axis range. # @return [Float] # # @!attribute [rw] max # The maximum value of the arc axis range. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ArcAxisDisplayRange AWS API Documentation # class ArcAxisDisplayRange < Struct.new( :min, :max) SENSITIVE = [] include Aws::Structure end # The arc configuration of a `GaugeChartVisual`. # # @!attribute [rw] arc_angle # The option that determines the arc angle of a `GaugeChartVisual`. # @return [Float] # # @!attribute [rw] arc_thickness # The options that determine the arc thickness of a # `GaugeChartVisual`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ArcConfiguration AWS API Documentation # class ArcConfiguration < Struct.new( :arc_angle, :arc_thickness) SENSITIVE = [] include Aws::Structure end # The options that determine the arc thickness of a `GaugeChartVisual`. # # @!attribute [rw] arc_thickness # The arc thickness of a `GaugeChartVisual`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ArcOptions AWS API Documentation # class ArcOptions < Struct.new( :arc_thickness) SENSITIVE = [] include Aws::Structure end # An optional collection of CloudFormation property configurations that # control how the export job is generated. # # @!attribute [rw] resource_id_override_configuration # An optional list of structures that control how resource IDs are # parameterized in the returned CloudFormation template. # @return [Types::AssetBundleExportJobResourceIdOverrideConfiguration] # # @!attribute [rw] vpc_connections # An optional list of structures that control how `VPCConnection` # resources are parameterized in the returned CloudFormation template. # @return [Array] # # @!attribute [rw] refresh_schedules # An optional list of structures that control how `RefreshSchedule` # resources are parameterized in the returned CloudFormation template. # @return [Array] # # @!attribute [rw] data_sources # An optional list of structures that control how `DataSource` # resources are parameterized in the returned CloudFormation template. # @return [Array] # # @!attribute [rw] data_sets # An optional list of structures that control how `DataSet` resources # are parameterized in the returned CloudFormation template. # @return [Array] # # @!attribute [rw] themes # An optional list of structures that control how `Theme` resources # are parameterized in the returned CloudFormation template. # @return [Array] # # @!attribute [rw] analyses # An optional list of structures that control how `Analysis` resources # are parameterized in the returned CloudFormation template. # @return [Array] # # @!attribute [rw] dashboards # An optional list of structures that control how `Dashboard` # resources are parameterized in the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleCloudFormationOverridePropertyConfiguration AWS API Documentation # class AssetBundleCloudFormationOverridePropertyConfiguration < Struct.new( :resource_id_override_configuration, :vpc_connections, :refresh_schedules, :data_sources, :data_sets, :themes, :analyses, :dashboards) SENSITIVE = [] include Aws::Structure end # Controls how a specific `Analysis` resource is parameterized in the # returned CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `Analysis` resource whose override # properties are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `Analysis` resource properties to generate variables for # in the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobAnalysisOverrideProperties AWS API Documentation # class AssetBundleExportJobAnalysisOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # Controls how a specific `Dashboard` resource is parameterized in the # returned CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `Dashboard` resource whose override # properties are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `Dashboard` resource properties to generate variables for # in the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobDashboardOverrideProperties AWS API Documentation # class AssetBundleExportJobDashboardOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # Controls how a specific `DataSet` resource is parameterized in the # returned CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `DataSet` resource whose override properties # are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `DataSet` resource properties to generate variables for in # the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobDataSetOverrideProperties AWS API Documentation # class AssetBundleExportJobDataSetOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # Controls how a specific `DataSource` resource is parameterized in the # returned CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `DataSource` resource whose override # properties are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `DataSource` resource properties to generate variables for # in the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobDataSourceOverrideProperties AWS API Documentation # class AssetBundleExportJobDataSourceOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # Describes an error that occurred during an Asset Bundle export job. # # @!attribute [rw] arn # The ARN of the resource whose processing caused an error. # @return [String] # # @!attribute [rw] type # The specific error type of the error that occurred. # @return [String] # # @!attribute [rw] message # A description of the error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobError AWS API Documentation # class AssetBundleExportJobError < Struct.new( :arn, :type, :message) SENSITIVE = [] include Aws::Structure end # Controls how a specific `RefreshSchedule` resource is parameterized in # the returned CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `RefreshSchedule` resource whose override # properties are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `RefreshSchedule` resource properties to generate # variables for in the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobRefreshScheduleOverrideProperties AWS API Documentation # class AssetBundleExportJobRefreshScheduleOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # An optional structure that configures resource ID overrides for the # export job. # # @!attribute [rw] prefix_for_all_resources # An option to request a CloudFormation variable for a prefix to be # prepended to each resource's ID before import. The prefix is only # added to the asset IDs and does not change the name of the asset. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobResourceIdOverrideConfiguration AWS API Documentation # class AssetBundleExportJobResourceIdOverrideConfiguration < Struct.new( :prefix_for_all_resources) SENSITIVE = [] include Aws::Structure end # A summary of the export job that includes details of the job's # configuration and its current status. # # @!attribute [rw] job_status # The current status of the export job. # @return [String] # # @!attribute [rw] arn # The ARN of the export job. # @return [String] # # @!attribute [rw] created_time # The time that the export job was created. # @return [Time] # # @!attribute [rw] asset_bundle_export_job_id # The ID of the export job. # @return [String] # # @!attribute [rw] include_all_dependencies # The flag that determines the inclusion of resource dependencies in # the returned asset bundle. # @return [Boolean] # # @!attribute [rw] export_format # The format for the export job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobSummary AWS API Documentation # class AssetBundleExportJobSummary < Struct.new( :job_status, :arn, :created_time, :asset_bundle_export_job_id, :include_all_dependencies, :export_format) SENSITIVE = [] include Aws::Structure end # Controls how a specific `Theme` resource is parameterized in the # returned CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `Theme` resource whose override properties # are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `Theme` resource properties to generate variables for in # the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobThemeOverrideProperties AWS API Documentation # class AssetBundleExportJobThemeOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # Controls how a specific `VPCConnection` resource is parameterized in # the outputted CloudFormation template. # # @!attribute [rw] arn # The ARN of the specific `VPCConnection` resource whose override # properties are configured in this structure. # @return [String] # # @!attribute [rw] properties # A list of `VPCConnection` resource properties to generate variables # for in the returned CloudFormation template. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleExportJobVPCConnectionOverrideProperties AWS API Documentation # class AssetBundleExportJobVPCConnectionOverrideProperties < Struct.new( :arn, :properties) SENSITIVE = [] include Aws::Structure end # The override parameters for a single analysis that is being imported. # # @!attribute [rw] analysis_id # The ID of the analysis that you ant to apply overrides to. # @return [String] # # @!attribute [rw] name # A new name for the analysis. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobAnalysisOverrideParameters AWS API Documentation # class AssetBundleImportJobAnalysisOverrideParameters < Struct.new( :analysis_id, :name) SENSITIVE = [] include Aws::Structure end # The override parameters for a single dashboard that is being imported. # # @!attribute [rw] dashboard_id # The ID of the dashboard that you want to apply overrides to. # @return [String] # # @!attribute [rw] name # A new name for the dashboard. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDashboardOverrideParameters AWS API Documentation # class AssetBundleImportJobDashboardOverrideParameters < Struct.new( :dashboard_id, :name) SENSITIVE = [] include Aws::Structure end # The override parameters for a single dataset that is being imported. # # @!attribute [rw] data_set_id # The ID of the dataset to apply overrides to. # @return [String] # # @!attribute [rw] name # A new name for the dataset. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSetOverrideParameters AWS API Documentation # class AssetBundleImportJobDataSetOverrideParameters < Struct.new( :data_set_id, :name) SENSITIVE = [] include Aws::Structure end # A username and password credential pair to use to import a data source # resource. # # @!attribute [rw] username # The username for the data source connection. # @return [String] # # @!attribute [rw] password # The password for the data source connection. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSourceCredentialPair AWS API Documentation # class AssetBundleImportJobDataSourceCredentialPair < Struct.new( :username, :password) SENSITIVE = [] include Aws::Structure end # The login credentials to use to import a data source resource. # # @!attribute [rw] credential_pair # A username and password credential pair to be used to create the # imported data source. Leave this field blank if you are using an # Secrets Manager Secret to provide credentials. # @return [Types::AssetBundleImportJobDataSourceCredentialPair] # # @!attribute [rw] secret_arn # The ARN of the Secrets Manager Secret to be used to create the # imported data source leave this field blank if you aren't using a # Secret in place of a credential pair. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSourceCredentials AWS API Documentation # class AssetBundleImportJobDataSourceCredentials < Struct.new( :credential_pair, :secret_arn) SENSITIVE = [:credential_pair] include Aws::Structure end # The override parameters for a single data source that is being # imported. # # @!attribute [rw] data_source_id # The ID of the data source to apply overrides to. # @return [String] # # @!attribute [rw] name # A new name for the data source. # @return [String] # # @!attribute [rw] data_source_parameters # The parameters that Amazon QuickSight uses to connect to your # underlying data source. This is a variant type structure. For this # structure to be valid, only one of the attributes can be non-null. # @return [Types::DataSourceParameters] # # @!attribute [rw] vpc_connection_properties # VPC connection properties. # @return [Types::VpcConnectionProperties] # # @!attribute [rw] ssl_properties # Secure Socket Layer (SSL) properties that apply when Amazon # QuickSight connects to your underlying data source. # @return [Types::SslProperties] # # @!attribute [rw] credentials # An optional structure that provides the credentials to be used to # create the imported data source. # @return [Types::AssetBundleImportJobDataSourceCredentials] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobDataSourceOverrideParameters AWS API Documentation # class AssetBundleImportJobDataSourceOverrideParameters < Struct.new( :data_source_id, :name, :data_source_parameters, :vpc_connection_properties, :ssl_properties, :credentials) SENSITIVE = [] include Aws::Structure end # Describes an error that occurred within an Asset Bundle import # execution. # # @!attribute [rw] arn # The ARN of the resource whose processing caused an error. # @return [String] # # @!attribute [rw] type # The specific error type or the error that occurred. # @return [String] # # @!attribute [rw] message # A description of the error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobError AWS API Documentation # class AssetBundleImportJobError < Struct.new( :arn, :type, :message) SENSITIVE = [] include Aws::Structure end # A list of overrides that modify the asset bundle resource # configuration before the resource is imported. # # @!attribute [rw] resource_id_override_configuration # An optional structure that configures resource ID overrides to be # applied within the import job. # @return [Types::AssetBundleImportJobResourceIdOverrideConfiguration] # # @!attribute [rw] vpc_connections # A list of overrides for any `VPCConnection` resources that are # present in the asset bundle that is imported. # @return [Array] # # @!attribute [rw] refresh_schedules # A list of overrides for any `RefreshSchedule` resources that are # present in the asset bundle that is imported. # @return [Array] # # @!attribute [rw] data_sources # A list of overrides for any `DataSource` resources that are present # in the asset bundle that is imported. # @return [Array] # # @!attribute [rw] data_sets # A list of overrides for any `DataSet` resources that are present in # the asset bundle that is imported. # @return [Array] # # @!attribute [rw] themes # A list of overrides for any `Theme` resources that are present in # the asset bundle that is imported. # @return [Array] # # @!attribute [rw] analyses # A list of overrides for any `Analysis` resources that are present in # the asset bundle that is imported. # @return [Array] # # @!attribute [rw] dashboards # A list of overrides for any `Dashboard` resources that are present # in the asset bundle that is imported. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobOverrideParameters AWS API Documentation # class AssetBundleImportJobOverrideParameters < Struct.new( :resource_id_override_configuration, :vpc_connections, :refresh_schedules, :data_sources, :data_sets, :themes, :analyses, :dashboards) SENSITIVE = [] include Aws::Structure end # A list of overrides for a specific `RefreshsSchedule` resource that is # present in the asset bundle that is imported. # # @!attribute [rw] data_set_id # A partial identifier for the specific `RefreshSchedule` resource # that is being overridden. This structure is used together with the # `ScheduleID` structure. # @return [String] # # @!attribute [rw] schedule_id # A partial identifier for the specific `RefreshSchedule` resource # being overridden. This structure is used together with the # `DataSetId` structure. # @return [String] # # @!attribute [rw] start_after_date_time # An override for the `StartAfterDateTime` of a `RefreshSchedule` to # ensure that the `StartAfterDateTime` is set to a time that takes # place in the future. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobRefreshScheduleOverrideParameters AWS API Documentation # class AssetBundleImportJobRefreshScheduleOverrideParameters < Struct.new( :data_set_id, :schedule_id, :start_after_date_time) SENSITIVE = [] include Aws::Structure end # An optional structure that configures resource ID overrides for the # import job # # @!attribute [rw] prefix_for_all_resources # An option to request a CloudFormation variable for a prefix to be # prepended to each resource's ID before import. The prefix is only # added to the asset IDs and does not change the name of the asset. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobResourceIdOverrideConfiguration AWS API Documentation # class AssetBundleImportJobResourceIdOverrideConfiguration < Struct.new( :prefix_for_all_resources) SENSITIVE = [] include Aws::Structure end # A summary of the import job that includes details of the requested # job's configuration and its current status. # # @!attribute [rw] job_status # The current status of the import job. # @return [String] # # @!attribute [rw] arn # The ARN of the import job. # @return [String] # # @!attribute [rw] created_time # The time that the import job was created. # @return [Time] # # @!attribute [rw] asset_bundle_import_job_id # The ID of the job. This ID is unique while the job is running. After # the job is completed, you can reuse this ID for another job. # @return [String] # # @!attribute [rw] failure_action # The failure action for the import job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobSummary AWS API Documentation # class AssetBundleImportJobSummary < Struct.new( :job_status, :arn, :created_time, :asset_bundle_import_job_id, :failure_action) SENSITIVE = [] include Aws::Structure end # The override parameters for a single theme that is imported. # # @!attribute [rw] theme_id # The ID of the theme to apply overrides to. # @return [String] # # @!attribute [rw] name # A new name for the theme. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobThemeOverrideParameters AWS API Documentation # class AssetBundleImportJobThemeOverrideParameters < Struct.new( :theme_id, :name) SENSITIVE = [] include Aws::Structure end # The override parameters for a single VPC connection that is imported. # # @!attribute [rw] vpc_connection_id # The ID of the VPC Connection to apply overrides to. # @return [String] # # @!attribute [rw] name # A new name for the VPC connection. # @return [String] # # @!attribute [rw] subnet_ids # A list of new subnet IDs for the VPC connection you are importing. # This field is required if you are importing the VPC connection from # another Amazon Web Services account or region. # @return [Array] # # @!attribute [rw] security_group_ids # A new security group ID for the VPC connection you are importing. # This field is required if you are importing the VPC connection from # another Amazon Web Services account or region. # @return [Array] # # @!attribute [rw] dns_resolvers # An optional override of dns resolvers to be used by the VPC # connection. # @return [Array] # # @!attribute [rw] role_arn # An optional override of the role ARN to be used by the VPC # connection. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportJobVPCConnectionOverrideParameters AWS API Documentation # class AssetBundleImportJobVPCConnectionOverrideParameters < Struct.new( :vpc_connection_id, :name, :subnet_ids, :security_group_ids, :dns_resolvers, :role_arn) SENSITIVE = [] include Aws::Structure end # The source of the asset bundle zip file that contains the data that # you want to import. # # @!attribute [rw] body # The bytes of the Base64 encoded asset bundle import zip file. This # file can't exceed 20MB. # # If you are calling the APIs from the Amazon Web Services Java, # JavaScript, Python, or PHP SDKs, the SDK encodes Base64 # automatically to allow the direct setting of the zip file's bytes. # If you are using a SDK of a different language or are receiving # related errors, try to Base64 encode your data. # @return [String] # # @!attribute [rw] s3_uri # The Amazon S3 uri for an asset bundle import file that exists in an # Amazon S3 bucket that the caller has read access to. The file must # be a zip format file and can't exceed 20MB. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportSource AWS API Documentation # class AssetBundleImportSource < Struct.new( :body, :s3_uri) SENSITIVE = [:body] include Aws::Structure end # A description of the import source that you provide at the start of an # import job. This value is set to either `Body` or `S3Uri` depending on # how the `StartAssetBundleImportJobRequest` is configured. # # @!attribute [rw] body # A HTTPS download URL for the provided asset bundle that you # optionally provided at the start of the import job. This URL is # valid for 5 minutes after issuance. Call # `DescribeAssetBundleExportJob` again for a fresh URL if needed. The # downloaded asset bundle is a `.qs` zip file. # @return [String] # # @!attribute [rw] s3_uri # The Amazon S3 uri that you provided at the start of the import job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AssetBundleImportSourceDescription AWS API Documentation # class AssetBundleImportSourceDescription < Struct.new( :body, :s3_uri) SENSITIVE = [] include Aws::Structure end # Parameters for Amazon Athena. # # @!attribute [rw] work_group # The workgroup that Amazon Athena uses. # @return [String] # # @!attribute [rw] role_arn # Use the `RoleArn` structure to override an account-wide role for a # specific Athena data source. For example, say an account # administrator has turned off all Athena access with an account-wide # role. The administrator can then use `RoleArn` to bypass the # account-wide role and allow Athena access for the single Athena data # source that is specified in the structure, even if the account-wide # role forbidding Athena access is still active. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AthenaParameters AWS API Documentation # class AthenaParameters < Struct.new( :work_group, :role_arn) SENSITIVE = [] include Aws::Structure end # Parameters for Amazon Aurora. # # @!attribute [rw] host # Host. # @return [String] # # @!attribute [rw] port # Port. # @return [Integer] # # @!attribute [rw] database # Database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AuroraParameters AWS API Documentation # class AuroraParameters < Struct.new( :host, :port, :database) SENSITIVE = [] include Aws::Structure end # Parameters for Amazon Aurora PostgreSQL-Compatible Edition. # # @!attribute [rw] host # The Amazon Aurora PostgreSQL-Compatible host to connect to. # @return [String] # # @!attribute [rw] port # The port that Amazon Aurora PostgreSQL is listening on. # @return [Integer] # # @!attribute [rw] database # The Amazon Aurora PostgreSQL database to connect to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AuroraPostgreSqlParameters AWS API Documentation # class AuroraPostgreSqlParameters < Struct.new( :host, :port, :database) SENSITIVE = [] include Aws::Structure end # The parameters for IoT Analytics. # # @!attribute [rw] data_set_name # Dataset name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AwsIotAnalyticsParameters AWS API Documentation # class AwsIotAnalyticsParameters < Struct.new( :data_set_name) SENSITIVE = [] include Aws::Structure end # The data options for an axis. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] numeric_axis_options # The options for an axis with a numeric field. # @return [Types::NumericAxisOptions] # # @!attribute [rw] date_axis_options # The options for an axis with a date field. # @return [Types::DateAxisOptions] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisDataOptions AWS API Documentation # class AxisDataOptions < Struct.new( :numeric_axis_options, :date_axis_options) SENSITIVE = [] include Aws::Structure end # The options that are saved for future extension. # # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisDisplayDataDrivenRange AWS API Documentation # class AxisDisplayDataDrivenRange < Aws::EmptyStructure; end # The minimum and maximum setup for an axis display range. # # @!attribute [rw] minimum # The minimum setup for an axis display range. # @return [Float] # # @!attribute [rw] maximum # The maximum setup for an axis display range. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisDisplayMinMaxRange AWS API Documentation # class AxisDisplayMinMaxRange < Struct.new( :minimum, :maximum) SENSITIVE = [] include Aws::Structure end # The display options for the axis label. # # @!attribute [rw] tick_label_options # The tick label options of an axis. # @return [Types::AxisTickLabelOptions] # # @!attribute [rw] axis_line_visibility # Determines whether or not the axis line is visible. # @return [String] # # @!attribute [rw] grid_line_visibility # Determines whether or not the grid line is visible. # @return [String] # # @!attribute [rw] data_options # The data options for an axis. # @return [Types::AxisDataOptions] # # @!attribute [rw] scrollbar_options # The scroll bar options for an axis. # @return [Types::ScrollBarOptions] # # @!attribute [rw] axis_offset # The offset value that determines the starting placement of the axis # within a visual's bounds. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisDisplayOptions AWS API Documentation # class AxisDisplayOptions < Struct.new( :tick_label_options, :axis_line_visibility, :grid_line_visibility, :data_options, :scrollbar_options, :axis_offset) SENSITIVE = [] include Aws::Structure end # The range setup of a numeric axis display range. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] min_max # The minimum and maximum setup of an axis display range. # @return [Types::AxisDisplayMinMaxRange] # # @!attribute [rw] data_driven # The data-driven setup of an axis display range. # @return [Types::AxisDisplayDataDrivenRange] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisDisplayRange AWS API Documentation # class AxisDisplayRange < Struct.new( :min_max, :data_driven) SENSITIVE = [] include Aws::Structure end # The label options for a chart axis. You must specify the field that # the label is targeted to. # # @!attribute [rw] font_configuration # The font configuration of the axis label. # @return [Types::FontConfiguration] # # @!attribute [rw] custom_label # The text for the axis label. # @return [String] # # @!attribute [rw] apply_to # The options that indicate which field the label belongs to. # @return [Types::AxisLabelReferenceOptions] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisLabelOptions AWS API Documentation # class AxisLabelOptions < Struct.new( :font_configuration, :custom_label, :apply_to) SENSITIVE = [] include Aws::Structure end # The reference that specifies where the axis label is applied to. # # @!attribute [rw] field_id # The field that the axis label is targeted to. # @return [String] # # @!attribute [rw] column # The column that the axis label is targeted to. # @return [Types::ColumnIdentifier] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisLabelReferenceOptions AWS API Documentation # class AxisLabelReferenceOptions < Struct.new( :field_id, :column) SENSITIVE = [] include Aws::Structure end # The liner axis scale setup. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] step_count # The step count setup of a linear axis. # @return [Integer] # # @!attribute [rw] step_size # The step size setup of a linear axis. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisLinearScale AWS API Documentation # class AxisLinearScale < Struct.new( :step_count, :step_size) SENSITIVE = [] include Aws::Structure end # The logarithmic axis scale setup. # # @!attribute [rw] base # The base setup of a logarithmic axis scale. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisLogarithmicScale AWS API Documentation # class AxisLogarithmicScale < Struct.new( :base) SENSITIVE = [] include Aws::Structure end # The scale setup options for a numeric axis display. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] linear # The linear axis scale setup. # @return [Types::AxisLinearScale] # # @!attribute [rw] logarithmic # The logarithmic axis scale setup. # @return [Types::AxisLogarithmicScale] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisScale AWS API Documentation # class AxisScale < Struct.new( :linear, :logarithmic) SENSITIVE = [] include Aws::Structure end # The tick label options of an axis. # # @!attribute [rw] label_options # Determines whether or not the axis ticks are visible. # @return [Types::LabelOptions] # # @!attribute [rw] rotation_angle # The rotation angle of the axis tick labels. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AxisTickLabelOptions AWS API Documentation # class AxisTickLabelOptions < Struct.new( :label_options, :rotation_angle) SENSITIVE = [] include Aws::Structure end # The aggregated field wells of a bar chart. # # @!attribute [rw] category # The category (y-axis) field well of a bar chart. # @return [Array] # # @!attribute [rw] values # The value field wells of a bar chart. Values are aggregated by # category. # @return [Array] # # @!attribute [rw] colors # The color (group/color) field well of a bar chart. # @return [Array] # # @!attribute [rw] small_multiples # The small multiples field well of a bar chart. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartAggregatedFieldWells AWS API Documentation # class BarChartAggregatedFieldWells < Struct.new( :category, :values, :colors, :small_multiples) SENSITIVE = [] include Aws::Structure end # The configuration of a `BarChartVisual`. # # @!attribute [rw] field_wells # The field wells of the visual. # @return [Types::BarChartFieldWells] # # @!attribute [rw] sort_configuration # The sort configuration of a `BarChartVisual`. # @return [Types::BarChartSortConfiguration] # # @!attribute [rw] orientation # The orientation of the bars in a bar chart visual. There are two # valid values in this structure: # # * `HORIZONTAL`: Used for charts that have horizontal bars. Visuals # that use this value are horizontal bar charts, horizontal stacked # bar charts, and horizontal stacked 100% bar charts. # # * `VERTICAL`: Used for charts that have vertical bars. Visuals that # use this value are vertical bar charts, vertical stacked bar # charts, and vertical stacked 100% bar charts. # @return [String] # # @!attribute [rw] bars_arrangement # Determines the arrangement of the bars. The orientation and # arrangement of bars determine the type of bar that is used in the # visual. # @return [String] # # @!attribute [rw] visual_palette # The palette (chart color) display setup of the visual. # @return [Types::VisualPalette] # # @!attribute [rw] small_multiples_options # The small multiples setup for the visual. # @return [Types::SmallMultiplesOptions] # # @!attribute [rw] category_axis # The label display options (grid line, range, scale, axis step) for # bar chart category. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] category_label_options # The label options (label text, label visibility and sort icon # visibility) for a bar chart. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] value_axis # The label display options (grid line, range, scale, axis step) for a # bar chart value. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] value_label_options # The label options (label text, label visibility and sort icon # visibility) for a bar chart value. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] color_label_options # The label options (label text, label visibility and sort icon # visibility) for a color that is used in a bar chart. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] legend # The legend display setup of the visual. # @return [Types::LegendOptions] # # @!attribute [rw] data_labels # The options that determine if visual data labels are displayed. # @return [Types::DataLabelOptions] # # @!attribute [rw] tooltip # The tooltip display setup of the visual. # @return [Types::TooltipOptions] # # @!attribute [rw] reference_lines # The reference line setup of the visual. # @return [Array] # # @!attribute [rw] contribution_analysis_defaults # The contribution analysis (anomaly configuration) setup of the # visual. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartConfiguration AWS API Documentation # class BarChartConfiguration < Struct.new( :field_wells, :sort_configuration, :orientation, :bars_arrangement, :visual_palette, :small_multiples_options, :category_axis, :category_label_options, :value_axis, :value_label_options, :color_label_options, :legend, :data_labels, :tooltip, :reference_lines, :contribution_analysis_defaults) SENSITIVE = [] include Aws::Structure end # The field wells of a `BarChartVisual`. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] bar_chart_aggregated_field_wells # The aggregated field wells of a bar chart. # @return [Types::BarChartAggregatedFieldWells] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartFieldWells AWS API Documentation # class BarChartFieldWells < Struct.new( :bar_chart_aggregated_field_wells) SENSITIVE = [] include Aws::Structure end # sort-configuration-description # # @!attribute [rw] category_sort # The sort configuration of category fields. # @return [Array] # # @!attribute [rw] category_items_limit # The limit on the number of categories displayed in a bar chart. # @return [Types::ItemsLimitConfiguration] # # @!attribute [rw] color_sort # The sort configuration of color fields in a bar chart. # @return [Array] # # @!attribute [rw] color_items_limit # The limit on the number of values displayed in a bar chart. # @return [Types::ItemsLimitConfiguration] # # @!attribute [rw] small_multiples_sort # The sort configuration of the small multiples field. # @return [Array] # # @!attribute [rw] small_multiples_limit_configuration # The limit on the number of small multiples panels that are # displayed. # @return [Types::ItemsLimitConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartSortConfiguration AWS API Documentation # class BarChartSortConfiguration < Struct.new( :category_sort, :category_items_limit, :color_sort, :color_items_limit, :small_multiples_sort, :small_multiples_limit_configuration) SENSITIVE = [] include Aws::Structure end # A bar chart. # # The `BarChartVisual` structure describes a visual that is a member of # the bar chart family. The following charts can be described using this # structure: # # * Horizontal bar chart # # * Vertical bar chart # # * Horizontal stacked bar chart # # * Vertical stacked bar chart # # * Horizontal stacked 100% bar chart # # * Vertical stacked 100% bar chart # # For more information, see [Using bar charts][1] in the *Amazon # QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html # # @!attribute [rw] visual_id # The unique identifier of a visual. This identifier must be unique # within the context of a dashboard, template, or analysis. Two # dashboards, analyses, or templates can have visuals with the same # identifiers. # @return [String] # # @!attribute [rw] title # The title that is displayed on the visual. # @return [Types::VisualTitleLabelOptions] # # @!attribute [rw] subtitle # The subtitle that is displayed on the visual. # @return [Types::VisualSubtitleLabelOptions] # # @!attribute [rw] chart_configuration # The configuration settings of the visual. # @return [Types::BarChartConfiguration] # # @!attribute [rw] actions # The list of custom actions that are configured for a visual. # @return [Array] # # @!attribute [rw] column_hierarchies # The column hierarchy that is used during drill-downs and drill-ups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartVisual AWS API Documentation # class BarChartVisual < Struct.new( :visual_id, :title, :subtitle, :chart_configuration, :actions, :column_hierarchies) SENSITIVE = [] include Aws::Structure end # The options that determine the bin count of a histogram. # # @!attribute [rw] value # The options that determine the bin count value. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BinCountOptions AWS API Documentation # class BinCountOptions < Struct.new( :value) SENSITIVE = [] include Aws::Structure end # The options that determine the bin width of a histogram. # # @!attribute [rw] value # The options that determine the bin width value. # @return [Float] # # @!attribute [rw] bin_count_limit # The options that determine the bin count limit. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BinWidthOptions AWS API Documentation # class BinWidthOptions < Struct.new( :value, :bin_count_limit) SENSITIVE = [] include Aws::Structure end # The configuration of a body section. # # @!attribute [rw] section_id # The unique identifier of a body section. # @return [String] # # @!attribute [rw] content # The configuration of content in a body section. # @return [Types::BodySectionContent] # # @!attribute [rw] style # The style options of a body section. # @return [Types::SectionStyle] # # @!attribute [rw] page_break_configuration # The configuration of a page break for a section. # @return [Types::SectionPageBreakConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BodySectionConfiguration AWS API Documentation # class BodySectionConfiguration < Struct.new( :section_id, :content, :style, :page_break_configuration) SENSITIVE = [] include Aws::Structure end # The configuration of content in a body section. # # @!attribute [rw] layout # The layout configuration of a body section. # @return [Types::SectionLayoutConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BodySectionContent AWS API Documentation # class BodySectionContent < Struct.new( :layout) SENSITIVE = [] include Aws::Structure end # The bookmarks configuration of an embedded dashboard. # # @!attribute [rw] enabled # A Boolean value that determines whether a user can bookmark an # embedded dashboard. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BookmarksConfigurations AWS API Documentation # class BookmarksConfigurations < Struct.new( :enabled) SENSITIVE = [] include Aws::Structure end # The display options for tile borders for visuals. # # @!attribute [rw] show # The option to enable display of borders for visuals. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BorderStyle AWS API Documentation # class BorderStyle < Struct.new( :show) SENSITIVE = [] include Aws::Structure end # The aggregated field well for a box plot. # # @!attribute [rw] group_by # The group by field well of a box plot chart. Values are grouped # based on group by fields. # @return [Array] # # @!attribute [rw] values # The value field well of a box plot chart. Values are aggregated # based on group by fields. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotAggregatedFieldWells AWS API Documentation # class BoxPlotAggregatedFieldWells < Struct.new( :group_by, :values) SENSITIVE = [] include Aws::Structure end # The configuration of a `BoxPlotVisual`. # # @!attribute [rw] field_wells # The field wells of the visual. # @return [Types::BoxPlotFieldWells] # # @!attribute [rw] sort_configuration # The sort configuration of a `BoxPlotVisual`. # @return [Types::BoxPlotSortConfiguration] # # @!attribute [rw] box_plot_options # The box plot chart options for a box plot visual # @return [Types::BoxPlotOptions] # # @!attribute [rw] category_axis # The label display options (grid line, range, scale, axis step) of a # box plot category. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] category_label_options # The label options (label text, label visibility and sort Icon # visibility) of a box plot category. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] primary_y_axis_display_options # The label display options (grid line, range, scale, axis step) of a # box plot category. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] primary_y_axis_label_options # The label options (label text, label visibility and sort icon # visibility) of a box plot value. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] legend # The options for the legend setup of a visual. # @return [Types::LegendOptions] # # @!attribute [rw] tooltip # The tooltip display setup of the visual. # @return [Types::TooltipOptions] # # @!attribute [rw] reference_lines # The reference line setup of the visual. # @return [Array] # # @!attribute [rw] visual_palette # The palette (chart color) display setup of the visual. # @return [Types::VisualPalette] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotChartConfiguration AWS API Documentation # class BoxPlotChartConfiguration < Struct.new( :field_wells, :sort_configuration, :box_plot_options, :category_axis, :category_label_options, :primary_y_axis_display_options, :primary_y_axis_label_options, :legend, :tooltip, :reference_lines, :visual_palette) SENSITIVE = [] include Aws::Structure end # The field wells of a `BoxPlotVisual`. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] box_plot_aggregated_field_wells # The aggregated field wells of a box plot. # @return [Types::BoxPlotAggregatedFieldWells] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotFieldWells AWS API Documentation # class BoxPlotFieldWells < Struct.new( :box_plot_aggregated_field_wells) SENSITIVE = [] include Aws::Structure end # The options of a box plot visual. # # @!attribute [rw] style_options # The style options of the box plot. # @return [Types::BoxPlotStyleOptions] # # @!attribute [rw] outlier_visibility # Determines the visibility of the outlier in a box plot. # @return [String] # # @!attribute [rw] all_data_points_visibility # Determines the visibility of all data points of the box plot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotOptions AWS API Documentation # class BoxPlotOptions < Struct.new( :style_options, :outlier_visibility, :all_data_points_visibility) SENSITIVE = [] include Aws::Structure end # The sort configuration of a `BoxPlotVisual`. # # @!attribute [rw] category_sort # The sort configuration of a group by fields. # @return [Array] # # @!attribute [rw] pagination_configuration # The pagination configuration of a table visual or box plot. # @return [Types::PaginationConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotSortConfiguration AWS API Documentation # class BoxPlotSortConfiguration < Struct.new( :category_sort, :pagination_configuration) SENSITIVE = [] include Aws::Structure end # The style options of the box plot. # # @!attribute [rw] fill_style # The fill styles (solid, transparent) of the box plot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotStyleOptions AWS API Documentation # class BoxPlotStyleOptions < Struct.new( :fill_style) SENSITIVE = [] include Aws::Structure end # A box plot. # # For more information, see [Using box plots][1] in the *Amazon # QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html # # @!attribute [rw] visual_id # The unique identifier of a visual. This identifier must be unique # within the context of a dashboard, template, or analysis. Two # dashboards, analyses, or templates can have visuals with the same # identifiers.. # @return [String] # # @!attribute [rw] title # The title that is displayed on the visual. # @return [Types::VisualTitleLabelOptions] # # @!attribute [rw] subtitle # The subtitle that is displayed on the visual. # @return [Types::VisualSubtitleLabelOptions] # # @!attribute [rw] chart_configuration # The configuration settings of the visual. # @return [Types::BoxPlotChartConfiguration] # # @!attribute [rw] actions # The list of custom actions that are configured for a visual. # @return [Array] # # @!attribute [rw] column_hierarchies # The column hierarchy that is used during drill-downs and drill-ups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BoxPlotVisual AWS API Documentation # class BoxPlotVisual < Struct.new( :visual_id, :title, :subtitle, :chart_configuration, :actions, :column_hierarchies) SENSITIVE = [] include Aws::Structure end # A calculated column for a dataset. # # @!attribute [rw] column_name # Column name. # @return [String] # # @!attribute [rw] column_id # A unique ID to identify a calculated column. During a dataset # update, if the column ID of a calculated column matches that of an # existing calculated column, Amazon QuickSight preserves the existing # calculated column. # @return [String] # # @!attribute [rw] expression # An expression that defines the calculated column. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CalculatedColumn AWS API Documentation # class CalculatedColumn < Struct.new( :column_name, :column_id, :expression) SENSITIVE = [:expression] include Aws::Structure end # The calculated field of an analysis. # # @!attribute [rw] data_set_identifier # The data set that is used in this calculated field. # @return [String] # # @!attribute [rw] name # The name of the calculated field. # @return [String] # # @!attribute [rw] expression # The expression of the calculated field. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CalculatedField AWS API Documentation # class CalculatedField < Struct.new( :data_set_identifier, :name, :expression) SENSITIVE = [:expression] include Aws::Structure end # The table calculation measure field for pivot tables. # # @!attribute [rw] field_id # The custom field ID. # @return [String] # # @!attribute [rw] expression # The expression in the table calculation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CalculatedMeasureField AWS API Documentation # class CalculatedMeasureField < Struct.new( :field_id, :expression) SENSITIVE = [:expression] include Aws::Structure end # @!attribute [rw] aws_account_id # The Amazon Web Services account ID. # @return [String] # # @!attribute [rw] data_set_id # The ID of the dataset used in the ingestion. # @return [String] # # @!attribute [rw] ingestion_id # An ID for the ingestion. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CancelIngestionRequest AWS API Documentation # class CancelIngestionRequest < Struct.new( :aws_account_id, :data_set_id, :ingestion_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the data ingestion. # @return [String] # # @!attribute [rw] ingestion_id # An ID for the ingestion. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CancelIngestionResponse AWS API Documentation # class CancelIngestionResponse < Struct.new( :arn, :ingestion_id, :request_id, :status) SENSITIVE = [] include Aws::Structure end # The values that are displayed in a control can be configured to only # show values that are valid based on what's selected in other # controls. # # @!attribute [rw] source_controls # A list of source controls that determine the values that are used in # the current control. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CascadingControlConfiguration AWS API Documentation # class CascadingControlConfiguration < Struct.new( :source_controls) SENSITIVE = [] include Aws::Structure end # The source controls that are used in a # `CascadingControlConfiguration`. # # @!attribute [rw] source_sheet_control_id # The source sheet control ID of a `CascadingControlSource`. # @return [String] # # @!attribute [rw] column_to_match # The column identifier that determines which column to look up for # the source sheet control. # @return [Types::ColumnIdentifier] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CascadingControlSource AWS API Documentation # class CascadingControlSource < Struct.new( :source_sheet_control_id, :column_to_match) SENSITIVE = [] include Aws::Structure end # A transform operation that casts a column to a different type. # # @!attribute [rw] column_name # Column name. # @return [String] # # @!attribute [rw] new_column_type # New column data type. # @return [String] # # @!attribute [rw] format # When casting a column from string to datetime type, you can supply a # string in a format supported by Amazon QuickSight to denote the # source data format. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CastColumnTypeOperation AWS API Documentation # class CastColumnTypeOperation < Struct.new( :column_name, :new_column_type, :format) SENSITIVE = [] include Aws::Structure end # The dimension type field with categorical type columns.. # # @!attribute [rw] field_id # The custom field ID. # @return [String] # # @!attribute [rw] column # The column that is used in the `CategoricalDimensionField`. # @return [Types::ColumnIdentifier] # # @!attribute [rw] hierarchy_id # The custom hierarchy ID. # @return [String] # # @!attribute [rw] format_configuration # The format configuration of the field. # @return [Types::StringFormatConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CategoricalDimensionField AWS API Documentation # class CategoricalDimensionField < Struct.new( :field_id, :column, :hierarchy_id, :format_configuration) SENSITIVE = [] include Aws::Structure end # The measure type field with categorical type columns. # # @!attribute [rw] field_id # The custom field ID. # @return [String] # # @!attribute [rw] column # The column that is used in the `CategoricalMeasureField`. # @return [Types::ColumnIdentifier] # # @!attribute [rw] aggregation_function # The aggregation function of the measure field. # @return [String] # # @!attribute [rw] format_configuration # The format configuration of the field. # @return [Types::StringFormatConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CategoricalMeasureField AWS API Documentation # class CategoricalMeasureField < Struct.new( :field_id, :column, :aggregation_function, :format_configuration) SENSITIVE = [] include Aws::Structure end # The numeric equality type drill down filter. # # @!attribute [rw] column # The column that the filter is applied to. # @return [Types::ColumnIdentifier] # # @!attribute [rw] category_values # A list of the string inputs that are the values of the category # drill down filter. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CategoryDrillDownFilter AWS API Documentation # class CategoryDrillDownFilter < Struct.new( :column, :category_values) SENSITIVE = [] include Aws::Structure end # A `CategoryFilter` filters text values. # # For more information, see [Adding text filters][1] in the *Amazon # QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html # # @!attribute [rw] filter_id # An identifier that uniquely identifies a filter within a dashboard, # analysis, or template. # @return [String] # # @!attribute [rw] column # The column that the filter is applied to. # @return [Types::ColumnIdentifier] # # @!attribute [rw] configuration # The configuration for a `CategoryFilter`. # @return [Types::CategoryFilterConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CategoryFilter AWS API Documentation # class CategoryFilter < Struct.new( :filter_id, :column, :configuration) SENSITIVE = [] include Aws::Structure end # The configuration for a `CategoryFilter`. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] filter_list_configuration # A list of filter configurations. In the Amazon QuickSight console, # this filter type is called a filter list. # @return [Types::FilterListConfiguration] # # @!attribute [rw] custom_filter_list_configuration # A list of custom filter values. In the Amazon QuickSight console, # this filter type is called a custom filter list. # @return [Types::CustomFilterListConfiguration] # # @!attribute [rw] custom_filter_configuration # A custom filter that filters based on a single value. This filter # can be partially matched. # @return [Types::CustomFilterConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CategoryFilterConfiguration AWS API Documentation # class CategoryFilterConfiguration < Struct.new( :filter_list_configuration, :custom_filter_list_configuration, :custom_filter_configuration) SENSITIVE = [] include Aws::Structure end # A structure that represents the cell value synonym. # # @!attribute [rw] cell_value # The cell value. # @return [String] # # @!attribute [rw] synonyms # Other names or aliases for the cell value. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CellValueSynonym AWS API Documentation # class CellValueSynonym < Struct.new( :cell_value, :synonyms) SENSITIVE = [] include Aws::Structure end # The label options for an axis on a chart. # # @!attribute [rw] visibility # The visibility of an axis label on a chart. Choose one of the # following options: # # * `VISIBLE`: Shows the axis. # # * `HIDDEN`: Hides the axis. # @return [String] # # @!attribute [rw] sort_icon_visibility # The visibility configuration of the sort icon on a chart's axis # label. # @return [String] # # @!attribute [rw] axis_label_options # The label options for a chart axis. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ChartAxisLabelOptions AWS API Documentation # class ChartAxisLabelOptions < Struct.new( :visibility, :sort_icon_visibility, :axis_label_options) SENSITIVE = [] include Aws::Structure end # The cluster marker that is a part of the cluster marker configuration. # # @!attribute [rw] simple_cluster_marker # The simple cluster marker of the cluster marker. # @return [Types::SimpleClusterMarker] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ClusterMarker AWS API Documentation # class ClusterMarker < Struct.new( :simple_cluster_marker) SENSITIVE = [] include Aws::Structure end # The cluster marker configuration of the geospatial map selected point # style. # # @!attribute [rw] cluster_marker # The cluster marker that is a part of the cluster marker # configuration. # @return [Types::ClusterMarker] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ClusterMarkerConfiguration AWS API Documentation # class ClusterMarkerConfiguration < Struct.new( :cluster_marker) SENSITIVE = [] include Aws::Structure end # A structure that represents a collective constant. # # @!attribute [rw] value_list # A list of values for the collective constant. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CollectiveConstant AWS API Documentation # class CollectiveConstant < Struct.new( :value_list) SENSITIVE = [] include Aws::Structure end # Determines the color scale that is applied to the visual. # # @!attribute [rw] colors # Determines the list of colors that are applied to the visual. # @return [Array] # # @!attribute [rw] color_fill_type # Determines the color fill type. # @return [String] # # @!attribute [rw] null_value_color # Determines the color that is applied to null values. # @return [Types::DataColor] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColorScale AWS API Documentation # class ColorScale < Struct.new( :colors, :color_fill_type, :null_value_color) SENSITIVE = [] include Aws::Structure end # The general configuration of a column. # # @!attribute [rw] column # The column. # @return [Types::ColumnIdentifier] # # @!attribute [rw] format_configuration # The format configuration of a column. # @return [Types::FormatConfiguration] # # @!attribute [rw] role # The role of the column. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnConfiguration AWS API Documentation # class ColumnConfiguration < Struct.new( :column, :format_configuration, :role) SENSITIVE = [] include Aws::Structure end # Metadata that contains a description for a column. # # @!attribute [rw] text # The text of a description for a column. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnDescription AWS API Documentation # class ColumnDescription < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # Groupings of columns that work together in certain Amazon QuickSight # features. This is a variant type structure. For this structure to be # valid, only one of the attributes can be non-null. # # @!attribute [rw] geo_spatial_column_group # Geospatial column group that denotes a hierarchy. # @return [Types::GeoSpatialColumnGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroup AWS API Documentation # class ColumnGroup < Struct.new( :geo_spatial_column_group) SENSITIVE = [] include Aws::Structure end # A structure describing the name, data type, and geographic role of the # columns. # # @!attribute [rw] name # The name of the column group's column schema. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroupColumnSchema AWS API Documentation # class ColumnGroupColumnSchema < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # The column group schema. # # @!attribute [rw] name # The name of the column group schema. # @return [String] # # @!attribute [rw] column_group_column_schema_list # A structure containing the list of schemas for column group columns. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroupSchema AWS API Documentation # class ColumnGroupSchema < Struct.new( :name, :column_group_column_schema_list) SENSITIVE = [] include Aws::Structure end # The option that determines the hierarchy of the fields for a visual # element. # # @!attribute [rw] explicit_hierarchy # The option that determines the hierarchy of the fields that are # built within a visual's field wells. These fields can't be # duplicated to other visuals. # @return [Types::ExplicitHierarchy] # # @!attribute [rw] date_time_hierarchy # The option that determines the hierarchy of any `DateTime` fields. # @return [Types::DateTimeHierarchy] # # @!attribute [rw] predefined_hierarchy # The option that determines the hierarchy of the fields that are # defined during data preparation. These fields are available to use # in any analysis that uses the data source. # @return [Types::PredefinedHierarchy] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnHierarchy AWS API Documentation # class ColumnHierarchy < Struct.new( :explicit_hierarchy, :date_time_hierarchy, :predefined_hierarchy) SENSITIVE = [] include Aws::Structure end # A column of a data set. # # @!attribute [rw] data_set_identifier # The data set that the column belongs to. # @return [String] # # @!attribute [rw] column_name # The name of the column. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnIdentifier AWS API Documentation # class ColumnIdentifier < Struct.new( :data_set_identifier, :column_name) SENSITIVE = [] include Aws::Structure end # A rule defined to grant access on one or more restricted columns. Each # dataset can have multiple rules. To create a restricted column, you # add it to one or more rules. Each rule must contain at least one # column and at least one user or group. To be able to see a restricted # column, a user or group needs to be added to a rule for that column. # # @!attribute [rw] principals # An array of Amazon Resource Names (ARNs) for Amazon QuickSight users # or groups. # @return [Array] # # @!attribute [rw] column_names # An array of column names. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnLevelPermissionRule AWS API Documentation # class ColumnLevelPermissionRule < Struct.new( :principals, :column_names) SENSITIVE = [] include Aws::Structure end # The column schema. # # @!attribute [rw] name # The name of the column schema. # @return [String] # # @!attribute [rw] data_type # The data type of the column schema. # @return [String] # # @!attribute [rw] geographic_role # The geographic role of the column schema. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnSchema AWS API Documentation # class ColumnSchema < Struct.new( :name, :data_type, :geographic_role) SENSITIVE = [] include Aws::Structure end # The sort configuration for a column that is not used in a field well. # # @!attribute [rw] sort_by # A column of a data set. # @return [Types::ColumnIdentifier] # # @!attribute [rw] direction # The sort direction. # @return [String] # # @!attribute [rw] aggregation_function # The aggregation function that is defined in the column sort. # @return [Types::AggregationFunction] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnSort AWS API Documentation # class ColumnSort < Struct.new( :sort_by, :direction, :aggregation_function) SENSITIVE = [] include Aws::Structure end # A tag for a column in a ` TagColumnOperation ` structure. This is a # variant type structure. For this structure to be valid, only one of # the attributes can be non-null. # # @!attribute [rw] column_geographic_role # A geospatial role for a column. # @return [String] # # @!attribute [rw] column_description # A description for a column. # @return [Types::ColumnDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnTag AWS API Documentation # class ColumnTag < Struct.new( :column_geographic_role, :column_description) SENSITIVE = [] include Aws::Structure end # The tooltip item for the columns that are not part of a field well. # # @!attribute [rw] column # The target column of the tooltip item. # @return [Types::ColumnIdentifier] # # @!attribute [rw] label # The label of the tooltip item. # @return [String] # # @!attribute [rw] visibility # The visibility of the tooltip item. # @return [String] # # @!attribute [rw] aggregation # The aggregation function of the column tooltip item. # @return [Types::AggregationFunction] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnTooltipItem AWS API Documentation # class ColumnTooltipItem < Struct.new( :column, :label, :visibility, :aggregation) SENSITIVE = [] include Aws::Structure end # The aggregated field wells of a combo chart. # # @!attribute [rw] category # The aggregated category field wells of a combo chart. # @return [Array] # # @!attribute [rw] bar_values # The aggregated `BarValues` field well of a combo chart. # @return [Array] # # @!attribute [rw] colors # The aggregated colors field well of a combo chart. # @return [Array] # # @!attribute [rw] line_values # The aggregated `LineValues` field well of a combo chart. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartAggregatedFieldWells AWS API Documentation # class ComboChartAggregatedFieldWells < Struct.new( :category, :bar_values, :colors, :line_values) SENSITIVE = [] include Aws::Structure end # The configuration of a `ComboChartVisual`. # # @!attribute [rw] field_wells # The field wells of the visual. # @return [Types::ComboChartFieldWells] # # @!attribute [rw] sort_configuration # The sort configuration of a `ComboChartVisual`. # @return [Types::ComboChartSortConfiguration] # # @!attribute [rw] bars_arrangement # Determines the bar arrangement in a combo chart. The following are # valid values in this structure: # # * `CLUSTERED`: For clustered bar combo charts. # # * `STACKED`: For stacked bar combo charts. # # * `STACKED_PERCENT`: Do not use. If you use this value, the # operation returns a validation error. # @return [String] # # @!attribute [rw] category_axis # The category axis of a combo chart. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] category_label_options # The label options (label text, label visibility, and sort icon # visibility) of a combo chart category (group/color) field well. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] primary_y_axis_display_options # The label display options (grid line, range, scale, and axis step) # of a combo chart's primary y-axis (bar) field well. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] primary_y_axis_label_options # The label options (label text, label visibility, and sort icon # visibility) of a combo chart's primary y-axis (bar) field well. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] secondary_y_axis_display_options # The label display options (grid line, range, scale, axis step) of a # combo chart's secondary y-axis (line) field well. # @return [Types::AxisDisplayOptions] # # @!attribute [rw] secondary_y_axis_label_options # The label options (label text, label visibility, and sort icon # visibility) of a combo chart's secondary y-axis(line) field well. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] color_label_options # The label options (label text, label visibility, and sort icon # visibility) of a combo chart's color field well. # @return [Types::ChartAxisLabelOptions] # # @!attribute [rw] legend # The legend display setup of the visual. # @return [Types::LegendOptions] # # @!attribute [rw] bar_data_labels # The options that determine if visual data labels are displayed. # # The data label options for a bar in a combo chart. # @return [Types::DataLabelOptions] # # @!attribute [rw] line_data_labels # The options that determine if visual data labels are displayed. # # The data label options for a line in a combo chart. # @return [Types::DataLabelOptions] # # @!attribute [rw] tooltip # The legend display setup of the visual. # @return [Types::TooltipOptions] # # @!attribute [rw] reference_lines # The reference line setup of the visual. # @return [Array] # # @!attribute [rw] visual_palette # The palette (chart color) display setup of the visual. # @return [Types::VisualPalette] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartConfiguration AWS API Documentation # class ComboChartConfiguration < Struct.new( :field_wells, :sort_configuration, :bars_arrangement, :category_axis, :category_label_options, :primary_y_axis_display_options, :primary_y_axis_label_options, :secondary_y_axis_display_options, :secondary_y_axis_label_options, :color_label_options, :legend, :bar_data_labels, :line_data_labels, :tooltip, :reference_lines, :visual_palette) SENSITIVE = [] include Aws::Structure end # The field wells of the visual. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] combo_chart_aggregated_field_wells # The aggregated field wells of a combo chart. Combo charts only have # aggregated field wells. Columns in a combo chart are aggregated by # category. # @return [Types::ComboChartAggregatedFieldWells] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartFieldWells AWS API Documentation # class ComboChartFieldWells < Struct.new( :combo_chart_aggregated_field_wells) SENSITIVE = [] include Aws::Structure end # The sort configuration of a `ComboChartVisual`. # # @!attribute [rw] category_sort # The sort configuration of the category field well in a combo chart. # @return [Array] # # @!attribute [rw] category_items_limit # The item limit configuration for the category field well of a combo # chart. # @return [Types::ItemsLimitConfiguration] # # @!attribute [rw] color_sort # The sort configuration of the color field well in a combo chart. # @return [Array] # # @!attribute [rw] color_items_limit # The item limit configuration of the color field well in a combo # chart. # @return [Types::ItemsLimitConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartSortConfiguration AWS API Documentation # class ComboChartSortConfiguration < Struct.new( :category_sort, :category_items_limit, :color_sort, :color_items_limit) SENSITIVE = [] include Aws::Structure end # A combo chart. # # The `ComboChartVisual` includes stacked bar combo charts and clustered # bar combo charts # # For more information, see [Using combo charts][1] in the *Amazon # QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html # # @!attribute [rw] visual_id # The unique identifier of a visual. This identifier must be unique # within the context of a dashboard, template, or analysis. Two # dashboards, analyses, or templates can have visuals with the same # identifiers. # @return [String] # # @!attribute [rw] title # The title that is displayed on the visual. # @return [Types::VisualTitleLabelOptions] # # @!attribute [rw] subtitle # The subtitle that is displayed on the visual. # @return [Types::VisualSubtitleLabelOptions] # # @!attribute [rw] chart_configuration # The configuration settings of the visual. # @return [Types::ComboChartConfiguration] # # @!attribute [rw] actions # The list of custom actions that are configured for a visual. # @return [Array] # # @!attribute [rw] column_hierarchies # The column hierarchy that is used during drill-downs and drill-ups. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartVisual AWS API Documentation # class ComboChartVisual < Struct.new( :visual_id, :title, :subtitle, :chart_configuration, :actions, :column_hierarchies) SENSITIVE = [] include Aws::Structure end # A structure that represents a comparative order. # # @!attribute [rw] use_ordering # The ordering type for a column. Valid values for this structure are # `GREATER_IS_BETTER`, `LESSER_IS_BETTER` and `SPECIFIED`. # @return [String] # # @!attribute [rw] specifed_order # The list of columns to be used in the ordering. # @return [Array] # # @!attribute [rw] treat_undefined_specified_values # The treat of undefined specified values. Valid values for this # structure are `LEAST` and `MOST`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComparativeOrder AWS API Documentation # class ComparativeOrder < Struct.new( :use_ordering, :specifed_order, :treat_undefined_specified_values) SENSITIVE = [] include Aws::Structure end # The comparison display configuration of a KPI or gauge chart. # # @!attribute [rw] comparison_method # The method of the comparison. Choose from the following options: # # * `DIFFERENCE` # # * `PERCENT_DIFFERENCE` # # * `PERCENT` # @return [String] # # @!attribute [rw] comparison_format # The format of the comparison. # @return [Types::ComparisonFormatConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComparisonConfiguration AWS API Documentation # class ComparisonConfiguration < Struct.new( :comparison_method, :comparison_format) SENSITIVE = [] include Aws::Structure end # The format of the comparison. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] number_display_format_configuration # The number display format. # @return [Types::NumberDisplayFormatConfiguration] # # @!attribute [rw] percentage_display_format_configuration # The percentage display format. # @return [Types::PercentageDisplayFormatConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComparisonFormatConfiguration AWS API Documentation # class ComparisonFormatConfiguration < Struct.new( :number_display_format_configuration, :percentage_display_format_configuration) SENSITIVE = [] include Aws::Structure end # The computation union that is used in an insight visual. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] top_bottom_ranked # The top ranked and bottom ranked computation configuration. # @return [Types::TopBottomRankedComputation] # # @!attribute [rw] top_bottom_movers # The top movers and bottom movers computation configuration. # @return [Types::TopBottomMoversComputation] # # @!attribute [rw] total_aggregation # The total aggregation computation configuration. # @return [Types::TotalAggregationComputation] # # @!attribute [rw] maximum_minimum # The maximum and minimum computation configuration. # @return [Types::MaximumMinimumComputation] # # @!attribute [rw] metric_comparison # The metric comparison computation configuration. # @return [Types::MetricComparisonComputation] # # @!attribute [rw] period_over_period # The period over period computation configuration. # @return [Types::PeriodOverPeriodComputation] # # @!attribute [rw] period_to_date # The period to `DataSetIdentifier` computation configuration. # @return [Types::PeriodToDateComputation] # # @!attribute [rw] growth_rate # The growth rate computation configuration. # @return [Types::GrowthRateComputation] # # @!attribute [rw] unique_values # The unique values computation configuration. # @return [Types::UniqueValuesComputation] # # @!attribute [rw] forecast # The forecast computation configuration. # @return [Types::ForecastComputation] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Computation AWS API Documentation # class Computation < Struct.new( :top_bottom_ranked, :top_bottom_movers, :total_aggregation, :maximum_minimum, :metric_comparison, :period_over_period, :period_to_date, :growth_rate, :unique_values, :forecast) SENSITIVE = [] include Aws::Structure end # A resource is already in a state that indicates an operation is # happening that must complete before a new update can be applied. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] request_id # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConcurrentUpdatingException AWS API Documentation # class ConcurrentUpdatingException < Struct.new( :message, :request_id) SENSITIVE = [] include Aws::Structure end # The formatting configuration for the color. # # @!attribute [rw] solid # Formatting configuration for solid color. # @return [Types::ConditionalFormattingSolidColor] # # @!attribute [rw] gradient # Formatting configuration for gradient color. # @return [Types::ConditionalFormattingGradientColor] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingColor AWS API Documentation # class ConditionalFormattingColor < Struct.new( :solid, :gradient) SENSITIVE = [] include Aws::Structure end # Determines the custom condition for an icon set. # # @!attribute [rw] expression # The expression that determines the condition of the icon set. # @return [String] # # @!attribute [rw] icon_options # Custom icon options for an icon set. # @return [Types::ConditionalFormattingCustomIconOptions] # # @!attribute [rw] color # Determines the color of the icon. # @return [String] # # @!attribute [rw] display_configuration # Determines the icon display configuration. # @return [Types::ConditionalFormattingIconDisplayConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingCustomIconCondition AWS API Documentation # class ConditionalFormattingCustomIconCondition < Struct.new( :expression, :icon_options, :color, :display_configuration) SENSITIVE = [:expression] include Aws::Structure end # Custom icon options for an icon set. # # @!attribute [rw] icon # Determines the type of icon. # @return [String] # # @!attribute [rw] unicode_icon # Determines the Unicode icon type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingCustomIconOptions AWS API Documentation # class ConditionalFormattingCustomIconOptions < Struct.new( :icon, :unicode_icon) SENSITIVE = [] include Aws::Structure end # Formatting configuration for gradient color. # # @!attribute [rw] expression # The expression that determines the formatting configuration for # gradient color. # @return [String] # # @!attribute [rw] color # Determines the color. # @return [Types::GradientColor] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingGradientColor AWS API Documentation # class ConditionalFormattingGradientColor < Struct.new( :expression, :color) SENSITIVE = [:expression] include Aws::Structure end # The formatting configuration for the icon. # # @!attribute [rw] icon_set # Formatting configuration for icon set. # @return [Types::ConditionalFormattingIconSet] # # @!attribute [rw] custom_condition # Determines the custom condition for an icon set. # @return [Types::ConditionalFormattingCustomIconCondition] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingIcon AWS API Documentation # class ConditionalFormattingIcon < Struct.new( :icon_set, :custom_condition) SENSITIVE = [] include Aws::Structure end # Determines the icon display configuration. # # @!attribute [rw] icon_display_option # Determines the icon display configuration. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingIconDisplayConfiguration AWS API Documentation # class ConditionalFormattingIconDisplayConfiguration < Struct.new( :icon_display_option) SENSITIVE = [] include Aws::Structure end # Formatting configuration for icon set. # # @!attribute [rw] expression # The expression that determines the formatting configuration for the # icon set. # @return [String] # # @!attribute [rw] icon_set_type # Determines the icon set type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingIconSet AWS API Documentation # class ConditionalFormattingIconSet < Struct.new( :expression, :icon_set_type) SENSITIVE = [:expression] include Aws::Structure end # Formatting configuration for solid color. # # @!attribute [rw] expression # The expression that determines the formatting configuration for # solid color. # @return [String] # # @!attribute [rw] color # Determines the color. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConditionalFormattingSolidColor AWS API Documentation # class ConditionalFormattingSolidColor < Struct.new( :expression, :color) SENSITIVE = [:expression] include Aws::Structure end # Updating or deleting a resource can cause an inconsistent state. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message, :request_id) SENSITIVE = [] include Aws::Structure end # The contribution analysis visual display for a line, pie, or bar # chart. # # @!attribute [rw] measure_field_id # The measure field that is used in the contribution analysis. # @return [String] # # @!attribute [rw] contributor_dimensions # The dimensions columns that are used in the contribution analysis, # usually a list of `ColumnIdentifiers`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ContributionAnalysisDefault AWS API Documentation # class ContributionAnalysisDefault < Struct.new( :measure_field_id, :contributor_dimensions) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that you want to # customize Amazon QuickSight for. # @return [String] # # @!attribute [rw] namespace # The Amazon QuickSight namespace that you want to add customizations # to. # @return [String] # # @!attribute [rw] account_customization # The Amazon QuickSight customizations you're adding in the current # Amazon Web Services Region. You can add these to an Amazon Web # Services account and a QuickSight namespace. # # For example, you can add a default theme by setting # `AccountCustomization` to the midnight theme: # `"AccountCustomization": \{ "DefaultTheme": # "arn:aws:quicksight::aws:theme/MIDNIGHT" \}`. Or, you can add a # custom theme by specifying `"AccountCustomization": \{ # "DefaultTheme": # "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" # \}`. # @return [Types::AccountCustomization] # # @!attribute [rw] tags # A list of the tags that you want to attach to this resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationRequest AWS API Documentation # class CreateAccountCustomizationRequest < Struct.new( :aws_account_id, :namespace, :account_customization, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the customization that you # created for this Amazon Web Services account. # @return [String] # # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that you want to # customize Amazon QuickSight for. # @return [String] # # @!attribute [rw] namespace # The namespace associated with the customization you're creating. # @return [String] # # @!attribute [rw] account_customization # The Amazon QuickSight customizations you're adding in the current # Amazon Web Services Region. # @return [Types::AccountCustomization] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationResponse AWS API Documentation # class CreateAccountCustomizationResponse < Struct.new( :arn, :aws_account_id, :namespace, :account_customization, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] edition # The edition of Amazon QuickSight that you want your account to have. # Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`. # # If you choose `ENTERPRISE_AND_Q`, the following parameters are # required: # # * `FirstName` # # * `LastName` # # * `EmailAddress` # # * `ContactNumber` # @return [String] # # @!attribute [rw] authentication_method # The method that you want to use to authenticate your Amazon # QuickSight account. Currently, the valid values for this parameter # are `IAM_AND_QUICKSIGHT`, `IAM_ONLY`, and `ACTIVE_DIRECTORY`. # # If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName` # and an `AdminGroup` associated with your Active Directory. # @return [String] # # @!attribute [rw] aws_account_id # The Amazon Web Services account ID of the account that you're using # to create your Amazon QuickSight account. # @return [String] # # @!attribute [rw] account_name # The name of your Amazon QuickSight account. This name is unique over # all of Amazon Web Services, and it appears only when users sign in. # You can't change `AccountName` value after the Amazon QuickSight # account is created. # @return [String] # # @!attribute [rw] notification_email # The email address that you want Amazon QuickSight to send # notifications to regarding your Amazon QuickSight account or Amazon # QuickSight subscription. # @return [String] # # @!attribute [rw] active_directory_name # The name of your Active Directory. This field is required if # `ACTIVE_DIRECTORY` is the selected authentication method of the new # Amazon QuickSight account. # @return [String] # # @!attribute [rw] realm # The realm of the Active Directory that is associated with your # Amazon QuickSight account. This field is required if # `ACTIVE_DIRECTORY` is the selected authentication method of the new # Amazon QuickSight account. # @return [String] # # @!attribute [rw] directory_id # The ID of the Active Directory that is associated with your Amazon # QuickSight account. # @return [String] # # @!attribute [rw] admin_group # The admin group associated with your Active Directory. This field is # required if `ACTIVE_DIRECTORY` is the selected authentication method # of the new Amazon QuickSight account. For more information about # using Active Directory in Amazon QuickSight, see [Using Active # Directory with Amazon QuickSight Enterprise Edition][1] in the # Amazon QuickSight User Guide. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html # @return [Array] # # @!attribute [rw] author_group # The author group associated with your Active Directory. For more # information about using Active Directory in Amazon QuickSight, see # [Using Active Directory with Amazon QuickSight Enterprise # Edition][1] in the Amazon QuickSight User Guide. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html # @return [Array] # # @!attribute [rw] reader_group # The reader group associated with your Active Direcrtory. For more # information about using Active Directory in Amazon QuickSight, see # [Using Active Directory with Amazon QuickSight Enterprise # Edition][1] in the *Amazon QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html # @return [Array] # # @!attribute [rw] first_name # The first name of the author of the Amazon QuickSight account to use # for future communications. This field is required if # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon # QuickSight account. # @return [String] # # @!attribute [rw] last_name # The last name of the author of the Amazon QuickSight account to use # for future communications. This field is required if # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon # QuickSight account. # @return [String] # # @!attribute [rw] email_address # The email address of the author of the Amazon QuickSight account to # use for future communications. This field is required if # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon # QuickSight account. # @return [String] # # @!attribute [rw] contact_number # A 10-digit phone number for the author of the Amazon QuickSight # account to use for future communications. This field is required if # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon # QuickSight account. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscriptionRequest AWS API Documentation # class CreateAccountSubscriptionRequest < Struct.new( :edition, :authentication_method, :aws_account_id, :account_name, :notification_email, :active_directory_name, :realm, :directory_id, :admin_group, :author_group, :reader_group, :first_name, :last_name, :email_address, :contact_number) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] signup_response # A `SignupResponse` object that returns information about a newly # created Amazon QuickSight account. # @return [Types::SignupResponse] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountSubscriptionResponse AWS API Documentation # class CreateAccountSubscriptionResponse < Struct.new( :signup_response, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account where you are creating an # analysis. # @return [String] # # @!attribute [rw] analysis_id # The ID for the analysis that you're creating. This ID displays in # the URL of the analysis. # @return [String] # # @!attribute [rw] name # A descriptive name for the analysis that you're creating. This name # displays for the analysis in the Amazon QuickSight console. # @return [String] # # @!attribute [rw] parameters # The parameter names and override values that you want to use. An # analysis can have any parameter type, and some parameters might # accept multiple values. # @return [Types::Parameters] # # @!attribute [rw] permissions # 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 Identity and Access # Management (IAM) action information for each principal listed by # Amazon Resource Name (ARN). # # To specify no permissions, omit `Permissions`. # @return [Array] # # @!attribute [rw] source_entity # A source entity to use for the analysis that you're creating. This # metadata structure contains details that describe a source template # and one or more datasets. # # Either a `SourceEntity` or a `Definition` must be provided in order # for the request to be valid. # @return [Types::AnalysisSourceEntity] # # @!attribute [rw] theme_arn # The ARN for the theme to apply to the analysis that you're # creating. To see the theme in the Amazon QuickSight console, make # sure that you have access to it. # @return [String] # # @!attribute [rw] tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the analysis. # @return [Array] # # @!attribute [rw] definition # The definition of an analysis. # # A definition is the data model of all features in a Dashboard, # Template, or Analysis. # # Either a `SourceEntity` or a `Definition` must be provided in order # for the request to be valid. # @return [Types::AnalysisDefinition] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisRequest AWS API Documentation # class CreateAnalysisRequest < Struct.new( :aws_account_id, :analysis_id, :name, :parameters, :permissions, :source_entity, :theme_arn, :tags, :definition) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The ARN for the analysis. # @return [String] # # @!attribute [rw] analysis_id # The ID of the analysis. # @return [String] # # @!attribute [rw] creation_status # The status of the creation of the analysis. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisResponse AWS API Documentation # class CreateAnalysisResponse < Struct.new( :arn, :analysis_id, :creation_status, :status, :request_id) SENSITIVE = [] include Aws::Structure end # A transform operation that creates calculated columns. Columns created # in one such operation form a lexical closure. # # @!attribute [rw] columns # Calculated columns to create. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateColumnsOperation AWS API Documentation # class CreateColumnsOperation < Struct.new( :columns) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account where you want to create # the dashboard. # @return [String] # # @!attribute [rw] dashboard_id # The ID for the dashboard, also added to the IAM policy. # @return [String] # # @!attribute [rw] name # The display name of the dashboard. # @return [String] # # @!attribute [rw] parameters # The parameters for the creation of the dashboard, which you want to # use to override the default settings. A dashboard can have any type # of parameters, and some parameters might accept multiple values. # @return [Types::Parameters] # # @!attribute [rw] permissions # A structure that contains the permissions of the dashboard. You can # use this structure for granting permissions by providing a list of # IAM action information for each principal ARN. # # To specify no permissions, omit the permissions list. # @return [Array] # # @!attribute [rw] source_entity # The entity that you are using as a source when you create the # dashboard. In `SourceEntity`, you specify the type of object you're # using as source. You can only create a dashboard from a template, so # you use a `SourceTemplate` entity. If you need to create a dashboard # from an analysis, first convert the analysis to a template by using # the ` CreateTemplate ` API operation. For `SourceTemplate`, specify # the Amazon Resource Name (ARN) of the source template. The # `SourceTemplate`ARN can contain any Amazon Web Services account and # any Amazon QuickSight-supported Amazon Web Services Region. # # Use the `DataSetReferences` entity within `SourceTemplate` to list # the replacement datasets for the placeholders listed in the # original. The schema in each dataset must match its placeholder. # # Either a `SourceEntity` or a `Definition` must be provided in order # for the request to be valid. # @return [Types::DashboardSourceEntity] # # @!attribute [rw] tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the dashboard. # @return [Array] # # @!attribute [rw] version_description # A description for the first version of the dashboard being created. # @return [String] # # @!attribute [rw] dashboard_publish_options # Options for publishing the dashboard when you create it: # # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can # be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`, # Amazon QuickSight disables the left filter pane on the published # dashboard, which can be used for ad hoc (one-time) filtering. This # option is `ENABLED` by default. # # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be # either `ENABLED` or `DISABLED`. The visual option to export data # to .CSV format isn't enabled when this is set to `DISABLED`. This # option is `ENABLED` by default. # # * `VisibilityState` for `SheetControlsOption` - This visibility # state can be either `COLLAPSED` or `EXPANDED`. This option is # `COLLAPSED` by default. # @return [Types::DashboardPublishOptions] # # @!attribute [rw] theme_arn # The Amazon Resource Name (ARN) of the theme that is being used for # this dashboard. If you add a value for this field, it overrides the # value that is used in the source entity. The theme ARN must exist in # the same Amazon Web Services account where you create the dashboard. # @return [String] # # @!attribute [rw] definition # The definition of a dashboard. # # A definition is the data model of all features in a Dashboard, # Template, or Analysis. # # Either a `SourceEntity` or a `Definition` must be provided in order # for the request to be valid. # @return [Types::DashboardVersionDefinition] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation # class CreateDashboardRequest < Struct.new( :aws_account_id, :dashboard_id, :name, :parameters, :permissions, :source_entity, :tags, :version_description, :dashboard_publish_options, :theme_arn, :definition) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The ARN of the dashboard. # @return [String] # # @!attribute [rw] version_arn # The ARN of the dashboard, including the version number of the first # version that is created. # @return [String] # # @!attribute [rw] dashboard_id # The ID for the dashboard. # @return [String] # # @!attribute [rw] creation_status # The status of the dashboard creation request. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardResponse AWS API Documentation # class CreateDashboardResponse < Struct.new( :arn, :version_arn, :dashboard_id, :creation_status, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The Amazon Web Services account ID. # @return [String] # # @!attribute [rw] data_set_id # An ID for the dataset that you want to create. This ID is unique per # Amazon Web Services Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] name # The display name for the dataset. # @return [String] # # @!attribute [rw] physical_table_map # Declares the physical tables that are available in the underlying # data sources. # @return [Hash] # # @!attribute [rw] logical_table_map # Configures the combination and transformation of the data from the # physical tables. # @return [Hash] # # @!attribute [rw] import_mode # Indicates whether you want to import the data into SPICE. # @return [String] # # @!attribute [rw] column_groups # Groupings of columns that work together in certain Amazon QuickSight # features. Currently, only geospatial hierarchy is supported. # @return [Array] # # @!attribute [rw] field_folders # The folder that contains fields and nested subfolders for your # dataset. # @return [Hash] # # @!attribute [rw] permissions # A list of resource permissions on the dataset. # @return [Array] # # @!attribute [rw] row_level_permission_data_set # The row-level security configuration for the data that you want to # create. # @return [Types::RowLevelPermissionDataSet] # # @!attribute [rw] row_level_permission_tag_configuration # The configuration of tags on a dataset to set row-level security. # Row-level security tags are currently supported for anonymous # embedding only. # @return [Types::RowLevelPermissionTagConfiguration] # # @!attribute [rw] column_level_permission_rules # A set of one or more definitions of a ` ColumnLevelPermissionRule `. # @return [Array] # # @!attribute [rw] tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the dataset. # @return [Array] # # @!attribute [rw] data_set_usage_configuration # The usage configuration to apply to child datasets that reference # this dataset as a source. # @return [Types::DataSetUsageConfiguration] # # @!attribute [rw] dataset_parameters # The parameter declarations of the dataset. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation # class CreateDataSetRequest < Struct.new( :aws_account_id, :data_set_id, :name, :physical_table_map, :logical_table_map, :import_mode, :column_groups, :field_folders, :permissions, :row_level_permission_data_set, :row_level_permission_tag_configuration, :column_level_permission_rules, :tags, :data_set_usage_configuration, :dataset_parameters) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the dataset. # @return [String] # # @!attribute [rw] data_set_id # The ID for the dataset that you want to create. This ID is unique # per Amazon Web Services Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] ingestion_arn # The ARN for the ingestion, which is triggered as a result of dataset # creation if the import mode is SPICE. # @return [String] # # @!attribute [rw] ingestion_id # The ID of the ingestion, which is triggered as a result of dataset # creation if the import mode is SPICE. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetResponse AWS API Documentation # class CreateDataSetResponse < Struct.new( :arn, :data_set_id, :ingestion_arn, :ingestion_id, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The Amazon Web Services account ID. # @return [String] # # @!attribute [rw] data_source_id # An ID for the data source. This ID is unique per Amazon Web Services # Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] name # A display name for the data source. # @return [String] # # @!attribute [rw] type # The type of the data source. To return a list of all data sources, # use `ListDataSources`. # # Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service. # @return [String] # # @!attribute [rw] data_source_parameters # The parameters that Amazon QuickSight uses to connect to your # underlying source. # @return [Types::DataSourceParameters] # # @!attribute [rw] credentials # The credentials Amazon QuickSight that uses to connect to your # underlying source. Currently, only credentials based on user name # and password are supported. # @return [Types::DataSourceCredentials] # # @!attribute [rw] permissions # A list of resource permissions on the data source. # @return [Array] # # @!attribute [rw] vpc_connection_properties # Use this parameter only when you want Amazon QuickSight to use a VPC # connection when connecting to your underlying source. # @return [Types::VpcConnectionProperties] # # @!attribute [rw] ssl_properties # Secure Socket Layer (SSL) properties that apply when Amazon # QuickSight connects to your underlying source. # @return [Types::SslProperties] # # @!attribute [rw] tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the data source. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSourceRequest AWS API Documentation # class CreateDataSourceRequest < Struct.new( :aws_account_id, :data_source_id, :name, :type, :data_source_parameters, :credentials, :permissions, :vpc_connection_properties, :ssl_properties, :tags) SENSITIVE = [:credentials] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the data source. # @return [String] # # @!attribute [rw] data_source_id # The ID of the data source. This ID is unique per Amazon Web Services # Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] creation_status # The status of creating the data source. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSourceResponse AWS API Documentation # class CreateDataSourceResponse < Struct.new( :arn, :data_source_id, :creation_status, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that contains the folder. # @return [String] # # @!attribute [rw] folder_id # The ID of the folder. # @return [String] # # @!attribute [rw] member_id # The ID of the asset (the dashboard, analysis, or dataset). # @return [String] # # @!attribute [rw] member_type # The type of the member, including `DASHBOARD`, `ANALYSIS`, and # `DATASET`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipRequest AWS API Documentation # class CreateFolderMembershipRequest < Struct.new( :aws_account_id, :folder_id, :member_id, :member_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] folder_member # Information about the member in the folder. # @return [Types::FolderMember] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipResponse AWS API Documentation # class CreateFolderMembershipResponse < Struct.new( :status, :folder_member, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account where you want to create # the folder. # @return [String] # # @!attribute [rw] folder_id # The ID of the folder. # @return [String] # # @!attribute [rw] name # The name of the folder. # @return [String] # # @!attribute [rw] folder_type # The type of folder. By default, `folderType` is `SHARED`. # @return [String] # # @!attribute [rw] parent_folder_arn # The Amazon Resource Name (ARN) for the parent folder. # # `ParentFolderArn` can be null. An empty `parentFolderArn` creates a # root-level folder. # @return [String] # # @!attribute [rw] permissions # A structure that describes the principals and the resource-level # permissions of a folder. # # To specify no permissions, omit `Permissions`. # @return [Array] # # @!attribute [rw] tags # Tags for the folder. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderRequest AWS API Documentation # class CreateFolderRequest < Struct.new( :aws_account_id, :folder_id, :name, :folder_type, :parent_folder_arn, :permissions, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the newly created folder. # @return [String] # # @!attribute [rw] folder_id # The folder ID for the newly created folder. # @return [String] # # @!attribute [rw] request_id # The request ID for the newly created folder. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderResponse AWS API Documentation # class CreateFolderResponse < Struct.new( :status, :arn, :folder_id, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] member_name # The name of the user that you want to add to the group membership. # @return [String] # # @!attribute [rw] group_name # The name of the group that you want to add the user to. # @return [String] # # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that the group is in. # Currently, you use the ID for the Amazon Web Services account that # contains your Amazon QuickSight account. # @return [String] # # @!attribute [rw] namespace # The namespace that you want the user to be a part of. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipRequest AWS API Documentation # class CreateGroupMembershipRequest < Struct.new( :member_name, :group_name, :aws_account_id, :namespace) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] group_member # The group member. # @return [Types::GroupMember] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipResponse AWS API Documentation # class CreateGroupMembershipResponse < Struct.new( :group_member, :request_id, :status) SENSITIVE = [] include Aws::Structure end # The request object for this operation. # # @!attribute [rw] group_name # A name for the group that you want to create. # @return [String] # # @!attribute [rw] description # A description for the group that you want to create. # @return [String] # # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that the group is in. # Currently, you use the ID for the Amazon Web Services account that # contains your Amazon QuickSight account. # @return [String] # # @!attribute [rw] namespace # The namespace that you want the group to be a part of. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupRequest AWS API Documentation # class CreateGroupRequest < Struct.new( :group_name, :description, :aws_account_id, :namespace) SENSITIVE = [] include Aws::Structure end # The response object for this operation. # # @!attribute [rw] group # The name of the group. # @return [Types::Group] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupResponse AWS API Documentation # class CreateGroupResponse < Struct.new( :group, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account where you want to assign # an IAM policy to Amazon QuickSight users or groups. # @return [String] # # @!attribute [rw] assignment_name # The name of the assignment, also called a rule. The name must be # unique within the Amazon Web Services account. # @return [String] # # @!attribute [rw] assignment_status # The status of the assignment. Possible values are as follows: # # * `ENABLED` - Anything specified in this assignment is used when # creating the data source. # # * `DISABLED` - This assignment isn't used when creating the data # source. # # * `DRAFT` - This assignment is an unfinished draft and isn't used # when creating the data source. # @return [String] # # @!attribute [rw] policy_arn # The ARN for the IAM policy to apply to the Amazon QuickSight users # and groups specified in this assignment. # @return [String] # # @!attribute [rw] identities # The Amazon QuickSight users, groups, or both that you want to assign # the policy to. # @return [Hash>] # # @!attribute [rw] namespace # The namespace that contains the assignment. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIAMPolicyAssignmentRequest AWS API Documentation # class CreateIAMPolicyAssignmentRequest < Struct.new( :aws_account_id, :assignment_name, :assignment_status, :policy_arn, :identities, :namespace) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assignment_name # The name of the assignment. The name must be unique within the # Amazon Web Services account. # @return [String] # # @!attribute [rw] assignment_id # The ID for the assignment. # @return [String] # # @!attribute [rw] assignment_status # The status of the assignment. Possible values are as follows: # # * `ENABLED` - Anything specified in this assignment is used when # creating the data source. # # * `DISABLED` - This assignment isn't used when creating the data # source. # # * `DRAFT` - This assignment is an unfinished draft and isn't used # when creating the data source. # @return [String] # # @!attribute [rw] policy_arn # The ARN for the IAM policy that is applied to the Amazon QuickSight # users and groups specified in this assignment. # @return [String] # # @!attribute [rw] identities # The Amazon QuickSight users, groups, or both that the IAM policy is # assigned to. # @return [Hash>] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIAMPolicyAssignmentResponse AWS API Documentation # class CreateIAMPolicyAssignmentResponse < Struct.new( :assignment_name, :assignment_id, :assignment_status, :policy_arn, :identities, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_set_id # The ID of the dataset used in the ingestion. # @return [String] # # @!attribute [rw] ingestion_id # An ID for the ingestion. # @return [String] # # @!attribute [rw] aws_account_id # The Amazon Web Services account ID. # @return [String] # # @!attribute [rw] ingestion_type # The type of ingestion that you want to create. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation # class CreateIngestionRequest < Struct.new( :data_set_id, :ingestion_id, :aws_account_id, :ingestion_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the data ingestion. # @return [String] # # @!attribute [rw] ingestion_id # An ID for the ingestion. # @return [String] # # @!attribute [rw] ingestion_status # The ingestion status. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionResponse AWS API Documentation # class CreateIngestionResponse < Struct.new( :arn, :ingestion_id, :ingestion_status, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that you want to create # the Amazon QuickSight namespace in. # @return [String] # # @!attribute [rw] namespace # The name that you want to use to describe the new namespace. # @return [String] # # @!attribute [rw] identity_store # Specifies the type of your user identity directory. Currently, this # supports users with an identity type of `QUICKSIGHT`. # @return [String] # # @!attribute [rw] tags # The tags that you want to associate with the namespace that you're # creating. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespaceRequest AWS API Documentation # class CreateNamespaceRequest < Struct.new( :aws_account_id, :namespace, :identity_store, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The ARN of the Amazon QuickSight namespace you created. # @return [String] # # @!attribute [rw] name # The name of the new namespace that you created. # @return [String] # # @!attribute [rw] capacity_region # The Amazon Web Services Region; that you want to use for the free # SPICE capacity for the new namespace. This is set to the region that # you run CreateNamespace in. # @return [String] # # @!attribute [rw] creation_status # The status of the creation of the namespace. This is an asynchronous # process. A status of `CREATED` means that your namespace is ready to # use. If an error occurs, it indicates if the process is `retryable` # or `non-retryable`. In the case of a non-retryable error, refer to # the error message for follow-up tasks. # @return [String] # # @!attribute [rw] identity_store # Specifies the type of your user identity directory. Currently, this # supports users with an identity type of `QUICKSIGHT`. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespaceResponse AWS API Documentation # class CreateNamespaceResponse < Struct.new( :arn, :name, :capacity_region, :creation_status, :identity_store, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_set_id # The ID of the dataset. # @return [String] # # @!attribute [rw] aws_account_id # The Amazon Web Services account ID. # @return [String] # # @!attribute [rw] schedule # The refresh schedule. # @return [Types::RefreshSchedule] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshScheduleRequest AWS API Documentation # class CreateRefreshScheduleRequest < Struct.new( :data_set_id, :aws_account_id, :schedule) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] schedule_id # The ID of the refresh schedule. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the refresh schedule. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshScheduleResponse AWS API Documentation # class CreateRefreshScheduleResponse < Struct.new( :status, :request_id, :schedule_id, :arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account that contains the template # that you creating an alias for. # @return [String] # # @!attribute [rw] template_id # An ID for the template. # @return [String] # # @!attribute [rw] alias_name # The name that you want to give to the template alias that you're # creating. Don't start the alias name with the `$` character. Alias # names that start with `$` are reserved by Amazon QuickSight. # @return [String] # # @!attribute [rw] template_version_number # The version number of the template. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateAliasRequest AWS API Documentation # class CreateTemplateAliasRequest < Struct.new( :aws_account_id, :template_id, :alias_name, :template_version_number) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] template_alias # Information about the template alias. # @return [Types::TemplateAlias] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateAliasResponse AWS API Documentation # class CreateTemplateAliasResponse < Struct.new( :template_alias, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID for the Amazon Web Services account that the group is in. You # use the ID for the Amazon Web Services account that contains your # Amazon QuickSight account. # @return [String] # # @!attribute [rw] template_id # An ID for the template that you want to create. This template is # unique per Amazon Web Services Region; in each Amazon Web Services # account. # @return [String] # # @!attribute [rw] name # A display name for the template. # @return [String] # # @!attribute [rw] permissions # A list of resource permissions to be set on the template. # @return [Array] # # @!attribute [rw] source_entity # The entity that you are using as a source when you create the # template. In `SourceEntity`, you specify the type of object you're # using as source: `SourceTemplate` for a template or `SourceAnalysis` # for an analysis. Both of these require an Amazon Resource Name # (ARN). For `SourceTemplate`, specify the ARN of the source template. # For `SourceAnalysis`, specify the ARN of the source analysis. The # `SourceTemplate` ARN can contain any Amazon Web Services account and # any Amazon QuickSight-supported Amazon Web Services Region. # # Use the `DataSetReferences` entity within `SourceTemplate` or # `SourceAnalysis` to list the replacement datasets for the # placeholders listed in the original. The schema in each dataset must # match its placeholder. # # Either a `SourceEntity` or a `Definition` must be provided in order # for the request to be valid. # @return [Types::TemplateSourceEntity] # # @!attribute [rw] tags # Contains a map of the key-value pairs for the resource tag or tags # assigned to the resource. # @return [Array] # # @!attribute [rw] version_description # A description of the current template version being created. This # API operation creates the first version of the template. Every time # `UpdateTemplate` is called, a new version is created. Each version # of the template maintains a description of the version in the # `VersionDescription` field. # @return [String] # # @!attribute [rw] definition # The definition of a template. # # A definition is the data model of all features in a Dashboard, # Template, or Analysis. # # Either a `SourceEntity` or a `Definition` must be provided in order # for the request to be valid. # @return [Types::TemplateVersionDefinition] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateRequest AWS API Documentation # class CreateTemplateRequest < Struct.new( :aws_account_id, :template_id, :name, :permissions, :source_entity, :tags, :version_description, :definition) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The ARN for the template. # @return [String] # # @!attribute [rw] version_arn # The ARN for the template, including the version information of the # first version. # @return [String] # # @!attribute [rw] template_id # The ID of the template. # @return [String] # # @!attribute [rw] creation_status # The template creation status. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateResponse AWS API Documentation # class CreateTemplateResponse < Struct.new( :arn, :version_arn, :template_id, :creation_status, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account that contains the theme # for the new theme alias. # @return [String] # # @!attribute [rw] theme_id # An ID for the theme alias. # @return [String] # # @!attribute [rw] alias_name # The name that you want to give to the theme alias that you are # creating. The alias name can't begin with a `$`. Alias names that # start with `$` are reserved by Amazon QuickSight. # @return [String] # # @!attribute [rw] theme_version_number # The version number of the theme. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAliasRequest AWS API Documentation # class CreateThemeAliasRequest < Struct.new( :aws_account_id, :theme_id, :alias_name, :theme_version_number) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] theme_alias # Information about the theme alias. # @return [Types::ThemeAlias] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAliasResponse AWS API Documentation # class CreateThemeAliasResponse < Struct.new( :theme_alias, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account where you want to store # the new theme. # @return [String] # # @!attribute [rw] theme_id # 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. # @return [String] # # @!attribute [rw] name # A display name for the theme. # @return [String] # # @!attribute [rw] base_theme_id # 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. # @return [String] # # @!attribute [rw] version_description # 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. # @return [String] # # @!attribute [rw] configuration # The theme configuration, which contains the theme display # properties. # @return [Types::ThemeConfiguration] # # @!attribute [rw] permissions # A valid grouping of resource permissions to apply to the new theme. # @return [Array] # # @!attribute [rw] tags # A map of the key-value pairs for the resource tag or tags that you # want to add to the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeRequest AWS API Documentation # class CreateThemeRequest < Struct.new( :aws_account_id, :theme_id, :name, :base_theme_id, :version_description, :configuration, :permissions, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) for the theme. # @return [String] # # @!attribute [rw] version_arn # The Amazon Resource Name (ARN) for the new theme. # @return [String] # # @!attribute [rw] theme_id # The ID of the theme. # @return [String] # # @!attribute [rw] creation_status # The theme creation status. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeResponse AWS API Documentation # class CreateThemeResponse < Struct.new( :arn, :version_arn, :theme_id, :creation_status, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account that contains the topic # you're creating a refresh schedule for. # @return [String] # # @!attribute [rw] topic_id # The ID of the topic that you want to modify. This ID is unique per # Amazon Web Services Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] dataset_arn # The Amazon Resource Name (ARN) of the dataset. # @return [String] # # @!attribute [rw] dataset_name # The name of the dataset. # @return [String] # # @!attribute [rw] refresh_schedule # The definition of a refresh schedule. # @return [Types::TopicRefreshSchedule] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRefreshScheduleRequest AWS API Documentation # class CreateTopicRefreshScheduleRequest < Struct.new( :aws_account_id, :topic_id, :dataset_arn, :dataset_name, :refresh_schedule) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] topic_id # The ID of the topic that you want to modify. This ID is unique per # Amazon Web Services Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] topic_arn # The Amazon Resource Name (ARN) of the topic. # @return [String] # # @!attribute [rw] dataset_arn # The Amazon Resource Name (ARN) of the dataset. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRefreshScheduleResponse AWS API Documentation # class CreateTopicRefreshScheduleResponse < Struct.new( :topic_id, :topic_arn, :dataset_arn, :status, :request_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The ID of the Amazon Web Services account that you want to create a # topic in. # @return [String] # # @!attribute [rw] topic_id # The ID for the topic that you want to create. This ID is unique per # Amazon Web Services Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] topic # The definition of a topic to create. # @return [Types::TopicDetails] # # @!attribute [rw] tags # Contains a map of the key-value pairs for the resource tag or tags # that are assigned to the dataset. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRequest AWS API Documentation # class CreateTopicRequest < Struct.new( :aws_account_id, :topic_id, :topic, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the topic. # @return [String] # # @!attribute [rw] topic_id # The ID for the topic that you want to create. This ID is unique per # Amazon Web Services Region for each Amazon Web Services account. # @return [String] # # @!attribute [rw] refresh_arn # The Amazon Resource Name (ARN) of the topic refresh. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicResponse AWS API Documentation # class CreateTopicResponse < Struct.new( :arn, :topic_id, :refresh_arn, :request_id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aws_account_id # The Amazon Web Services account ID of the account where you want to # create a new VPC connection. # @return [String] # # @!attribute [rw] vpc_connection_id # The ID of the VPC connection that you're creating. This ID is a # unique identifier for each Amazon Web Services Region in an Amazon # Web Services account. # @return [String] # # @!attribute [rw] name # The display name for the VPC connection. # @return [String] # # @!attribute [rw] subnet_ids # A list of subnet IDs for the VPC connection. # @return [Array] # # @!attribute [rw] security_group_ids # A list of security group IDs for the VPC connection. # @return [Array] # # @!attribute [rw] dns_resolvers # A list of IP addresses of DNS resolver endpoints for the VPC # connection. # @return [Array] # # @!attribute [rw] role_arn # The IAM role to associate with the VPC connection. # @return [String] # # @!attribute [rw] tags # A map of the key-value pairs for the resource tag or tags assigned # to the VPC connection. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateVPCConnectionRequest AWS API Documentation # class CreateVPCConnectionRequest < Struct.new( :aws_account_id, :vpc_connection_id, :name, :subnet_ids, :security_group_ids, :dns_resolvers, :role_arn, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the VPC connection. # @return [String] # # @!attribute [rw] vpc_connection_id # The ID for the VPC connection that you're creating. This ID is # unique per Amazon Web Services Region for each Amazon Web Services # account. # @return [String] # # @!attribute [rw] creation_status # The status of the creation of the VPC connection. # @return [String] # # @!attribute [rw] availability_status # The availability status of the VPC connection. # @return [String] # # @!attribute [rw] request_id # The Amazon Web Services request ID for this operation. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateVPCConnectionResponse AWS API Documentation # class CreateVPCConnectionResponse < Struct.new( :arn, :vpc_connection_id, :creation_status, :availability_status, :request_id, :status) SENSITIVE = [] include Aws::Structure end # The combination of user name and password that are used as # credentials. # # @!attribute [rw] username # User name. # @return [String] # # @!attribute [rw] password # Password. # @return [String] # # @!attribute [rw] alternate_data_source_parameters # A set of alternate data source parameters that you want to share for # these credentials. The credentials are applied in tandem with the # data source parameters when you copy a data source by using a create # or update request. The API operation compares the # `DataSourceParameters` structure that's in the request with the # structures in the `AlternateDataSourceParameters` allow list. If the # structures are an exact match, the request is allowed to use the new # data source with the existing credentials. If the # `AlternateDataSourceParameters` list is null, the # `DataSourceParameters` originally used with these `Credentials` is # automatically allowed. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CredentialPair AWS API Documentation # class CredentialPair < Struct.new( :username, :password, :alternate_data_source_parameters) SENSITIVE = [] include Aws::Structure end # The options that determine the currency display format configuration. # # @!attribute [rw] prefix # Determines the prefix value of the currency format. # @return [String] # # @!attribute [rw] suffix # Determines the suffix value of the currency format. # @return [String] # # @!attribute [rw] separator_configuration # The options that determine the numeric separator configuration. # @return [Types::NumericSeparatorConfiguration] # # @!attribute [rw] symbol # Determines the symbol for the currency format. # @return [String] # # @!attribute [rw] decimal_places_configuration # The option that determines the decimal places configuration. # @return [Types::DecimalPlacesConfiguration] # # @!attribute [rw] number_scale # Determines the number scale value for the currency format. # @return [String] # # @!attribute [rw] negative_value_configuration # The options that determine the negative value configuration. # @return [Types::NegativeValueConfiguration] # # @!attribute [rw] null_value_format_configuration # The options that determine the null value format configuration. # @return [Types::NullValueFormatConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CurrencyDisplayFormatConfiguration AWS API Documentation # class CurrencyDisplayFormatConfiguration < Struct.new( :prefix, :suffix, :separator_configuration, :symbol, :decimal_places_configuration, :number_scale, :negative_value_configuration, :null_value_format_configuration) SENSITIVE = [:prefix, :suffix] include Aws::Structure end # The filter operation that filters data included in a visual or in an # entire sheet. # # @!attribute [rw] selected_fields_configuration # The configuration that chooses the fields to be filtered. # @return [Types::FilterOperationSelectedFieldsConfiguration] # # @!attribute [rw] target_visuals_configuration # The configuration that chooses the target visuals to be filtered. # @return [Types::FilterOperationTargetVisualsConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionFilterOperation AWS API Documentation # class CustomActionFilterOperation < Struct.new( :selected_fields_configuration, :target_visuals_configuration) SENSITIVE = [] include Aws::Structure end # The navigation operation that navigates between different sheets in # the same analysis. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] local_navigation_configuration # The configuration that chooses the navigation target. # @return [Types::LocalNavigationConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionNavigationOperation AWS API Documentation # class CustomActionNavigationOperation < Struct.new( :local_navigation_configuration) SENSITIVE = [] include Aws::Structure end # The set parameter operation that sets parameters in custom action. # # @!attribute [rw] parameter_value_configurations # The parameter that determines the value configuration. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionSetParametersOperation AWS API Documentation # class CustomActionSetParametersOperation < Struct.new( :parameter_value_configurations) SENSITIVE = [] include Aws::Structure end # The URL operation that opens a link to another webpage. # # @!attribute [rw] url_template # THe URL link of the `CustomActionURLOperation`. # @return [String] # # @!attribute [rw] url_target # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionURLOperation AWS API Documentation # class CustomActionURLOperation < Struct.new( :url_template, :url_target) SENSITIVE = [] include Aws::Structure end # The configuration of a `CustomContentVisual`. # # @!attribute [rw] content_url # The input URL that links to the custom content that you want in the # custom visual. # @return [String] # # @!attribute [rw] content_type # The content type of the custom content visual. You can use this to # have the visual render as an image. # @return [String] # # @!attribute [rw] image_scaling # The sizing options for the size of the custom content visual. This # structure is required when the `ContentType` of the visual is # `'IMAGE'`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomContentConfiguration AWS API Documentation # class CustomContentConfiguration < Struct.new( :content_url, :content_type, :image_scaling) SENSITIVE = [] include Aws::Structure end # A visual that contains custom content. # # For more information, see [Using custom visual content][1] in the # *Amazon QuickSight User Guide*. # # # # [1]: https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html # # @!attribute [rw] visual_id # The unique identifier of a visual. This identifier must be unique # within the context of a dashboard, template, or analysis. Two # dashboards, analyses, or templates can have visuals with the same # identifiers. # @return [String] # # @!attribute [rw] title # The title that is displayed on the visual. # @return [Types::VisualTitleLabelOptions] # # @!attribute [rw] subtitle # The subtitle that is displayed on the visual. # @return [Types::VisualSubtitleLabelOptions] # # @!attribute [rw] chart_configuration # The configuration of a `CustomContentVisual`. # @return [Types::CustomContentConfiguration] # # @!attribute [rw] actions # The list of custom actions that are configured for a visual. # @return [Array] # # @!attribute [rw] data_set_identifier # The dataset that is used to create the custom content visual. You # can't create a visual without a dataset. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomContentVisual AWS API Documentation # class CustomContentVisual < Struct.new( :visual_id, :title, :subtitle, :chart_configuration, :actions, :data_set_identifier) SENSITIVE = [] include Aws::Structure end # A custom filter that filters based on a single value. This filter can # be partially matched. # # @!attribute [rw] match_operator # The match operator that is used to determine if a filter should be # applied. # @return [String] # # @!attribute [rw] category_value # The category value for the filter. # # This field is mutually exclusive to `ParameterName`. # @return [String] # # @!attribute [rw] select_all_options # Select all of the values. Null is not the assigned value of select # all. # # * `FILTER_ALL_VALUES` # # ^ # @return [String] # # @!attribute [rw] parameter_name # The parameter whose value should be used for the filter value. # # This field is mutually exclusive to `CategoryValue`. # @return [String] # # @!attribute [rw] null_option # This option determines how null values should be treated when # filtering data. # # * `ALL_VALUES`: Include null values in filtered results. # # * `NULLS_ONLY`: Only include null values in filtered results. # # * `NON_NULLS_ONLY`: Exclude null values from filtered results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterConfiguration AWS API Documentation # class CustomFilterConfiguration < Struct.new( :match_operator, :category_value, :select_all_options, :parameter_name, :null_option) SENSITIVE = [] include Aws::Structure end # A list of custom filter values. # # @!attribute [rw] match_operator # The match operator that is used to determine if a filter should be # applied. # @return [String] # # @!attribute [rw] category_values # The list of category values for the filter. # @return [Array] # # @!attribute [rw] select_all_options # Select all of the values. Null is not the assigned value of select # all. # # * `FILTER_ALL_VALUES` # # ^ # @return [String] # # @!attribute [rw] null_option # This option determines how null values should be treated when # filtering data. # # * `ALL_VALUES`: Include null values in filtered results. # # * `NULLS_ONLY`: Only include null values in filtered results. # # * `NON_NULLS_ONLY`: Exclude null values from filtered results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterListConfiguration AWS API Documentation # class CustomFilterListConfiguration < Struct.new( :match_operator, :category_values, :select_all_options, :null_option) SENSITIVE = [] include Aws::Structure end # The custom narrative options. # # @!attribute [rw] narrative # The string input of custom narrative. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomNarrativeOptions AWS API Documentation # class CustomNarrativeOptions < Struct.new( :narrative) SENSITIVE = [] include Aws::Structure end # The customized parameter values. # # This is a union type structure. For this structure to be valid, only # one of the attributes can be defined. # # @!attribute [rw] string_values # A list of string-type parameter values. # @return [Array] # # @!attribute [rw] integer_values # A list of integer-type parameter values. # @return [Array] # # @!attribute [rw] decimal_values # A list of decimal-type parameter values. # @return [Array] # # @!attribute [rw] date_time_values # A list of datetime-type parameter values. # @return [Array