# 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/master/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 access keys. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] request_id # The AWS 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 AWS account # or a QuickSight namespace in a specific AWS Region. # # @note When making an API call, you may pass AccountCustomization # data as a hash: # # { # default_theme: "Arn", # } # # @!attribute [rw] default_theme # The default theme for this QuickSight subscription. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation # class AccountCustomization < Struct.new( :default_theme) SENSITIVE = [] include Aws::Structure end # The QuickSight settings associated with your AWS account. # # @!attribute [rw] account_name # The "account name" you provided for the QuickSight subscription in # your AWS account. You create this name when you sign up for # QuickSight. It is unique in all of AWS and it appears only in the # console when users sign in. # @return [String] # # @!attribute [rw] edition # The edition of QuickSight that you're currently subscribed to: # Enterprise edition or Standard edition. # @return [String] # # @!attribute [rw] default_namespace # The default QuickSight namespace for your AWS account. # @return [String] # # @!attribute [rw] notification_email # The main notification email for your QuickSight subscription. # @return [String] # # @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) SENSITIVE = [] include Aws::Structure end # The active AWS 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 # Ad hoc (one-time) filtering option. # # @note When making an API call, you may pass AdHocFilteringOption # data as a hash: # # { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # } # # @!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 # Amazon Elasticsearch Service parameters. # # @note When making an API call, you may pass AmazonElasticsearchParameters # data as a hash: # # { # domain: "Domain", # required # } # # @!attribute [rw] domain # The Amazon Elasticsearch Service 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 # 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 # A metadata error structure for an analysis. # # @!attribute [rw] type # The type of the analysis error. # @return [String] # # @!attribute [rw] message # The message associated with the analysis error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisError AWS API Documentation # class AnalysisError < Struct.new( :type, :message) SENSITIVE = [] include Aws::Structure end # A filter that you apply when searching for one or more analyses. # # @note When making an API call, you may pass AnalysisSearchFilter # data as a hash: # # { # operator: "StringEquals", # accepts StringEquals # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER # value: "String", # } # # @!attribute [rw] operator # The comparison operator that you want to use as a filter, for # example `"Operator": "StringEquals"`. # @return [String] # # @!attribute [rw] name # The name of the value that you want to use as a filter, for example # `"Name": "QUICKSIGHT_USER"`. # @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. # # @note When making an API call, you may pass AnalysisSourceEntity # data as a hash: # # { # source_template: { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # }, # } # # @!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. # # @note When making an API call, you may pass AnalysisSourceTemplate # data as a hash: # # { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # } # # @!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 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 # Amazon Athena parameters. # # @note When making an API call, you may pass AthenaParameters # data as a hash: # # { # work_group: "WorkGroup", # } # # @!attribute [rw] work_group # The workgroup that Amazon Athena uses. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AthenaParameters AWS API Documentation # class AthenaParameters < Struct.new( :work_group) SENSITIVE = [] include Aws::Structure end # Amazon Aurora parameters. # # @note When making an API call, you may pass AuroraParameters # data as a hash: # # { # host: "Host", # required # port: 1, # required # database: "Database", # required # } # # @!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 # Amazon Aurora with PostgreSQL compatibility parameters. # # @note When making an API call, you may pass AuroraPostgreSqlParameters # data as a hash: # # { # host: "Host", # required # port: 1, # required # database: "Database", # required # } # # @!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/AuroraPostgreSqlParameters AWS API Documentation # class AuroraPostgreSqlParameters < Struct.new( :host, :port, :database) SENSITIVE = [] include Aws::Structure end # AWS IoT Analytics parameters. # # @note When making an API call, you may pass AwsIotAnalyticsParameters # data as a hash: # # { # data_set_name: "DataSetName", # required # } # # @!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 display options for tile borders for visuals. # # @note When making an API call, you may pass BorderStyle # data as a hash: # # { # show: false, # } # # @!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 # A calculated column for a dataset. # # @note When making an API call, you may pass CalculatedColumn # data as a hash: # # { # column_name: "ColumnName", # required # column_id: "ColumnId", # required # expression: "Expression", # required # } # # @!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 = [] include Aws::Structure end # @note When making an API call, you may pass CancelIngestionRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # data_set_id: "string", # required # ingestion_id: "IngestionId", # required # } # # @!attribute [rw] aws_account_id # The AWS 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 AWS 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 # A transform operation that casts a column to a different type. # # @note When making an API call, you may pass CastColumnTypeOperation # data as a hash: # # { # column_name: "ColumnName", # required # new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME # format: "TypeCastFormat", # } # # @!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 # Metadata that contains a description for a column. # # @note When making an API call, you may pass ColumnDescription # data as a hash: # # { # text: "ColumnDescriptiveText", # } # # @!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. # # @note When making an API call, you may pass ColumnGroup # data as a hash: # # { # geo_spatial_column_group: { # name: "ColumnGroupName", # required # country_code: "US", # required, accepts US # columns: ["ColumnName"], # required # }, # } # # @!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 # 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. # # @note When making an API call, you may pass ColumnLevelPermissionRule # data as a hash: # # { # principals: ["String"], # column_names: ["String"], # } # # @!attribute [rw] principals # An array of Amazon Resource Names (ARNs) for 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 # 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. # # @note When making an API call, you may pass ColumnTag # data as a hash: # # { # column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE # column_description: { # text: "ColumnDescriptiveText", # }, # } # # @!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 # 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 # Updating or deleting a resource can cause an inconsistent state. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] request_id # The AWS 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 # @note When making an API call, you may pass CreateAccountCustomizationRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # account_customization: { # required # default_theme: "Arn", # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] aws_account_id # The ID for the AWS account that you want to customize QuickSight # for. # @return [String] # # @!attribute [rw] namespace # The QuickSight namespace that you want to add customizations to. # @return [String] # # @!attribute [rw] account_customization # The QuickSight customizations you're adding in the current AWS # Region. You can add these to an AWS 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 AWS account. # @return [String] # # @!attribute [rw] aws_account_id # The ID for the AWS account that you want to customize QuickSight # for. # @return [String] # # @!attribute [rw] namespace # The namespace associated with the customization you're creating. # @return [String] # # @!attribute [rw] account_customization # The QuickSight customizations you're adding in the current AWS # Region. # @return [Types::AccountCustomization] # # @!attribute [rw] request_id # The AWS 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 # @note When making an API call, you may pass CreateAnalysisRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # analysis_id: "RestrictiveResourceId", # required # name: "AnalysisName", # required # parameters: { # string_parameters: [ # { # name: "NonEmptyString", # required # values: ["String"], # required # }, # ], # integer_parameters: [ # { # name: "NonEmptyString", # required # values: [1], # required # }, # ], # decimal_parameters: [ # { # name: "NonEmptyString", # required # values: [1.0], # required # }, # ], # date_time_parameters: [ # { # name: "NonEmptyString", # required # values: [Time.now], # required # }, # ], # }, # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # source_entity: { # required # source_template: { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # }, # }, # theme_arn: "Arn", # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] aws_account_id # The ID of the AWS 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 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 AWS 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. # @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 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] # # @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) 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 AWS 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. # # @note When making an API call, you may pass CreateColumnsOperation # data as a hash: # # { # columns: [ # required # { # column_name: "ColumnName", # required # column_id: "ColumnId", # required # expression: "Expression", # required # }, # ], # } # # @!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 # @note When making an API call, you may pass CreateDashboardRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # dashboard_id: "RestrictiveResourceId", # required # name: "DashboardName", # required # parameters: { # string_parameters: [ # { # name: "NonEmptyString", # required # values: ["String"], # required # }, # ], # integer_parameters: [ # { # name: "NonEmptyString", # required # values: [1], # required # }, # ], # decimal_parameters: [ # { # name: "NonEmptyString", # required # values: [1.0], # required # }, # ], # date_time_parameters: [ # { # name: "NonEmptyString", # required # values: [Time.now], # required # }, # ], # }, # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # source_entity: { # required # source_template: { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # version_description: "VersionDescription", # dashboard_publish_options: { # ad_hoc_filtering_option: { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # }, # export_to_csv_option: { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # }, # sheet_controls_option: { # visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED # }, # }, # theme_arn: "Arn", # } # # @!attribute [rw] aws_account_id # The ID of the AWS 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 AWS Account and any # QuickSight-supported AWS 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. # @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`, # 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 AWS account where you create the dashboard. # @return [String] # # @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) 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 AWS 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 # @note When making an API call, you may pass CreateDataSetRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # data_set_id: "ResourceId", # required # name: "ResourceName", # required # physical_table_map: { # required # "PhysicalTableId" => { # relational_table: { # data_source_arn: "Arn", # required # catalog: "RelationalTableCatalog", # schema: "RelationalTableSchema", # name: "RelationalTableName", # required # input_columns: [ # required # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # custom_sql: { # data_source_arn: "Arn", # required # name: "CustomSqlName", # required # sql_query: "SqlQuery", # required # columns: [ # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # s3_source: { # data_source_arn: "Arn", # required # upload_settings: { # format: "CSV", # accepts CSV, TSV, CLF, ELF, XLSX, JSON # start_from_row: 1, # contains_header: false, # text_qualifier: "DOUBLE_QUOTE", # accepts DOUBLE_QUOTE, SINGLE_QUOTE # delimiter: "Delimiter", # }, # input_columns: [ # required # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # }, # }, # }, # logical_table_map: { # "LogicalTableId" => { # alias: "LogicalTableAlias", # required # data_transforms: [ # { # project_operation: { # projected_columns: ["String"], # required # }, # filter_operation: { # condition_expression: "Expression", # required # }, # create_columns_operation: { # columns: [ # required # { # column_name: "ColumnName", # required # column_id: "ColumnId", # required # expression: "Expression", # required # }, # ], # }, # rename_column_operation: { # column_name: "ColumnName", # required # new_column_name: "ColumnName", # required # }, # cast_column_type_operation: { # column_name: "ColumnName", # required # new_column_type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME # format: "TypeCastFormat", # }, # tag_column_operation: { # column_name: "ColumnName", # required # tags: [ # required # { # column_geographic_role: "COUNTRY", # accepts COUNTRY, STATE, COUNTY, CITY, POSTCODE, LONGITUDE, LATITUDE # column_description: { # text: "ColumnDescriptiveText", # }, # }, # ], # }, # }, # ], # source: { # required # join_instruction: { # left_operand: "LogicalTableId", # required # right_operand: "LogicalTableId", # required # left_join_key_properties: { # unique_key: false, # }, # right_join_key_properties: { # unique_key: false, # }, # type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT # on_clause: "OnClause", # required # }, # physical_table_id: "PhysicalTableId", # }, # }, # }, # import_mode: "SPICE", # required, accepts SPICE, DIRECT_QUERY # column_groups: [ # { # geo_spatial_column_group: { # name: "ColumnGroupName", # required # country_code: "US", # required, accepts US # columns: ["ColumnName"], # required # }, # }, # ], # field_folders: { # "FieldFolderPath" => { # description: "FieldFolderDescription", # columns: ["String"], # }, # }, # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # row_level_permission_data_set: { # namespace: "Namespace", # arn: "Arn", # required # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS # }, # column_level_permission_rules: [ # { # principals: ["String"], # column_names: ["String"], # }, # ], # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] aws_account_id # The AWS account ID. # @return [String] # # @!attribute [rw] data_set_id # An ID for the dataset that you want to create. This ID is unique per # AWS Region for each AWS 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 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] 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] # # @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, :column_level_permission_rules, :tags) 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 AWS Region for each AWS 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 AWS 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 # @note When making an API call, you may pass CreateDataSourceRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # data_source_id: "ResourceId", # required # name: "ResourceName", # required # type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM # data_source_parameters: { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # oracle_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # }, # credentials: { # credential_pair: { # username: "Username", # required # password: "Password", # required # alternate_data_source_parameters: [ # { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # oracle_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # }, # ], # }, # copy_source_arn: "CopySourceArn", # }, # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # vpc_connection_properties: { # vpc_connection_arn: "Arn", # required # }, # ssl_properties: { # disable_ssl: false, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] aws_account_id # The AWS account ID. # @return [String] # # @!attribute [rw] data_source_id # An ID for the data source. This ID is unique per AWS Region for each # AWS account. # @return [String] # # @!attribute [rw] name # A display name for the data source. # @return [String] # # @!attribute [rw] type # The type of the data source. Currently, the supported types for this # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL, # AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, # S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to # return a list of all data sources. # # `AMAZON_ELASTICSEARCH` is for Amazon managed Elasticsearch Service. # @return [String] # # @!attribute [rw] data_source_parameters # The parameters that QuickSight uses to connect to your underlying # source. # @return [Types::DataSourceParameters] # # @!attribute [rw] credentials # The credentials 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 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 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 AWS Region for each # AWS account. # @return [String] # # @!attribute [rw] creation_status # The status of creating the data source. # @return [String] # # @!attribute [rw] request_id # The AWS 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 # @note When making an API call, you may pass CreateGroupMembershipRequest # data as a hash: # # { # member_name: "GroupMemberName", # required # group_name: "GroupName", # required # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # } # # @!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 AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # @return [String] # # @!attribute [rw] namespace # The namespace. Currently, you should set this to `default`. # @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 AWS 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. # # @note When making an API call, you may pass CreateGroupRequest # data as a hash: # # { # group_name: "GroupName", # required # description: "GroupDescription", # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # } # # @!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 AWS account that the group is in. Currently, you use # the ID for the AWS account that contains your Amazon QuickSight # account. # @return [String] # # @!attribute [rw] namespace # The namespace. Currently, you should set this to `default`. # @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 AWS 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 # @note When making an API call, you may pass CreateIAMPolicyAssignmentRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # assignment_name: "IAMPolicyAssignmentName", # required # assignment_status: "ENABLED", # required, accepts ENABLED, DRAFT, DISABLED # policy_arn: "Arn", # identities: { # "String" => ["IdentityName"], # }, # namespace: "Namespace", # required # } # # @!attribute [rw] aws_account_id # The ID of the AWS account where you want to assign an IAM policy to # QuickSight users or groups. # @return [String] # # @!attribute [rw] assignment_name # The name of the assignment, also called a rule. It must be unique # within an AWS 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 QuickSight users and # groups specified in this assignment. # @return [String] # # @!attribute [rw] identities # The 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. This name must be unique within the AWS # 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 QuickSight users # and groups specified in this assignment. # @return [String] # # @!attribute [rw] identities # The QuickSight users, groups, or both that the IAM policy is # assigned to. # @return [Hash>] # # @!attribute [rw] request_id # The AWS 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 # @note When making an API call, you may pass CreateIngestionRequest # data as a hash: # # { # data_set_id: "string", # required # ingestion_id: "IngestionId", # required # aws_account_id: "AwsAccountId", # required # } # # @!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 AWS account ID. # @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) 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 AWS 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 # @note When making an API call, you may pass CreateNamespaceRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # namespace: "Namespace", # required # identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] aws_account_id # The ID for the AWS account that you want to create the 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 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 AWS 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 AWS 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 # @note When making an API call, you may pass CreateTemplateAliasRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # alias_name: "AliasName", # required # template_version_number: 1, # required # } # # @!attribute [rw] aws_account_id # The ID of the AWS 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 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 AWS 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 # @note When making an API call, you may pass CreateTemplateRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # template_id: "RestrictiveResourceId", # required # name: "TemplateName", # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # source_entity: { # required # source_analysis: { # arn: "Arn", # required # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # }, # source_template: { # arn: "Arn", # required # }, # }, # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # version_description: "VersionDescription", # } # # @!attribute [rw] aws_account_id # The ID for the AWS account that the group is in. Currently, you use # the ID for the AWS 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 AWS Region in each AWS 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 AWS Account and any # QuickSight-supported AWS 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. # @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] # # @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) 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 AWS 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 # @note When making an API call, you may pass CreateThemeAliasRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # theme_id: "RestrictiveResourceId", # required # alias_name: "AliasName", # required # theme_version_number: 1, # required # } # # @!attribute [rw] aws_account_id # The ID of the AWS 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 AWS 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 # @note When making an API call, you may pass CreateThemeRequest # data as a hash: # # { # aws_account_id: "AwsAccountId", # required # theme_id: "RestrictiveResourceId", # required # name: "ThemeName", # required # base_theme_id: "RestrictiveResourceId", # required # version_description: "VersionDescription", # configuration: { # required # data_color_palette: { # colors: ["HexColor"], # min_max_gradient: ["HexColor"], # empty_fill_color: "HexColor", # }, # ui_color_palette: { # primary_foreground: "HexColor", # primary_background: "HexColor", # secondary_foreground: "HexColor", # secondary_background: "HexColor", # accent: "HexColor", # accent_foreground: "HexColor", # danger: "HexColor", # danger_foreground: "HexColor", # warning: "HexColor", # warning_foreground: "HexColor", # success: "HexColor", # success_foreground: "HexColor", # dimension: "HexColor", # dimension_foreground: "HexColor", # measure: "HexColor", # measure_foreground: "HexColor", # }, # sheet: { # tile: { # border: { # show: false, # }, # }, # tile_layout: { # gutter: { # show: false, # }, # margin: { # show: false, # }, # }, # }, # }, # permissions: [ # { # principal: "Principal", # required # actions: ["String"], # required # }, # ], # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # } # # @!attribute [rw] aws_account_id # The ID of the AWS 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 AWS Region in each AWS 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 a QuickSight 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 AWS 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 # The combination of user name and password that are used as # credentials. # # @note When making an API call, you may pass CredentialPair # data as a hash: # # { # username: "Username", # required # password: "Password", # required # alternate_data_source_parameters: [ # { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # oracle_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # }, # ], # } # # @!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 # A physical table type built from the results of the custom SQL query. # # @note When making an API call, you may pass CustomSql # data as a hash: # # { # data_source_arn: "Arn", # required # name: "CustomSqlName", # required # sql_query: "SqlQuery", # required # columns: [ # { # name: "ColumnName", # required # type: "STRING", # required, accepts STRING, INTEGER, DECIMAL, DATETIME, BIT, BOOLEAN, JSON # }, # ], # } # # @!attribute [rw] data_source_arn # The Amazon Resource Name (ARN) of the data source. # @return [String] # # @!attribute [rw] name # A display name for the SQL query result. # @return [String] # # @!attribute [rw] sql_query # The SQL query. # @return [String] # # @!attribute [rw] columns # The column schema from the SQL query result set. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomSql AWS API Documentation # class CustomSql < Struct.new( :data_source_arn, :name, :sql_query, :columns) SENSITIVE = [] include Aws::Structure end # Dashboard. # # @!attribute [rw] dashboard_id # Dashboard ID. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] name # A display name for the dashboard. # @return [String] # # @!attribute [rw] version # Version. # @return [Types::DashboardVersion] # # @!attribute [rw] created_time # The time that this dataset was created. # @return [Time] # # @!attribute [rw] last_published_time # The last time that this dataset was published. # @return [Time] # # @!attribute [rw] last_updated_time # The last time that this dataset was updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Dashboard AWS API Documentation # class Dashboard < Struct.new( :dashboard_id, :arn, :name, :version, :created_time, :last_published_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end # Dashboard error. # # @!attribute [rw] type # Type. # @return [String] # # @!attribute [rw] message # Message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardError AWS API Documentation # class DashboardError < Struct.new( :type, :message) SENSITIVE = [] include Aws::Structure end # Dashboard publish options. # # @note When making an API call, you may pass DashboardPublishOptions # data as a hash: # # { # ad_hoc_filtering_option: { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # }, # export_to_csv_option: { # availability_status: "ENABLED", # accepts ENABLED, DISABLED # }, # sheet_controls_option: { # visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED # }, # } # # @!attribute [rw] ad_hoc_filtering_option # Ad hoc (one-time) filtering option. # @return [Types::AdHocFilteringOption] # # @!attribute [rw] export_to_csv_option # Export to .csv option. # @return [Types::ExportToCSVOption] # # @!attribute [rw] sheet_controls_option # Sheet controls option. # @return [Types::SheetControlsOption] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardPublishOptions AWS API Documentation # class DashboardPublishOptions < Struct.new( :ad_hoc_filtering_option, :export_to_csv_option, :sheet_controls_option) SENSITIVE = [] include Aws::Structure end # A filter that you apply when searching for dashboards. # # @note When making an API call, you may pass DashboardSearchFilter # data as a hash: # # { # operator: "StringEquals", # required, accepts StringEquals # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER # value: "String", # } # # @!attribute [rw] operator # The comparison operator that you want to use as a filter, for # example, `"Operator": "StringEquals"`. # @return [String] # # @!attribute [rw] name # The name of the value that you want to use as a filter, for example, # `"Name": "QUICKSIGHT_USER"`. # @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": # "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSearchFilter AWS API Documentation # class DashboardSearchFilter < Struct.new( :operator, :name, :value) SENSITIVE = [] include Aws::Structure end # Dashboard source entity. # # @note When making an API call, you may pass DashboardSourceEntity # data as a hash: # # { # source_template: { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # }, # } # # @!attribute [rw] source_template # Source template. # @return [Types::DashboardSourceTemplate] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSourceEntity AWS API Documentation # class DashboardSourceEntity < Struct.new( :source_template) SENSITIVE = [] include Aws::Structure end # Dashboard source template. # # @note When making an API call, you may pass DashboardSourceTemplate # data as a hash: # # { # data_set_references: [ # required # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # }, # ], # arn: "Arn", # required # } # # @!attribute [rw] data_set_references # Dataset references. # @return [Array] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSourceTemplate AWS API Documentation # class DashboardSourceTemplate < Struct.new( :data_set_references, :arn) SENSITIVE = [] include Aws::Structure end # Dashboard summary. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] dashboard_id # Dashboard ID. # @return [String] # # @!attribute [rw] name # A display name for the dashboard. # @return [String] # # @!attribute [rw] created_time # The time that this dashboard was created. # @return [Time] # # @!attribute [rw] last_updated_time # The last time that this dashboard was updated. # @return [Time] # # @!attribute [rw] published_version_number # Published version number. # @return [Integer] # # @!attribute [rw] last_published_time # The last time that this dashboard was published. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSummary AWS API Documentation # class DashboardSummary < Struct.new( :arn, :dashboard_id, :name, :created_time, :last_updated_time, :published_version_number, :last_published_time) SENSITIVE = [] include Aws::Structure end # Dashboard version. # # @!attribute [rw] created_time # The time that this dashboard version was created. # @return [Time] # # @!attribute [rw] errors # Errors associated with this dashboard version. # @return [Array] # # @!attribute [rw] version_number # Version number for this version of the dashboard. # @return [Integer] # # @!attribute [rw] status # The HTTP status of the request. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] source_entity_arn # Source entity ARN. # @return [String] # # @!attribute [rw] data_set_arns # The Amazon Resource Numbers (ARNs) for the datasets that are # associated with this version of the dashboard. # @return [Array] # # @!attribute [rw] description # Description. # @return [String] # # @!attribute [rw] theme_arn # The ARN of the theme associated with a version of the dashboard. # @return [String] # # @!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/DashboardVersion AWS API Documentation # class DashboardVersion < Struct.new( :created_time, :errors, :version_number, :status, :arn, :source_entity_arn, :data_set_arns, :description, :theme_arn, :sheets) SENSITIVE = [] include Aws::Structure end # Dashboard version summary. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] created_time # The time that this dashboard version was created. # @return [Time] # # @!attribute [rw] version_number # Version number. # @return [Integer] # # @!attribute [rw] status # The HTTP status of the request. # @return [String] # # @!attribute [rw] source_entity_arn # Source entity ARN. # @return [String] # # @!attribute [rw] description # Description. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVersionSummary AWS API Documentation # class DashboardVersionSummary < Struct.new( :arn, :created_time, :version_number, :status, :source_entity_arn, :description) SENSITIVE = [] include Aws::Structure end # The theme colors that are used for data colors in charts. The colors # description is a hexadecimal color code that consists of six # alphanumerical characters, prefixed with `#`, for example #37BFF5. # # @note When making an API call, you may pass DataColorPalette # data as a hash: # # { # colors: ["HexColor"], # min_max_gradient: ["HexColor"], # empty_fill_color: "HexColor", # } # # @!attribute [rw] colors # The hexadecimal codes for the colors. # @return [Array] # # @!attribute [rw] min_max_gradient # The minimum and maximum hexadecimal codes that describe a color # gradient. # @return [Array] # # @!attribute [rw] empty_fill_color # The hexadecimal code of a color that applies to charts where a lack # of data is highlighted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataColorPalette AWS API Documentation # class DataColorPalette < Struct.new( :colors, :min_max_gradient, :empty_fill_color) SENSITIVE = [] include Aws::Structure end # Dataset. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] data_set_id # The ID of the dataset. # @return [String] # # @!attribute [rw] name # A display name for the dataset. # @return [String] # # @!attribute [rw] created_time # The time that this dataset was created. # @return [Time] # # @!attribute [rw] last_updated_time # The last time that this dataset was updated. # @return [Time] # # @!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] output_columns # The list of columns after all transforms. These columns are # available in templates, analyses, and dashboards. # @return [Array] # # @!attribute [rw] import_mode # A value that indicates whether you want to import the data into # SPICE. # @return [String] # # @!attribute [rw] consumed_spice_capacity_in_bytes # The amount of SPICE capacity used by this dataset. This is 0 if the # dataset isn't imported into SPICE. # @return [Integer] # # @!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] row_level_permission_data_set # The row-level security configuration for the dataset. # @return [Types::RowLevelPermissionDataSet] # # @!attribute [rw] column_level_permission_rules # A set of one or more definitions of a ` ColumnLevelPermissionRule `. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation # class DataSet < Struct.new( :arn, :data_set_id, :name, :created_time, :last_updated_time, :physical_table_map, :logical_table_map, :output_columns, :import_mode, :consumed_spice_capacity_in_bytes, :column_groups, :field_folders, :row_level_permission_data_set, :column_level_permission_rules) SENSITIVE = [] include Aws::Structure end # Dataset configuration. # # @!attribute [rw] placeholder # Placeholder. # @return [String] # # @!attribute [rw] data_set_schema # Dataset schema. # @return [Types::DataSetSchema] # # @!attribute [rw] column_group_schema_list # A structure containing the list of column group schemas. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetConfiguration AWS API Documentation # class DataSetConfiguration < Struct.new( :placeholder, :data_set_schema, :column_group_schema_list) SENSITIVE = [] include Aws::Structure end # Dataset reference. # # @note When making an API call, you may pass DataSetReference # data as a hash: # # { # data_set_placeholder: "NonEmptyString", # required # data_set_arn: "Arn", # required # } # # @!attribute [rw] data_set_placeholder # Dataset placeholder. # @return [String] # # @!attribute [rw] data_set_arn # Dataset Amazon Resource Name (ARN). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetReference AWS API Documentation # class DataSetReference < Struct.new( :data_set_placeholder, :data_set_arn) SENSITIVE = [] include Aws::Structure end # Dataset schema. # # @!attribute [rw] column_schema_list # A structure containing the list of column schemas. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSchema AWS API Documentation # class DataSetSchema < Struct.new( :column_schema_list) SENSITIVE = [] include Aws::Structure end # Dataset summary. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the dataset. # @return [String] # # @!attribute [rw] data_set_id # The ID of the dataset. # @return [String] # # @!attribute [rw] name # A display name for the dataset. # @return [String] # # @!attribute [rw] created_time # The time that this dataset was created. # @return [Time] # # @!attribute [rw] last_updated_time # The last time that this dataset was updated. # @return [Time] # # @!attribute [rw] import_mode # A value that indicates whether you want to import the data into # SPICE. # @return [String] # # @!attribute [rw] row_level_permission_data_set # The row-level security configuration for the dataset. # @return [Types::RowLevelPermissionDataSet] # # @!attribute [rw] column_level_permission_rules_applied # A value that indicates if the dataset has column level permission # configured. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation # class DataSetSummary < Struct.new( :arn, :data_set_id, :name, :created_time, :last_updated_time, :import_mode, :row_level_permission_data_set, :column_level_permission_rules_applied) SENSITIVE = [] include Aws::Structure end # The structure of a data source. # # @!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 AWS Region for each # AWS account. # @return [String] # # @!attribute [rw] name # A display name for the data source. # @return [String] # # @!attribute [rw] type # The type of the data source. This type indicates which database # engine the data source connects to. # @return [String] # # @!attribute [rw] status # The HTTP status of the request. # @return [String] # # @!attribute [rw] created_time # The time that this data source was created. # @return [Time] # # @!attribute [rw] last_updated_time # The last time that this data source was updated. # @return [Time] # # @!attribute [rw] data_source_parameters # The parameters that Amazon QuickSight uses to connect to your # underlying 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] alternate_data_source_parameters # A set of alternate data source parameters that you want to share for # the credentials stored with this data source. 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 credentials from this existing data source. If the # `AlternateDataSourceParameters` list is null, the `Credentials` # originally used with this `DataSourceParameters` are automatically # allowed. # @return [Array] # # @!attribute [rw] vpc_connection_properties # The VPC connection information. You need to use this parameter only # when you want 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 QuickSight # connects to your underlying source. # @return [Types::SslProperties] # # @!attribute [rw] error_info # Error information from the last update or the creation of the data # source. # @return [Types::DataSourceErrorInfo] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSource AWS API Documentation # class DataSource < Struct.new( :arn, :data_source_id, :name, :type, :status, :created_time, :last_updated_time, :data_source_parameters, :alternate_data_source_parameters, :vpc_connection_properties, :ssl_properties, :error_info) SENSITIVE = [] include Aws::Structure end # Data source credentials. This is a variant type structure. For this # structure to be valid, only one of the attributes can be non-null. # # @note When making an API call, you may pass DataSourceCredentials # data as a hash: # # { # credential_pair: { # username: "Username", # required # password: "Password", # required # alternate_data_source_parameters: [ # { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # oracle_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # }, # ], # }, # copy_source_arn: "CopySourceArn", # } # # @!attribute [rw] credential_pair # Credential pair. For more information, see CredentialPair. # @return [Types::CredentialPair] # # @!attribute [rw] copy_source_arn # The Amazon Resource Name (ARN) of a data source that has the # credential pair that you want to use. When `CopySourceArn` is not # null, the credential pair from the data source in the ARN is used as # the credentials for the `DataSourceCredentials` structure. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceCredentials AWS API Documentation # class DataSourceCredentials < Struct.new( :credential_pair, :copy_source_arn) SENSITIVE = [] include Aws::Structure end # Error information for the data source creation or update. # # @!attribute [rw] type # Error type. # @return [String] # # @!attribute [rw] message # Error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceErrorInfo AWS API Documentation # class DataSourceErrorInfo < Struct.new( :type, :message) SENSITIVE = [] include Aws::Structure end # 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. # # @note When making an API call, you may pass DataSourceParameters # data as a hash: # # { # amazon_elasticsearch_parameters: { # domain: "Domain", # required # }, # athena_parameters: { # work_group: "WorkGroup", # }, # aurora_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aurora_postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # aws_iot_analytics_parameters: { # data_set_name: "DataSetName", # required # }, # jira_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # maria_db_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # my_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # oracle_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # postgre_sql_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # presto_parameters: { # host: "Host", # required # port: 1, # required # catalog: "Catalog", # required # }, # rds_parameters: { # instance_id: "InstanceId", # required # database: "Database", # required # }, # redshift_parameters: { # host: "Host", # port: 1, # database: "Database", # required # cluster_id: "ClusterId", # }, # s3_parameters: { # manifest_file_location: { # required # bucket: "S3Bucket", # required # key: "S3Key", # required # }, # }, # service_now_parameters: { # site_base_url: "SiteBaseUrl", # required # }, # snowflake_parameters: { # host: "Host", # required # database: "Database", # required # warehouse: "Warehouse", # required # }, # spark_parameters: { # host: "Host", # required # port: 1, # required # }, # sql_server_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # teradata_parameters: { # host: "Host", # required # port: 1, # required # database: "Database", # required # }, # twitter_parameters: { # query: "Query", # required # max_rows: 1, # required # }, # } # # @!attribute [rw] amazon_elasticsearch_parameters # Amazon Elasticsearch Service parameters. # @return [Types::AmazonElasticsearchParameters] # # @!attribute [rw] athena_parameters # Amazon Athena parameters. # @return [Types::AthenaParameters] # # @!attribute [rw] aurora_parameters # Amazon Aurora MySQL parameters. # @return [Types::AuroraParameters] # # @!attribute [rw] aurora_postgre_sql_parameters # Aurora PostgreSQL parameters. # @return [Types::AuroraPostgreSqlParameters] # # @!attribute [rw] aws_iot_analytics_parameters # AWS IoT Analytics parameters. # @return [Types::AwsIotAnalyticsParameters] # # @!attribute [rw] jira_parameters # Jira parameters. # @return [Types::JiraParameters] # # @!attribute [rw] maria_db_parameters # MariaDB parameters. # @return [Types::MariaDbParameters] # # @!attribute [rw] my_sql_parameters # MySQL parameters. # @return [Types::MySqlParameters] # # @!attribute [rw] oracle_parameters # Oracle parameters. # @return [Types::OracleParameters] # # @!attribute [rw] postgre_sql_parameters # PostgreSQL parameters. # @return [Types::PostgreSqlParameters] # # @!attribute [rw] presto_parameters # Presto parameters. # @return [Types::PrestoParameters] # # @!attribute [rw] rds_parameters # Amazon RDS parameters. # @return [Types::RdsParameters] # # @!attribute [rw] redshift_parameters # Amazon Redshift parameters. # @return [Types::RedshiftParameters] # # @!attribute [rw] s3_parameters # S3 parameters. # @return [Types::S3Parameters] # # @!attribute [rw] service_now_parameters # ServiceNow parameters. # @return [Types::ServiceNowParameters] # # @!attribute [rw] snowflake_parameters # Snowflake parameters. # @return [Types::SnowflakeParameters] # # @!attribute [rw] spark_parameters # Spark parameters. # @return [Types::SparkParameters] # # @!attribute [rw] sql_server_parameters # SQL Server parameters. # @return [Types::SqlServerParameters] # # @!attribute [rw] teradata_parameters # Teradata parameters. # @return [Types::TeradataParameters] # # @!attribute [rw] twitter_parameters # Twitter parameters. # @return [Types::TwitterParameters] # # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation # class DataSourceParameters < Struct.new( :amazon_elasticsearch_parameters, :athena_parameters, :aurora_parameters, :aurora_postgre_sql_parameters, :aws_iot_analytics_parameters, :jira_parameters, :maria_db_parameters, :my_sql_parameters, :oracle_parameters, :postgre_sql_parameters, :presto_parameters, :rds_parameters, :redshift_parameters, :s3_parameters, :service_now_parameters, :snowflake_parameters, :spark_parameters, :sql_server_parameters, :teradata_parameters, :twitter_parameters) SENSITIVE = [] include Aws::Structure end # A date-time parameter. # # @note When making an API call, you may pass DateTimeParameter # data as a hash: # # { # name: "NonEmptyString", # required # values: [Time.now], # required # } # # @!attribute [rw] name # A display name for the date-time parameter. # @return [String] # # @!attribute [rw] values # The values for the date-time parameter. # @return [Array