1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package types
4
5import (
6	"time"
7)
8
9// The Amazon QuickSight customizations associated with your AWS account or a
10// QuickSight namespace in a specific AWS Region.
11type AccountCustomization struct {
12
13	// The default theme for this QuickSight subscription.
14	DefaultTheme *string
15}
16
17// The QuickSight settings associated with your AWS account.
18type AccountSettings struct {
19
20	// The "account name" you provided for the QuickSight subscription in your AWS
21	// account. You create this name when you sign up for QuickSight. It is unique in
22	// all of AWS and it appears only in the console when users sign in.
23	AccountName *string
24
25	// The default QuickSight namespace for your AWS account.
26	DefaultNamespace *string
27
28	// The edition of QuickSight that you're currently subscribed to: Enterprise
29	// edition or Standard edition.
30	Edition Edition
31
32	// The main notification email for your QuickSight subscription.
33	NotificationEmail *string
34}
35
36// The active AWS Identity and Access Management (IAM) policy assignment.
37type ActiveIAMPolicyAssignment struct {
38
39	// A name for the IAM policy assignment.
40	AssignmentName *string
41
42	// The Amazon Resource Name (ARN) of the resource.
43	PolicyArn *string
44}
45
46// Ad hoc (one-time) filtering option.
47type AdHocFilteringOption struct {
48
49	// Availability status.
50	AvailabilityStatus DashboardBehavior
51}
52
53// Amazon Elasticsearch Service parameters.
54type AmazonElasticsearchParameters struct {
55
56	// The Amazon Elasticsearch Service domain.
57	//
58	// This member is required.
59	Domain *string
60}
61
62// Metadata structure for an analysis in Amazon QuickSight
63type Analysis struct {
64
65	// The ID of the analysis.
66	AnalysisId *string
67
68	// The Amazon Resource Name (ARN) of the analysis.
69	Arn *string
70
71	// The time that the analysis was created.
72	CreatedTime *time.Time
73
74	// The ARNs of the datasets of the analysis.
75	DataSetArns []string
76
77	// Errors associated with the analysis.
78	Errors []AnalysisError
79
80	// The time that the analysis was last updated.
81	LastUpdatedTime *time.Time
82
83	// The descriptive name of the analysis.
84	Name *string
85
86	// A list of the associated sheets with the unique identifier and name of each
87	// sheet.
88	Sheets []Sheet
89
90	// Status associated with the analysis.
91	Status ResourceStatus
92
93	// The ARN of the theme of the analysis.
94	ThemeArn *string
95}
96
97// A metadata error structure for an analysis.
98type AnalysisError struct {
99
100	// The message associated with the analysis error.
101	Message *string
102
103	// The type of the analysis error.
104	Type AnalysisErrorType
105}
106
107// A filter that you apply when searching for one or more analyses.
108type AnalysisSearchFilter struct {
109
110	// The name of the value that you want to use as a filter, for example "Name":
111	// "QUICKSIGHT_USER".
112	Name AnalysisFilterAttribute
113
114	// The comparison operator that you want to use as a filter, for example
115	// "Operator": "StringEquals".
116	Operator FilterOperator
117
118	// The value of the named item, in this case QUICKSIGHT_USER, that you want to use
119	// as a filter, for example "Value". An example is
120	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
121	Value *string
122}
123
124// The source entity of an analysis.
125type AnalysisSourceEntity struct {
126
127	// The source template for the source entity of the analysis.
128	SourceTemplate *AnalysisSourceTemplate
129}
130
131// The source template of an analysis.
132type AnalysisSourceTemplate struct {
133
134	// The Amazon Resource Name (ARN) of the source template of an analysis.
135	//
136	// This member is required.
137	Arn *string
138
139	// The dataset references of the source template of an analysis.
140	//
141	// This member is required.
142	DataSetReferences []DataSetReference
143}
144
145// The summary metadata that describes an analysis.
146type AnalysisSummary struct {
147
148	// The ID of the analysis. This ID displays in the URL.
149	AnalysisId *string
150
151	// The Amazon Resource Name (ARN) for the analysis.
152	Arn *string
153
154	// The time that the analysis was created.
155	CreatedTime *time.Time
156
157	// The time that the analysis was last updated.
158	LastUpdatedTime *time.Time
159
160	// The name of the analysis. This name is displayed in the QuickSight console.
161	Name *string
162
163	// The last known status for the analysis.
164	Status ResourceStatus
165}
166
167// Amazon Athena parameters.
168type AthenaParameters struct {
169
170	// The workgroup that Amazon Athena uses.
171	WorkGroup *string
172}
173
174// Amazon Aurora parameters.
175type AuroraParameters struct {
176
177	// Database.
178	//
179	// This member is required.
180	Database *string
181
182	// Host.
183	//
184	// This member is required.
185	Host *string
186
187	// Port.
188	//
189	// This member is required.
190	Port int32
191}
192
193// Amazon Aurora with PostgreSQL compatibility parameters.
194type AuroraPostgreSqlParameters struct {
195
196	// Database.
197	//
198	// This member is required.
199	Database *string
200
201	// Host.
202	//
203	// This member is required.
204	Host *string
205
206	// Port.
207	//
208	// This member is required.
209	Port int32
210}
211
212// AWS IoT Analytics parameters.
213type AwsIotAnalyticsParameters struct {
214
215	// Dataset name.
216	//
217	// This member is required.
218	DataSetName *string
219}
220
221// The display options for tile borders for visuals.
222type BorderStyle struct {
223
224	// The option to enable display of borders for visuals.
225	Show bool
226}
227
228// A calculated column for a dataset.
229type CalculatedColumn struct {
230
231	// A unique ID to identify a calculated column. During a dataset update, if the
232	// column ID of a calculated column matches that of an existing calculated column,
233	// Amazon QuickSight preserves the existing calculated column.
234	//
235	// This member is required.
236	ColumnId *string
237
238	// Column name.
239	//
240	// This member is required.
241	ColumnName *string
242
243	// An expression that defines the calculated column.
244	//
245	// This member is required.
246	Expression *string
247}
248
249// A transform operation that casts a column to a different type.
250type CastColumnTypeOperation struct {
251
252	// Column name.
253	//
254	// This member is required.
255	ColumnName *string
256
257	// New column data type.
258	//
259	// This member is required.
260	NewColumnType ColumnDataType
261
262	// When casting a column from string to datetime type, you can supply a string in a
263	// format supported by Amazon QuickSight to denote the source data format.
264	Format *string
265}
266
267// Metadata that contains a description for a column.
268type ColumnDescription struct {
269
270	// The text of a description for a column.
271	Text *string
272}
273
274// Groupings of columns that work together in certain Amazon QuickSight features.
275// This is a variant type structure. For this structure to be valid, only one of
276// the attributes can be non-null.
277type ColumnGroup struct {
278
279	// Geospatial column group that denotes a hierarchy.
280	GeoSpatialColumnGroup *GeoSpatialColumnGroup
281}
282
283// A structure describing the name, data type, and geographic role of the columns.
284type ColumnGroupColumnSchema struct {
285
286	// The name of the column group's column schema.
287	Name *string
288}
289
290// The column group schema.
291type ColumnGroupSchema struct {
292
293	// A structure containing the list of schemas for column group columns.
294	ColumnGroupColumnSchemaList []ColumnGroupColumnSchema
295
296	// The name of the column group schema.
297	Name *string
298}
299
300// A rule defined to grant access on one or more restricted columns. Each dataset
301// can have multiple rules. To create a restricted column, you add it to one or
302// more rules. Each rule must contain at least one column and at least one user or
303// group. To be able to see a restricted column, a user or group needs to be added
304// to a rule for that column.
305type ColumnLevelPermissionRule struct {
306
307	// An array of column names.
308	ColumnNames []string
309
310	// An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
311	Principals []string
312}
313
314// The column schema.
315type ColumnSchema struct {
316
317	// The data type of the column schema.
318	DataType *string
319
320	// The geographic role of the column schema.
321	GeographicRole *string
322
323	// The name of the column schema.
324	Name *string
325}
326
327// A tag for a column in a TagColumnOperation structure. This is a variant type
328// structure. For this structure to be valid, only one of the attributes can be
329// non-null.
330type ColumnTag struct {
331
332	// A description for a column.
333	ColumnDescription *ColumnDescription
334
335	// A geospatial role for a column.
336	ColumnGeographicRole GeoSpatialDataRole
337}
338
339// A transform operation that creates calculated columns. Columns created in one
340// such operation form a lexical closure.
341type CreateColumnsOperation struct {
342
343	// Calculated columns to create.
344	//
345	// This member is required.
346	Columns []CalculatedColumn
347}
348
349// The combination of user name and password that are used as credentials.
350type CredentialPair struct {
351
352	// Password.
353	//
354	// This member is required.
355	Password *string
356
357	// User name.
358	//
359	// This member is required.
360	Username *string
361
362	// A set of alternate data source parameters that you want to share for these
363	// credentials. The credentials are applied in tandem with the data source
364	// parameters when you copy a data source by using a create or update request. The
365	// API operation compares the DataSourceParameters structure that's in the request
366	// with the structures in the AlternateDataSourceParameters allow list. If the
367	// structures are an exact match, the request is allowed to use the new data source
368	// with the existing credentials. If the AlternateDataSourceParameters list is
369	// null, the DataSourceParameters originally used with these Credentials is
370	// automatically allowed.
371	AlternateDataSourceParameters []DataSourceParameters
372}
373
374// A physical table type built from the results of the custom SQL query.
375type CustomSql struct {
376
377	// The Amazon Resource Name (ARN) of the data source.
378	//
379	// This member is required.
380	DataSourceArn *string
381
382	// A display name for the SQL query result.
383	//
384	// This member is required.
385	Name *string
386
387	// The SQL query.
388	//
389	// This member is required.
390	SqlQuery *string
391
392	// The column schema from the SQL query result set.
393	Columns []InputColumn
394}
395
396// Dashboard.
397type Dashboard struct {
398
399	// The Amazon Resource Name (ARN) of the resource.
400	Arn *string
401
402	// The time that this dataset was created.
403	CreatedTime *time.Time
404
405	// Dashboard ID.
406	DashboardId *string
407
408	// The last time that this dataset was published.
409	LastPublishedTime *time.Time
410
411	// The last time that this dataset was updated.
412	LastUpdatedTime *time.Time
413
414	// A display name for the dashboard.
415	Name *string
416
417	// Version.
418	Version *DashboardVersion
419}
420
421// Dashboard error.
422type DashboardError struct {
423
424	// Message.
425	Message *string
426
427	// Type.
428	Type DashboardErrorType
429}
430
431// Dashboard publish options.
432type DashboardPublishOptions struct {
433
434	// Ad hoc (one-time) filtering option.
435	AdHocFilteringOption *AdHocFilteringOption
436
437	// Export to .csv option.
438	ExportToCSVOption *ExportToCSVOption
439
440	// Sheet controls option.
441	SheetControlsOption *SheetControlsOption
442}
443
444// A filter that you apply when searching for dashboards.
445type DashboardSearchFilter struct {
446
447	// The comparison operator that you want to use as a filter, for example,
448	// "Operator": "StringEquals".
449	//
450	// This member is required.
451	Operator FilterOperator
452
453	// The name of the value that you want to use as a filter, for example, "Name":
454	// "QUICKSIGHT_USER".
455	Name DashboardFilterAttribute
456
457	// The value of the named item, in this case QUICKSIGHT_USER, that you want to use
458	// as a filter, for example, "Value":
459	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
460	Value *string
461}
462
463// Dashboard source entity.
464type DashboardSourceEntity struct {
465
466	// Source template.
467	SourceTemplate *DashboardSourceTemplate
468}
469
470// Dashboard source template.
471type DashboardSourceTemplate struct {
472
473	// The Amazon Resource Name (ARN) of the resource.
474	//
475	// This member is required.
476	Arn *string
477
478	// Dataset references.
479	//
480	// This member is required.
481	DataSetReferences []DataSetReference
482}
483
484// Dashboard summary.
485type DashboardSummary struct {
486
487	// The Amazon Resource Name (ARN) of the resource.
488	Arn *string
489
490	// The time that this dashboard was created.
491	CreatedTime *time.Time
492
493	// Dashboard ID.
494	DashboardId *string
495
496	// The last time that this dashboard was published.
497	LastPublishedTime *time.Time
498
499	// The last time that this dashboard was updated.
500	LastUpdatedTime *time.Time
501
502	// A display name for the dashboard.
503	Name *string
504
505	// Published version number.
506	PublishedVersionNumber *int64
507}
508
509// Dashboard version.
510type DashboardVersion struct {
511
512	// The Amazon Resource Name (ARN) of the resource.
513	Arn *string
514
515	// The time that this dashboard version was created.
516	CreatedTime *time.Time
517
518	// The Amazon Resource Numbers (ARNs) for the datasets that are associated with
519	// this version of the dashboard.
520	DataSetArns []string
521
522	// Description.
523	Description *string
524
525	// Errors associated with this dashboard version.
526	Errors []DashboardError
527
528	// A list of the associated sheets with the unique identifier and name of each
529	// sheet.
530	Sheets []Sheet
531
532	// Source entity ARN.
533	SourceEntityArn *string
534
535	// The HTTP status of the request.
536	Status ResourceStatus
537
538	// The ARN of the theme associated with a version of the dashboard.
539	ThemeArn *string
540
541	// Version number for this version of the dashboard.
542	VersionNumber *int64
543}
544
545// Dashboard version summary.
546type DashboardVersionSummary struct {
547
548	// The Amazon Resource Name (ARN) of the resource.
549	Arn *string
550
551	// The time that this dashboard version was created.
552	CreatedTime *time.Time
553
554	// Description.
555	Description *string
556
557	// Source entity ARN.
558	SourceEntityArn *string
559
560	// The HTTP status of the request.
561	Status ResourceStatus
562
563	// Version number.
564	VersionNumber *int64
565}
566
567// The theme colors that are used for data colors in charts. The colors description
568// is a hexadecimal color code that consists of six alphanumerical characters,
569// prefixed with #, for example #37BFF5.
570type DataColorPalette struct {
571
572	// The hexadecimal codes for the colors.
573	Colors []string
574
575	// The hexadecimal code of a color that applies to charts where a lack of data is
576	// highlighted.
577	EmptyFillColor *string
578
579	// The minimum and maximum hexadecimal codes that describe a color gradient.
580	MinMaxGradient []string
581}
582
583// Dataset.
584type DataSet struct {
585
586	// The Amazon Resource Name (ARN) of the resource.
587	Arn *string
588
589	// Groupings of columns that work together in certain Amazon QuickSight features.
590	// Currently, only geospatial hierarchy is supported.
591	ColumnGroups []ColumnGroup
592
593	// A set of one or more definitions of a ColumnLevelPermissionRule.
594	ColumnLevelPermissionRules []ColumnLevelPermissionRule
595
596	// The amount of SPICE capacity used by this dataset. This is 0 if the dataset
597	// isn't imported into SPICE.
598	ConsumedSpiceCapacityInBytes int64
599
600	// The time that this dataset was created.
601	CreatedTime *time.Time
602
603	// The ID of the dataset.
604	DataSetId *string
605
606	// The folder that contains fields and nested subfolders for your dataset.
607	FieldFolders map[string]FieldFolder
608
609	// A value that indicates whether you want to import the data into SPICE.
610	ImportMode DataSetImportMode
611
612	// The last time that this dataset was updated.
613	LastUpdatedTime *time.Time
614
615	// Configures the combination and transformation of the data from the physical
616	// tables.
617	LogicalTableMap map[string]LogicalTable
618
619	// A display name for the dataset.
620	Name *string
621
622	// The list of columns after all transforms. These columns are available in
623	// templates, analyses, and dashboards.
624	OutputColumns []OutputColumn
625
626	// Declares the physical tables that are available in the underlying data sources.
627	PhysicalTableMap map[string]PhysicalTable
628
629	// The row-level security configuration for the dataset.
630	RowLevelPermissionDataSet *RowLevelPermissionDataSet
631}
632
633// Dataset configuration.
634type DataSetConfiguration struct {
635
636	// A structure containing the list of column group schemas.
637	ColumnGroupSchemaList []ColumnGroupSchema
638
639	// Dataset schema.
640	DataSetSchema *DataSetSchema
641
642	// Placeholder.
643	Placeholder *string
644}
645
646// Dataset reference.
647type DataSetReference struct {
648
649	// Dataset Amazon Resource Name (ARN).
650	//
651	// This member is required.
652	DataSetArn *string
653
654	// Dataset placeholder.
655	//
656	// This member is required.
657	DataSetPlaceholder *string
658}
659
660// Dataset schema.
661type DataSetSchema struct {
662
663	// A structure containing the list of column schemas.
664	ColumnSchemaList []ColumnSchema
665}
666
667// Dataset summary.
668type DataSetSummary struct {
669
670	// The Amazon Resource Name (ARN) of the dataset.
671	Arn *string
672
673	// A value that indicates if the dataset has column level permission configured.
674	ColumnLevelPermissionRulesApplied bool
675
676	// The time that this dataset was created.
677	CreatedTime *time.Time
678
679	// The ID of the dataset.
680	DataSetId *string
681
682	// A value that indicates whether you want to import the data into SPICE.
683	ImportMode DataSetImportMode
684
685	// The last time that this dataset was updated.
686	LastUpdatedTime *time.Time
687
688	// A display name for the dataset.
689	Name *string
690
691	// The row-level security configuration for the dataset.
692	RowLevelPermissionDataSet *RowLevelPermissionDataSet
693}
694
695// The structure of a data source.
696type DataSource struct {
697
698	// A set of alternate data source parameters that you want to share for the
699	// credentials stored with this data source. The credentials are applied in tandem
700	// with the data source parameters when you copy a data source by using a create or
701	// update request. The API operation compares the DataSourceParameters structure
702	// that's in the request with the structures in the AlternateDataSourceParameters
703	// allow list. If the structures are an exact match, the request is allowed to use
704	// the credentials from this existing data source. If the
705	// AlternateDataSourceParameters list is null, the Credentials originally used with
706	// this DataSourceParameters are automatically allowed.
707	AlternateDataSourceParameters []DataSourceParameters
708
709	// The Amazon Resource Name (ARN) of the data source.
710	Arn *string
711
712	// The time that this data source was created.
713	CreatedTime *time.Time
714
715	// The ID of the data source. This ID is unique per AWS Region for each AWS
716	// account.
717	DataSourceId *string
718
719	// The parameters that Amazon QuickSight uses to connect to your underlying source.
720	// This is a variant type structure. For this structure to be valid, only one of
721	// the attributes can be non-null.
722	DataSourceParameters DataSourceParameters
723
724	// Error information from the last update or the creation of the data source.
725	ErrorInfo *DataSourceErrorInfo
726
727	// The last time that this data source was updated.
728	LastUpdatedTime *time.Time
729
730	// A display name for the data source.
731	Name *string
732
733	// Secure Socket Layer (SSL) properties that apply when QuickSight connects to your
734	// underlying source.
735	SslProperties *SslProperties
736
737	// The HTTP status of the request.
738	Status ResourceStatus
739
740	// The type of the data source. This type indicates which database engine the data
741	// source connects to.
742	Type DataSourceType
743
744	// The VPC connection information. You need to use this parameter only when you
745	// want QuickSight to use a VPC connection when connecting to your underlying
746	// source.
747	VpcConnectionProperties *VpcConnectionProperties
748}
749
750// Data source credentials. This is a variant type structure. For this structure to
751// be valid, only one of the attributes can be non-null.
752type DataSourceCredentials struct {
753
754	// The Amazon Resource Name (ARN) of a data source that has the credential pair
755	// that you want to use. When CopySourceArn is not null, the credential pair from
756	// the data source in the ARN is used as the credentials for the
757	// DataSourceCredentials structure.
758	CopySourceArn *string
759
760	// Credential pair. For more information, see CredentialPair.
761	CredentialPair *CredentialPair
762}
763
764// Error information for the data source creation or update.
765type DataSourceErrorInfo struct {
766
767	// Error message.
768	Message *string
769
770	// Error type.
771	Type DataSourceErrorInfoType
772}
773
774// The parameters that Amazon QuickSight uses to connect to your underlying data
775// source. This is a variant type structure. For this structure to be valid, only
776// one of the attributes can be non-null.
777//
778// The following types satisfy this interface:
779//  DataSourceParametersMemberAmazonElasticsearchParameters
780//  DataSourceParametersMemberAthenaParameters
781//  DataSourceParametersMemberAuroraParameters
782//  DataSourceParametersMemberAuroraPostgreSqlParameters
783//  DataSourceParametersMemberAwsIotAnalyticsParameters
784//  DataSourceParametersMemberJiraParameters
785//  DataSourceParametersMemberMariaDbParameters
786//  DataSourceParametersMemberMySqlParameters
787//  DataSourceParametersMemberOracleParameters
788//  DataSourceParametersMemberPostgreSqlParameters
789//  DataSourceParametersMemberPrestoParameters
790//  DataSourceParametersMemberRdsParameters
791//  DataSourceParametersMemberRedshiftParameters
792//  DataSourceParametersMemberS3Parameters
793//  DataSourceParametersMemberServiceNowParameters
794//  DataSourceParametersMemberSnowflakeParameters
795//  DataSourceParametersMemberSparkParameters
796//  DataSourceParametersMemberSqlServerParameters
797//  DataSourceParametersMemberTeradataParameters
798//  DataSourceParametersMemberTwitterParameters
799type DataSourceParameters interface {
800	isDataSourceParameters()
801}
802
803// Amazon Elasticsearch Service parameters.
804type DataSourceParametersMemberAmazonElasticsearchParameters struct {
805	Value AmazonElasticsearchParameters
806}
807
808func (*DataSourceParametersMemberAmazonElasticsearchParameters) isDataSourceParameters() {}
809
810// Amazon Athena parameters.
811type DataSourceParametersMemberAthenaParameters struct {
812	Value AthenaParameters
813}
814
815func (*DataSourceParametersMemberAthenaParameters) isDataSourceParameters() {}
816
817// Amazon Aurora MySQL parameters.
818type DataSourceParametersMemberAuroraParameters struct {
819	Value AuroraParameters
820}
821
822func (*DataSourceParametersMemberAuroraParameters) isDataSourceParameters() {}
823
824// Aurora PostgreSQL parameters.
825type DataSourceParametersMemberAuroraPostgreSqlParameters struct {
826	Value AuroraPostgreSqlParameters
827}
828
829func (*DataSourceParametersMemberAuroraPostgreSqlParameters) isDataSourceParameters() {}
830
831// AWS IoT Analytics parameters.
832type DataSourceParametersMemberAwsIotAnalyticsParameters struct {
833	Value AwsIotAnalyticsParameters
834}
835
836func (*DataSourceParametersMemberAwsIotAnalyticsParameters) isDataSourceParameters() {}
837
838// Jira parameters.
839type DataSourceParametersMemberJiraParameters struct {
840	Value JiraParameters
841}
842
843func (*DataSourceParametersMemberJiraParameters) isDataSourceParameters() {}
844
845// MariaDB parameters.
846type DataSourceParametersMemberMariaDbParameters struct {
847	Value MariaDbParameters
848}
849
850func (*DataSourceParametersMemberMariaDbParameters) isDataSourceParameters() {}
851
852// MySQL parameters.
853type DataSourceParametersMemberMySqlParameters struct {
854	Value MySqlParameters
855}
856
857func (*DataSourceParametersMemberMySqlParameters) isDataSourceParameters() {}
858
859// Oracle parameters.
860type DataSourceParametersMemberOracleParameters struct {
861	Value OracleParameters
862}
863
864func (*DataSourceParametersMemberOracleParameters) isDataSourceParameters() {}
865
866// PostgreSQL parameters.
867type DataSourceParametersMemberPostgreSqlParameters struct {
868	Value PostgreSqlParameters
869}
870
871func (*DataSourceParametersMemberPostgreSqlParameters) isDataSourceParameters() {}
872
873// Presto parameters.
874type DataSourceParametersMemberPrestoParameters struct {
875	Value PrestoParameters
876}
877
878func (*DataSourceParametersMemberPrestoParameters) isDataSourceParameters() {}
879
880// Amazon RDS parameters.
881type DataSourceParametersMemberRdsParameters struct {
882	Value RdsParameters
883}
884
885func (*DataSourceParametersMemberRdsParameters) isDataSourceParameters() {}
886
887// Amazon Redshift parameters.
888type DataSourceParametersMemberRedshiftParameters struct {
889	Value RedshiftParameters
890}
891
892func (*DataSourceParametersMemberRedshiftParameters) isDataSourceParameters() {}
893
894// S3 parameters.
895type DataSourceParametersMemberS3Parameters struct {
896	Value S3Parameters
897}
898
899func (*DataSourceParametersMemberS3Parameters) isDataSourceParameters() {}
900
901// ServiceNow parameters.
902type DataSourceParametersMemberServiceNowParameters struct {
903	Value ServiceNowParameters
904}
905
906func (*DataSourceParametersMemberServiceNowParameters) isDataSourceParameters() {}
907
908// Snowflake parameters.
909type DataSourceParametersMemberSnowflakeParameters struct {
910	Value SnowflakeParameters
911}
912
913func (*DataSourceParametersMemberSnowflakeParameters) isDataSourceParameters() {}
914
915// Spark parameters.
916type DataSourceParametersMemberSparkParameters struct {
917	Value SparkParameters
918}
919
920func (*DataSourceParametersMemberSparkParameters) isDataSourceParameters() {}
921
922// SQL Server parameters.
923type DataSourceParametersMemberSqlServerParameters struct {
924	Value SqlServerParameters
925}
926
927func (*DataSourceParametersMemberSqlServerParameters) isDataSourceParameters() {}
928
929// Teradata parameters.
930type DataSourceParametersMemberTeradataParameters struct {
931	Value TeradataParameters
932}
933
934func (*DataSourceParametersMemberTeradataParameters) isDataSourceParameters() {}
935
936// Twitter parameters.
937type DataSourceParametersMemberTwitterParameters struct {
938	Value TwitterParameters
939}
940
941func (*DataSourceParametersMemberTwitterParameters) isDataSourceParameters() {}
942
943// A date-time parameter.
944type DateTimeParameter struct {
945
946	// A display name for the date-time parameter.
947	//
948	// This member is required.
949	Name *string
950
951	// The values for the date-time parameter.
952	//
953	// This member is required.
954	Values []time.Time
955}
956
957// A decimal parameter.
958type DecimalParameter struct {
959
960	// A display name for the decimal parameter.
961	//
962	// This member is required.
963	Name *string
964
965	// The values for the decimal parameter.
966	//
967	// This member is required.
968	Values []float64
969}
970
971// Error information for the SPICE ingestion of a dataset.
972type ErrorInfo struct {
973
974	// Error message.
975	Message *string
976
977	// Error type.
978	Type IngestionErrorType
979}
980
981// Export to .csv option.
982type ExportToCSVOption struct {
983
984	// Availability status.
985	AvailabilityStatus DashboardBehavior
986}
987
988// A FieldFolder element is a folder that contains fields and nested subfolders.
989type FieldFolder struct {
990
991	// A folder has a list of columns. A column can only be in one folder.
992	Columns []string
993
994	// The description for a field folder.
995	Description *string
996}
997
998// A transform operation that filters rows based on a condition.
999type FilterOperation struct {
1000
1001	// An expression that must evaluate to a Boolean value. Rows for which the
1002	// expression evaluates to true are kept in the dataset.
1003	//
1004	// This member is required.
1005	ConditionExpression *string
1006}
1007
1008// Geospatial column group that denotes a hierarchy.
1009type GeoSpatialColumnGroup struct {
1010
1011	// Columns in this hierarchy.
1012	//
1013	// This member is required.
1014	Columns []string
1015
1016	// Country code.
1017	//
1018	// This member is required.
1019	CountryCode GeoSpatialCountryCode
1020
1021	// A display name for the hierarchy.
1022	//
1023	// This member is required.
1024	Name *string
1025}
1026
1027// A group in Amazon QuickSight consists of a set of users. You can use groups to
1028// make it easier to manage access and security.
1029type Group struct {
1030
1031	// The Amazon Resource Name (ARN) for the group.
1032	Arn *string
1033
1034	// The group description.
1035	Description *string
1036
1037	// The name of the group.
1038	GroupName *string
1039
1040	// The principal ID of the group.
1041	PrincipalId *string
1042}
1043
1044// A member of an Amazon QuickSight group. Currently, group members must be users.
1045// Groups can't be members of another group. .
1046type GroupMember struct {
1047
1048	// The Amazon Resource Name (ARN) for the group member (user).
1049	Arn *string
1050
1051	// The name of the group member (user).
1052	MemberName *string
1053}
1054
1055// The display options for gutter spacing between tiles on a sheet.
1056type GutterStyle struct {
1057
1058	// This Boolean value controls whether to display a gutter space between sheet
1059	// tiles.
1060	Show bool
1061}
1062
1063// An AWS Identity and Access Management (IAM) policy assignment.
1064type IAMPolicyAssignment struct {
1065
1066	// Assignment ID.
1067	AssignmentId *string
1068
1069	// Assignment name.
1070	AssignmentName *string
1071
1072	// Assignment status.
1073	AssignmentStatus AssignmentStatus
1074
1075	// The AWS account ID.
1076	AwsAccountId *string
1077
1078	// Identities.
1079	Identities map[string][]string
1080
1081	// The Amazon Resource Name (ARN) for the IAM policy.
1082	PolicyArn *string
1083}
1084
1085// IAM policy assignment summary.
1086type IAMPolicyAssignmentSummary struct {
1087
1088	// Assignment name.
1089	AssignmentName *string
1090
1091	// Assignment status.
1092	AssignmentStatus AssignmentStatus
1093}
1094
1095// Information about the SPICE ingestion for a dataset.
1096type Ingestion struct {
1097
1098	// The Amazon Resource Name (ARN) of the resource.
1099	//
1100	// This member is required.
1101	Arn *string
1102
1103	// The time that this ingestion started.
1104	//
1105	// This member is required.
1106	CreatedTime *time.Time
1107
1108	// Ingestion status.
1109	//
1110	// This member is required.
1111	IngestionStatus IngestionStatus
1112
1113	// Error information for this ingestion.
1114	ErrorInfo *ErrorInfo
1115
1116	// Ingestion ID.
1117	IngestionId *string
1118
1119	// The size of the data ingested, in bytes.
1120	IngestionSizeInBytes int64
1121
1122	// The time that this ingestion took, measured in seconds.
1123	IngestionTimeInSeconds int64
1124
1125	// Information about a queued dataset SPICE ingestion.
1126	QueueInfo *QueueInfo
1127
1128	// Event source for this ingestion.
1129	RequestSource IngestionRequestSource
1130
1131	// Type of this ingestion.
1132	RequestType IngestionRequestType
1133
1134	// Information about rows for a data set SPICE ingestion.
1135	RowInfo *RowInfo
1136}
1137
1138// Metadata for a column that is used as the input of a transform operation.
1139type InputColumn struct {
1140
1141	// The name of this column in the underlying data source.
1142	//
1143	// This member is required.
1144	Name *string
1145
1146	// The data type of the column.
1147	//
1148	// This member is required.
1149	Type InputColumnDataType
1150}
1151
1152// An integer parameter.
1153type IntegerParameter struct {
1154
1155	// The name of the integer parameter.
1156	//
1157	// This member is required.
1158	Name *string
1159
1160	// The values for the integer parameter.
1161	//
1162	// This member is required.
1163	Values []int64
1164}
1165
1166// Jira parameters.
1167type JiraParameters struct {
1168
1169	// The base URL of the Jira site.
1170	//
1171	// This member is required.
1172	SiteBaseUrl *string
1173}
1174
1175// The instructions associated with a join.
1176type JoinInstruction struct {
1177
1178	// The operand on the left side of a join.
1179	//
1180	// This member is required.
1181	LeftOperand *string
1182
1183	// The join instructions provided in the ON clause of a join.
1184	//
1185	// This member is required.
1186	OnClause *string
1187
1188	// The operand on the right side of a join.
1189	//
1190	// This member is required.
1191	RightOperand *string
1192
1193	// The type of join that it is.
1194	//
1195	// This member is required.
1196	Type JoinType
1197
1198	// Join key properties of the left operand.
1199	LeftJoinKeyProperties *JoinKeyProperties
1200
1201	// Join key properties of the right operand.
1202	RightJoinKeyProperties *JoinKeyProperties
1203}
1204
1205// Properties associated with the columns participating in a join.
1206type JoinKeyProperties struct {
1207
1208	// A value that indicates that a row in a table is uniquely identified by the
1209	// columns in a join key. This is used by QuickSight to optimize query performance.
1210	UniqueKey bool
1211}
1212
1213// A logical table is a unit that joins and that data transformations operate on. A
1214// logical table has a source, which can be either a physical table or result of a
1215// join. When a logical table points to a physical table, the logical table acts as
1216// a mutable copy of that physical table through transform operations.
1217type LogicalTable struct {
1218
1219	// A display name for the logical table.
1220	//
1221	// This member is required.
1222	Alias *string
1223
1224	// Source of this logical table.
1225	//
1226	// This member is required.
1227	Source *LogicalTableSource
1228
1229	// Transform operations that act on this logical table.
1230	DataTransforms []TransformOperation
1231}
1232
1233// Information about the source of a logical table. This is a variant type
1234// structure. For this structure to be valid, only one of the attributes can be
1235// non-null.
1236type LogicalTableSource struct {
1237
1238	// Specifies the result of a join of two logical tables.
1239	JoinInstruction *JoinInstruction
1240
1241	// Physical table ID.
1242	PhysicalTableId *string
1243}
1244
1245// Amazon S3 manifest file location.
1246type ManifestFileLocation struct {
1247
1248	// Amazon S3 bucket.
1249	//
1250	// This member is required.
1251	Bucket *string
1252
1253	// Amazon S3 key that identifies an object.
1254	//
1255	// This member is required.
1256	Key *string
1257}
1258
1259// The display options for margins around the outside edge of sheets.
1260type MarginStyle struct {
1261
1262	// This Boolean value controls whether to display sheet margins.
1263	Show bool
1264}
1265
1266// MariaDB parameters.
1267type MariaDbParameters struct {
1268
1269	// Database.
1270	//
1271	// This member is required.
1272	Database *string
1273
1274	// Host.
1275	//
1276	// This member is required.
1277	Host *string
1278
1279	// Port.
1280	//
1281	// This member is required.
1282	Port int32
1283}
1284
1285// MySQL parameters.
1286type MySqlParameters struct {
1287
1288	// Database.
1289	//
1290	// This member is required.
1291	Database *string
1292
1293	// Host.
1294	//
1295	// This member is required.
1296	Host *string
1297
1298	// Port.
1299	//
1300	// This member is required.
1301	Port int32
1302}
1303
1304// Errors that occur during namespace creation.
1305type NamespaceError struct {
1306
1307	// The message for the error.
1308	Message *string
1309
1310	// The error type.
1311	Type NamespaceErrorType
1312}
1313
1314// The error type.
1315type NamespaceInfoV2 struct {
1316
1317	// The namespace ARN.
1318	Arn *string
1319
1320	// The namespace AWS Region.
1321	CapacityRegion *string
1322
1323	// The creation status of a namespace that is not yet completely created.
1324	CreationStatus NamespaceStatus
1325
1326	// The identity store used for the namespace.
1327	IdentityStore IdentityStore
1328
1329	// The name of the error.
1330	Name *string
1331
1332	// An error that occurred when the namespace was created.
1333	NamespaceError *NamespaceError
1334}
1335
1336// Oracle parameters.
1337type OracleParameters struct {
1338
1339	// Database.
1340	//
1341	// This member is required.
1342	Database *string
1343
1344	// An Oracle host.
1345	//
1346	// This member is required.
1347	Host *string
1348
1349	// Port.
1350	//
1351	// This member is required.
1352	Port int32
1353}
1354
1355// Output column.
1356type OutputColumn struct {
1357
1358	// A description for a column.
1359	Description *string
1360
1361	// A display name for the dataset.
1362	Name *string
1363
1364	// Type.
1365	Type ColumnDataType
1366}
1367
1368// A list of QuickSight parameters and the list's override values.
1369type Parameters struct {
1370
1371	// Date-time parameters.
1372	DateTimeParameters []DateTimeParameter
1373
1374	// Decimal parameters.
1375	DecimalParameters []DecimalParameter
1376
1377	// Integer parameters.
1378	IntegerParameters []IntegerParameter
1379
1380	// String parameters.
1381	StringParameters []StringParameter
1382}
1383
1384// A view of a data source that contains information about the shape of the data in
1385// the underlying source. This is a variant type structure. For this structure to
1386// be valid, only one of the attributes can be non-null.
1387//
1388// The following types satisfy this interface:
1389//  PhysicalTableMemberRelationalTable
1390//  PhysicalTableMemberCustomSql
1391//  PhysicalTableMemberS3Source
1392type PhysicalTable interface {
1393	isPhysicalTable()
1394}
1395
1396// A physical table type for relational data sources.
1397type PhysicalTableMemberRelationalTable struct {
1398	Value RelationalTable
1399}
1400
1401func (*PhysicalTableMemberRelationalTable) isPhysicalTable() {}
1402
1403// A physical table type built from the results of the custom SQL query.
1404type PhysicalTableMemberCustomSql struct {
1405	Value CustomSql
1406}
1407
1408func (*PhysicalTableMemberCustomSql) isPhysicalTable() {}
1409
1410// A physical table type for as S3 data source.
1411type PhysicalTableMemberS3Source struct {
1412	Value S3Source
1413}
1414
1415func (*PhysicalTableMemberS3Source) isPhysicalTable() {}
1416
1417// PostgreSQL parameters.
1418type PostgreSqlParameters struct {
1419
1420	// Database.
1421	//
1422	// This member is required.
1423	Database *string
1424
1425	// Host.
1426	//
1427	// This member is required.
1428	Host *string
1429
1430	// Port.
1431	//
1432	// This member is required.
1433	Port int32
1434}
1435
1436// Presto parameters.
1437type PrestoParameters struct {
1438
1439	// Catalog.
1440	//
1441	// This member is required.
1442	Catalog *string
1443
1444	// Host.
1445	//
1446	// This member is required.
1447	Host *string
1448
1449	// Port.
1450	//
1451	// This member is required.
1452	Port int32
1453}
1454
1455// A transform operation that projects columns. Operations that come after a
1456// projection can only refer to projected columns.
1457type ProjectOperation struct {
1458
1459	// Projected columns.
1460	//
1461	// This member is required.
1462	ProjectedColumns []string
1463}
1464
1465// Information about a queued dataset SPICE ingestion.
1466type QueueInfo struct {
1467
1468	// The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing
1469	// ingestion to complete.
1470	//
1471	// This member is required.
1472	QueuedIngestion *string
1473
1474	// The ID of the queued ingestion.
1475	//
1476	// This member is required.
1477	WaitingOnIngestion *string
1478}
1479
1480// Amazon RDS parameters.
1481type RdsParameters struct {
1482
1483	// Database.
1484	//
1485	// This member is required.
1486	Database *string
1487
1488	// Instance ID.
1489	//
1490	// This member is required.
1491	InstanceId *string
1492}
1493
1494// Amazon Redshift parameters. The ClusterId field can be blank if Host and Port
1495// are both set. The Host and Port fields can be blank if the ClusterId field is
1496// set.
1497type RedshiftParameters struct {
1498
1499	// Database.
1500	//
1501	// This member is required.
1502	Database *string
1503
1504	// Cluster ID. This field can be blank if the Host and Port are provided.
1505	ClusterId *string
1506
1507	// Host. This field can be blank if ClusterId is provided.
1508	Host *string
1509
1510	// Port. This field can be blank if the ClusterId is provided.
1511	Port int32
1512}
1513
1514// A physical table type for relational data sources.
1515type RelationalTable struct {
1516
1517	// The Amazon Resource Name (ARN) for the data source.
1518	//
1519	// This member is required.
1520	DataSourceArn *string
1521
1522	// The column schema of the table.
1523	//
1524	// This member is required.
1525	InputColumns []InputColumn
1526
1527	// The name of the relational table.
1528	//
1529	// This member is required.
1530	Name *string
1531
1532	// The catalog associated with a table.
1533	Catalog *string
1534
1535	// The schema name. This name applies to certain relational database engines.
1536	Schema *string
1537}
1538
1539// A transform operation that renames a column.
1540type RenameColumnOperation struct {
1541
1542	// The name of the column to be renamed.
1543	//
1544	// This member is required.
1545	ColumnName *string
1546
1547	// The new name for the column.
1548	//
1549	// This member is required.
1550	NewColumnName *string
1551}
1552
1553// Permission for the resource.
1554type ResourcePermission struct {
1555
1556	// The IAM action to grant or revoke permissions on.
1557	//
1558	// This member is required.
1559	Actions []string
1560
1561	// The Amazon Resource Name (ARN) of the principal. This can be one of the
1562	// following:
1563	//
1564	// * The ARN of an Amazon QuickSight user or group associated with a
1565	// data source or dataset. (This is common.)
1566	//
1567	// * The ARN of an Amazon QuickSight
1568	// user, group, or namespace associated with an analysis, dashboard, template, or
1569	// theme. (This is common.)
1570	//
1571	// * The ARN of an AWS account root: This is an IAM ARN
1572	// rather than a QuickSight ARN. Use this option only to share resources
1573	// (templates) across AWS accounts. (This is less common.)
1574	//
1575	// This member is required.
1576	Principal *string
1577}
1578
1579// Information about rows for a data set SPICE ingestion.
1580type RowInfo struct {
1581
1582	// The number of rows that were not ingested.
1583	RowsDropped int64
1584
1585	// The number of rows that were ingested.
1586	RowsIngested int64
1587}
1588
1589// Information about a dataset that contains permissions for row-level security
1590// (RLS). The permissions dataset maps fields to users or groups. For more
1591// information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset
1592// (https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html)
1593// in the Amazon QuickSight User Guide. The option to deny permissions by setting
1594// PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
1595type RowLevelPermissionDataSet struct {
1596
1597	// The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
1598	//
1599	// This member is required.
1600	Arn *string
1601
1602	// The type of permissions to use when interpretting the permissions for RLS.
1603	// DENY_ACCESS is included for backward compatibility only.
1604	//
1605	// This member is required.
1606	PermissionPolicy RowLevelPermissionPolicy
1607
1608	// The namespace associated with the dataset that contains permissions for RLS.
1609	Namespace *string
1610}
1611
1612// S3 parameters.
1613type S3Parameters struct {
1614
1615	// Location of the Amazon S3 manifest file. This is NULL if the manifest file was
1616	// uploaded in the console.
1617	//
1618	// This member is required.
1619	ManifestFileLocation *ManifestFileLocation
1620}
1621
1622// A physical table type for as S3 data source.
1623type S3Source struct {
1624
1625	// The Amazon Resource Name (ARN) for the data source.
1626	//
1627	// This member is required.
1628	DataSourceArn *string
1629
1630	// A physical table type for as S3 data source.
1631	//
1632	// This member is required.
1633	InputColumns []InputColumn
1634
1635	// Information about the format for the S3 source file or files.
1636	UploadSettings *UploadSettings
1637}
1638
1639// ServiceNow parameters.
1640type ServiceNowParameters struct {
1641
1642	// URL of the base site.
1643	//
1644	// This member is required.
1645	SiteBaseUrl *string
1646}
1647
1648// A sheet, which is an object that contains a set of visuals that are viewed
1649// together on one page in the Amazon QuickSight console. Every analysis and
1650// dashboard contains at least one sheet. Each sheet contains at least one
1651// visualization widget, for example a chart, pivot table, or narrative insight.
1652// Sheets can be associated with other components, such as controls, filters, and
1653// so on.
1654type Sheet struct {
1655
1656	// The name of a sheet. This name is displayed on the sheet's tab in the QuickSight
1657	// console.
1658	Name *string
1659
1660	// The unique identifier associated with a sheet.
1661	SheetId *string
1662}
1663
1664// Sheet controls option.
1665type SheetControlsOption struct {
1666
1667	// Visibility state.
1668	VisibilityState DashboardUIState
1669}
1670
1671// The theme display options for sheets.
1672type SheetStyle struct {
1673
1674	// The display options for tiles.
1675	Tile *TileStyle
1676
1677	// The layout options for tiles.
1678	TileLayout *TileLayoutStyle
1679}
1680
1681// Snowflake parameters.
1682type SnowflakeParameters struct {
1683
1684	// Database.
1685	//
1686	// This member is required.
1687	Database *string
1688
1689	// Host.
1690	//
1691	// This member is required.
1692	Host *string
1693
1694	// Warehouse.
1695	//
1696	// This member is required.
1697	Warehouse *string
1698}
1699
1700// Spark parameters.
1701type SparkParameters struct {
1702
1703	// Host.
1704	//
1705	// This member is required.
1706	Host *string
1707
1708	// Port.
1709	//
1710	// This member is required.
1711	Port int32
1712}
1713
1714// SQL Server parameters.
1715type SqlServerParameters struct {
1716
1717	// Database.
1718	//
1719	// This member is required.
1720	Database *string
1721
1722	// Host.
1723	//
1724	// This member is required.
1725	Host *string
1726
1727	// Port.
1728	//
1729	// This member is required.
1730	Port int32
1731}
1732
1733// Secure Socket Layer (SSL) properties that apply when QuickSight connects to your
1734// underlying data source.
1735type SslProperties struct {
1736
1737	// A Boolean option to control whether SSL should be disabled.
1738	DisableSsl bool
1739}
1740
1741// A string parameter.
1742type StringParameter struct {
1743
1744	// A display name for a string parameter.
1745	//
1746	// This member is required.
1747	Name *string
1748
1749	// The values of a string parameter.
1750	//
1751	// This member is required.
1752	Values []string
1753}
1754
1755// The key or keys of the key-value pairs for the resource tag or tags assigned to
1756// the resource.
1757type Tag struct {
1758
1759	// Tag key.
1760	//
1761	// This member is required.
1762	Key *string
1763
1764	// Tag value.
1765	//
1766	// This member is required.
1767	Value *string
1768}
1769
1770// A transform operation that tags a column with additional information.
1771type TagColumnOperation struct {
1772
1773	// The column that this operation acts on.
1774	//
1775	// This member is required.
1776	ColumnName *string
1777
1778	// The dataset column tag, currently only used for geospatial type tagging. . This
1779	// is not tags for the AWS tagging feature. .
1780	//
1781	// This member is required.
1782	Tags []ColumnTag
1783}
1784
1785// A template object. A template is an entity in QuickSight that encapsulates the
1786// metadata required to create an analysis and that you can use to create a
1787// dashboard. A template adds a layer of abstraction by using placeholders to
1788// replace the dataset associated with an analysis. You can use templates to create
1789// dashboards by replacing dataset placeholders with datasets that follow the same
1790// schema that was used to create the source analysis and template. You can share
1791// templates across AWS accounts by allowing users in other AWS accounts to create
1792// a template or a dashboard from an existing template.
1793type Template struct {
1794
1795	// The Amazon Resource Name (ARN) of the template.
1796	Arn *string
1797
1798	// Time when this was created.
1799	CreatedTime *time.Time
1800
1801	// Time when this was last updated.
1802	LastUpdatedTime *time.Time
1803
1804	// The display name of the template.
1805	Name *string
1806
1807	// The ID for the template. This is unique per AWS Region for each AWS account.
1808	TemplateId *string
1809
1810	// A structure describing the versions of the template.
1811	Version *TemplateVersion
1812}
1813
1814// The template alias.
1815type TemplateAlias struct {
1816
1817	// The display name of the template alias.
1818	AliasName *string
1819
1820	// The Amazon Resource Name (ARN) of the template alias.
1821	Arn *string
1822
1823	// The version number of the template alias.
1824	TemplateVersionNumber *int64
1825}
1826
1827// List of errors that occurred when the template version creation failed.
1828type TemplateError struct {
1829
1830	// Description of the error type.
1831	Message *string
1832
1833	// Type of error.
1834	Type TemplateErrorType
1835}
1836
1837// The source analysis of the template.
1838type TemplateSourceAnalysis struct {
1839
1840	// The Amazon Resource Name (ARN) of the resource.
1841	//
1842	// This member is required.
1843	Arn *string
1844
1845	// A structure containing information about the dataset references used as
1846	// placeholders in the template.
1847	//
1848	// This member is required.
1849	DataSetReferences []DataSetReference
1850}
1851
1852// The source entity of the template.
1853type TemplateSourceEntity struct {
1854
1855	// The source analysis, if it is based on an analysis.
1856	SourceAnalysis *TemplateSourceAnalysis
1857
1858	// The source template, if it is based on an template.
1859	SourceTemplate *TemplateSourceTemplate
1860}
1861
1862// The source template of the template.
1863type TemplateSourceTemplate struct {
1864
1865	// The Amazon Resource Name (ARN) of the resource.
1866	//
1867	// This member is required.
1868	Arn *string
1869}
1870
1871// The template summary.
1872type TemplateSummary struct {
1873
1874	// A summary of a template.
1875	Arn *string
1876
1877	// The last time that this template was created.
1878	CreatedTime *time.Time
1879
1880	// The last time that this template was updated.
1881	LastUpdatedTime *time.Time
1882
1883	// A structure containing a list of version numbers for the template summary.
1884	LatestVersionNumber *int64
1885
1886	// A display name for the template.
1887	Name *string
1888
1889	// The ID of the template. This ID is unique per AWS Region for each AWS account.
1890	TemplateId *string
1891}
1892
1893// A version of a template.
1894type TemplateVersion struct {
1895
1896	// The time that this template version was created.
1897	CreatedTime *time.Time
1898
1899	// Schema of the dataset identified by the placeholder. Any dashboard created from
1900	// this template should be bound to new datasets matching the same schema described
1901	// through this API operation.
1902	DataSetConfigurations []DataSetConfiguration
1903
1904	// The description of the template.
1905	Description *string
1906
1907	// Errors associated with this template version.
1908	Errors []TemplateError
1909
1910	// A list of the associated sheets with the unique identifier and name of each
1911	// sheet.
1912	Sheets []Sheet
1913
1914	// The Amazon Resource Name (ARN) of an analysis or template that was used to
1915	// create this template.
1916	SourceEntityArn *string
1917
1918	// The HTTP status of the request.
1919	Status ResourceStatus
1920
1921	// The ARN of the theme associated with this version of the template.
1922	ThemeArn *string
1923
1924	// The version number of the template version.
1925	VersionNumber *int64
1926}
1927
1928// The template version.
1929type TemplateVersionSummary struct {
1930
1931	// The Amazon Resource Name (ARN) of the template version.
1932	Arn *string
1933
1934	// The time that this template version was created.
1935	CreatedTime *time.Time
1936
1937	// The description of the template version.
1938	Description *string
1939
1940	// The status of the template version.
1941	Status ResourceStatus
1942
1943	// The version number of the template version.
1944	VersionNumber *int64
1945}
1946
1947// Teradata parameters.
1948type TeradataParameters struct {
1949
1950	// Database.
1951	//
1952	// This member is required.
1953	Database *string
1954
1955	// Host.
1956	//
1957	// This member is required.
1958	Host *string
1959
1960	// Port.
1961	//
1962	// This member is required.
1963	Port int32
1964}
1965
1966// Summary information about a theme.
1967type Theme struct {
1968
1969	// The Amazon Resource Name (ARN) of the theme.
1970	Arn *string
1971
1972	// The date and time that the theme was created.
1973	CreatedTime *time.Time
1974
1975	// The date and time that the theme was last updated.
1976	LastUpdatedTime *time.Time
1977
1978	// The name that the user gives to the theme.
1979	Name *string
1980
1981	// The identifier that the user gives to the theme.
1982	ThemeId *string
1983
1984	// The type of theme, based on how it was created. Valid values include: QUICKSIGHT
1985	// and CUSTOM.
1986	Type ThemeType
1987
1988	// A version of a theme.
1989	Version *ThemeVersion
1990}
1991
1992// An alias for a theme.
1993type ThemeAlias struct {
1994
1995	// The display name of the theme alias.
1996	AliasName *string
1997
1998	// The Amazon Resource Name (ARN) of the theme alias.
1999	Arn *string
2000
2001	// The version number of the theme alias.
2002	ThemeVersionNumber *int64
2003}
2004
2005// The theme configuration. This configuration contains all of the display
2006// properties for a theme.
2007type ThemeConfiguration struct {
2008
2009	// Color properties that apply to chart data colors.
2010	DataColorPalette *DataColorPalette
2011
2012	// Display options related to sheets.
2013	Sheet *SheetStyle
2014
2015	// Color properties that apply to the UI and to charts, excluding the colors that
2016	// apply to data.
2017	UIColorPalette *UIColorPalette
2018}
2019
2020// Theme error.
2021type ThemeError struct {
2022
2023	// The error message.
2024	Message *string
2025
2026	// The type of error.
2027	Type ThemeErrorType
2028}
2029
2030// The theme summary.
2031type ThemeSummary struct {
2032
2033	// The Amazon Resource Name (ARN) of the resource.
2034	Arn *string
2035
2036	// The date and time that this theme was created.
2037	CreatedTime *time.Time
2038
2039	// The last date and time that this theme was updated.
2040	LastUpdatedTime *time.Time
2041
2042	// The latest version number for the theme.
2043	LatestVersionNumber *int64
2044
2045	// the display name for the theme.
2046	Name *string
2047
2048	// The ID of the theme. This ID is unique per AWS Region for each AWS account.
2049	ThemeId *string
2050}
2051
2052// A version of a theme.
2053type ThemeVersion struct {
2054
2055	// The Amazon Resource Name (ARN) of the resource.
2056	Arn *string
2057
2058	// The Amazon QuickSight-defined ID of the theme that a custom theme inherits from.
2059	// All themes initially inherit from a default QuickSight theme.
2060	BaseThemeId *string
2061
2062	// The theme configuration, which contains all the theme display properties.
2063	Configuration *ThemeConfiguration
2064
2065	// The date and time that this theme version was created.
2066	CreatedTime *time.Time
2067
2068	// The description of the theme.
2069	Description *string
2070
2071	// Errors associated with the theme.
2072	Errors []ThemeError
2073
2074	// The status of the theme version.
2075	Status ResourceStatus
2076
2077	// The version number of the theme.
2078	VersionNumber *int64
2079}
2080
2081// The theme version.
2082type ThemeVersionSummary struct {
2083
2084	// The Amazon Resource Name (ARN) of the theme version.
2085	Arn *string
2086
2087	// The date and time that this theme version was created.
2088	CreatedTime *time.Time
2089
2090	// The description of the theme version.
2091	Description *string
2092
2093	// The status of the theme version.
2094	Status ResourceStatus
2095
2096	// The version number of the theme version.
2097	VersionNumber *int64
2098}
2099
2100// The display options for the layout of tiles on a sheet.
2101type TileLayoutStyle struct {
2102
2103	// The gutter settings that apply between tiles.
2104	Gutter *GutterStyle
2105
2106	// The margin settings that apply around the outside edge of sheets.
2107	Margin *MarginStyle
2108}
2109
2110// Display options related to tiles on a sheet.
2111type TileStyle struct {
2112
2113	// The border around a tile.
2114	Border *BorderStyle
2115}
2116
2117// A data transformation on a logical table. This is a variant type structure. For
2118// this structure to be valid, only one of the attributes can be non-null.
2119//
2120// The following types satisfy this interface:
2121//  TransformOperationMemberProjectOperation
2122//  TransformOperationMemberFilterOperation
2123//  TransformOperationMemberCreateColumnsOperation
2124//  TransformOperationMemberRenameColumnOperation
2125//  TransformOperationMemberCastColumnTypeOperation
2126//  TransformOperationMemberTagColumnOperation
2127type TransformOperation interface {
2128	isTransformOperation()
2129}
2130
2131// An operation that projects columns. Operations that come after a projection can
2132// only refer to projected columns.
2133type TransformOperationMemberProjectOperation struct {
2134	Value ProjectOperation
2135}
2136
2137func (*TransformOperationMemberProjectOperation) isTransformOperation() {}
2138
2139// An operation that filters rows based on some condition.
2140type TransformOperationMemberFilterOperation struct {
2141	Value FilterOperation
2142}
2143
2144func (*TransformOperationMemberFilterOperation) isTransformOperation() {}
2145
2146// An operation that creates calculated columns. Columns created in one such
2147// operation form a lexical closure.
2148type TransformOperationMemberCreateColumnsOperation struct {
2149	Value CreateColumnsOperation
2150}
2151
2152func (*TransformOperationMemberCreateColumnsOperation) isTransformOperation() {}
2153
2154// An operation that renames a column.
2155type TransformOperationMemberRenameColumnOperation struct {
2156	Value RenameColumnOperation
2157}
2158
2159func (*TransformOperationMemberRenameColumnOperation) isTransformOperation() {}
2160
2161// A transform operation that casts a column to a different type.
2162type TransformOperationMemberCastColumnTypeOperation struct {
2163	Value CastColumnTypeOperation
2164}
2165
2166func (*TransformOperationMemberCastColumnTypeOperation) isTransformOperation() {}
2167
2168// An operation that tags a column with additional information.
2169type TransformOperationMemberTagColumnOperation struct {
2170	Value TagColumnOperation
2171}
2172
2173func (*TransformOperationMemberTagColumnOperation) isTransformOperation() {}
2174
2175// Twitter parameters.
2176type TwitterParameters struct {
2177
2178	// Maximum number of rows to query Twitter.
2179	//
2180	// This member is required.
2181	MaxRows int32
2182
2183	// Twitter query string.
2184	//
2185	// This member is required.
2186	Query *string
2187}
2188
2189// The theme colors that apply to UI and to charts, excluding data colors. The
2190// colors description is a hexadecimal color code that consists of six
2191// alphanumerical characters, prefixed with #, for example #37BFF5. For more
2192// information, see Using Themes in Amazon QuickSight
2193// (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html)
2194// in the Amazon QuickSight User Guide.
2195type UIColorPalette struct {
2196
2197	// This color is that applies to selected states and buttons.
2198	Accent *string
2199
2200	// The foreground color that applies to any text or other elements that appear over
2201	// the accent color.
2202	AccentForeground *string
2203
2204	// The color that applies to error messages.
2205	Danger *string
2206
2207	// The foreground color that applies to any text or other elements that appear over
2208	// the error color.
2209	DangerForeground *string
2210
2211	// The color that applies to the names of fields that are identified as dimensions.
2212	Dimension *string
2213
2214	// The foreground color that applies to any text or other elements that appear over
2215	// the dimension color.
2216	DimensionForeground *string
2217
2218	// The color that applies to the names of fields that are identified as measures.
2219	Measure *string
2220
2221	// The foreground color that applies to any text or other elements that appear over
2222	// the measure color.
2223	MeasureForeground *string
2224
2225	// The background color that applies to visuals and other high emphasis UI.
2226	PrimaryBackground *string
2227
2228	// The color of text and other foreground elements that appear over the primary
2229	// background regions, such as grid lines, borders, table banding, icons, and so
2230	// on.
2231	PrimaryForeground *string
2232
2233	// The background color that applies to the sheet background and sheet controls.
2234	SecondaryBackground *string
2235
2236	// The foreground color that applies to any sheet title, sheet control text, or UI
2237	// that appears over the secondary background.
2238	SecondaryForeground *string
2239
2240	// The color that applies to success messages, for example the check mark for a
2241	// successful download.
2242	Success *string
2243
2244	// The foreground color that applies to any text or other elements that appear over
2245	// the success color.
2246	SuccessForeground *string
2247
2248	// This color that applies to warning and informational messages.
2249	Warning *string
2250
2251	// The foreground color that applies to any text or other elements that appear over
2252	// the warning color.
2253	WarningForeground *string
2254}
2255
2256// Information about the format for a source file or files.
2257type UploadSettings struct {
2258
2259	// Whether the file has a header row, or the files each have a header row.
2260	ContainsHeader bool
2261
2262	// The delimiter between values in the file.
2263	Delimiter *string
2264
2265	// File format.
2266	Format FileFormat
2267
2268	// A row number to start reading data from.
2269	StartFromRow int32
2270
2271	// Text qualifier.
2272	TextQualifier TextQualifier
2273}
2274
2275// A registered user of Amazon QuickSight.
2276type User struct {
2277
2278	// The active status of user. When you create an Amazon QuickSight user that’s not
2279	// an IAM user or an Active Directory user, that user is inactive until they sign
2280	// in and provide a password.
2281	Active bool
2282
2283	// The Amazon Resource Name (ARN) for the user.
2284	Arn *string
2285
2286	// The custom permissions profile associated with this user.
2287	CustomPermissionsName *string
2288
2289	// The user's email address.
2290	Email *string
2291
2292	// The type of identity authentication used by the user.
2293	IdentityType IdentityType
2294
2295	// The principal ID of the user.
2296	PrincipalId *string
2297
2298	// The Amazon QuickSight role for the user. The user role can be one of the
2299	// following:.
2300	//
2301	// * READER: A user who has read-only access to dashboards.
2302	//
2303	// * AUTHOR:
2304	// A user who can create data sources, datasets, analyses, and dashboards.
2305	//
2306	// *
2307	// ADMIN: A user who is an author, who can also manage Amazon QuickSight
2308	// settings.
2309	//
2310	// * RESTRICTED_READER: This role isn't currently available for use.
2311	//
2312	// *
2313	// RESTRICTED_AUTHOR: This role isn't currently available for use.
2314	Role UserRole
2315
2316	// The user's user name.
2317	UserName *string
2318}
2319
2320// VPC connection properties.
2321type VpcConnectionProperties struct {
2322
2323	// The Amazon Resource Name (ARN) for the VPC connection.
2324	//
2325	// This member is required.
2326	VpcConnectionArn *string
2327}
2328
2329// UnknownUnionMember is returned when a union member is returned over the wire,
2330// but has an unknown tag.
2331type UnknownUnionMember struct {
2332	Tag   string
2333	Value []byte
2334}
2335
2336func (*UnknownUnionMember) isDataSourceParameters() {}
2337func (*UnknownUnionMember) isPhysicalTable()        {}
2338func (*UnknownUnionMember) isTransformOperation()   {}
2339