@aws-sdk/client-quicksight 3.925.0 → 3.927.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/index.js +823 -360
  3. package/dist-es/commands/CreateTopicCommand.js +1 -1
  4. package/dist-es/commands/GenerateEmbedUrlForRegisteredUserCommand.js +1 -1
  5. package/dist-es/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.js +1 -1
  6. package/dist-es/commands/GetDashboardEmbedUrlCommand.js +1 -1
  7. package/dist-es/commands/GetSessionEmbedUrlCommand.js +1 -1
  8. package/dist-es/commands/ListActionConnectorsCommand.js +1 -1
  9. package/dist-es/models/models_0.js +8 -4
  10. package/dist-es/models/models_1.js +5 -26
  11. package/dist-es/models/models_2.js +26 -39
  12. package/dist-es/models/models_3.js +233 -222
  13. package/dist-es/models/models_4.js +217 -70
  14. package/dist-es/models/models_5.js +74 -2
  15. package/dist-es/protocols/Aws_restJson1.js +240 -4
  16. package/dist-types/QuickSight.d.ts +1 -1
  17. package/dist-types/QuickSightClient.d.ts +1 -1
  18. package/dist-types/commands/CreateDataSetCommand.d.ts +398 -3
  19. package/dist-types/commands/CreateTopicCommand.d.ts +1 -1
  20. package/dist-types/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
  21. package/dist-types/commands/CreateVPCConnectionCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeDataSetCommand.d.ts +396 -3
  23. package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +4 -4
  24. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +7 -7
  25. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +1 -1
  26. package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +4 -4
  27. package/dist-types/commands/GetFlowMetadataCommand.d.ts +1 -1
  28. package/dist-types/commands/GetFlowPermissionsCommand.d.ts +1 -1
  29. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
  30. package/dist-types/commands/ListActionConnectorsCommand.d.ts +1 -1
  31. package/dist-types/commands/ListAnalysesCommand.d.ts +1 -1
  32. package/dist-types/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +1 -1
  34. package/dist-types/commands/ListBrandsCommand.d.ts +1 -1
  35. package/dist-types/commands/ListCustomPermissionsCommand.d.ts +1 -1
  36. package/dist-types/commands/ListDashboardVersionsCommand.d.ts +1 -1
  37. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  38. package/dist-types/commands/ListDataSetsCommand.d.ts +10 -1
  39. package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
  40. package/dist-types/commands/ListFlowsCommand.d.ts +1 -1
  41. package/dist-types/commands/ListFolderMembersCommand.d.ts +1 -1
  42. package/dist-types/commands/ListFoldersCommand.d.ts +1 -1
  43. package/dist-types/commands/ListFoldersForResourceCommand.d.ts +1 -1
  44. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +1 -1
  45. package/dist-types/commands/ListGroupsCommand.d.ts +1 -2
  46. package/dist-types/commands/PredictQAResultsCommand.d.ts +1 -1
  47. package/dist-types/commands/SearchDataSetsCommand.d.ts +9 -0
  48. package/dist-types/commands/SearchTopicsCommand.d.ts +1 -1
  49. package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
  50. package/dist-types/commands/UpdateDataSetCommand.d.ts +398 -3
  51. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  52. package/dist-types/index.d.ts +1 -1
  53. package/dist-types/models/models_0.d.ts +162 -182
  54. package/dist-types/models/models_1.d.ts +177 -161
  55. package/dist-types/models/models_2.d.ts +196 -250
  56. package/dist-types/models/models_3.d.ts +2725 -3153
  57. package/dist-types/models/models_4.d.ts +4088 -3877
  58. package/dist-types/models/models_5.d.ts +1555 -12
  59. package/dist-types/ts3.4/commands/CreateTopicCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/CreateVPCConnectionCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/GetFlowMetadataCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/GetFlowPermissionsCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListActionConnectorsCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/ListAssetBundleImportJobsCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/ListBrandsCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/ListCustomPermissionsCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/ListFlowsCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/ListFolderMembersCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/ListFoldersCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/ListFoldersForResourceCommand.d.ts +1 -1
  82. package/dist-types/ts3.4/commands/ListGroupMembershipsCommand.d.ts +1 -1
  83. package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -2
  84. package/dist-types/ts3.4/models/models_0.d.ts +42 -42
  85. package/dist-types/ts3.4/models/models_1.d.ts +44 -56
  86. package/dist-types/ts3.4/models/models_2.d.ts +72 -94
  87. package/dist-types/ts3.4/models/models_3.d.ts +446 -511
  88. package/dist-types/ts3.4/models/models_4.d.ts +513 -366
  89. package/dist-types/ts3.4/models/models_5.d.ts +381 -17
  90. package/package.json +5 -5
@@ -50,7 +50,7 @@ declare const UpdatePublicSharingSettingsCommand_base: {
50
50
  * account.</p>
51
51
  * <p>Before you can turn on public sharing on your account, make sure to give public
52
52
  * sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon
53
- * Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using QuickSight with IAM</a> in the <i>Amazon Quick Sight
53
+ * Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Quick Suite with IAM</a> in the <i>Amazon Quick Sight
54
54
  * User Guide</i>.</p>
55
55
  * @example
56
56
  * Use a bare-bones client and the command you need to make an API call.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <fullname>Amazon QuickSight API Reference</fullname>
2
+ * <fullname>Amazon Quick Suite API Reference</fullname>
3
3
  * <p>Amazon Quick Sight is a fully managed, serverless business intelligence service for the
4
4
  * Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your
5
5
  * organization. This API reference contains documentation for a programming interface that
@@ -51,8 +51,8 @@ export declare const Edition: {
51
51
  */
52
52
  export type Edition = (typeof Edition)[keyof typeof Edition];
53
53
  /**
54
- * <p>A structure that contains the following account information
55
- * elements:</p>
54
+ * <p>A structure that contains the following account information elements:
55
+ * </p>
56
56
  * <ul>
57
57
  * <li>
58
58
  * <p>Your Quick Sight account name.</p>
@@ -76,7 +76,7 @@ export type Edition = (typeof Edition)[keyof typeof Edition];
76
76
  export interface AccountInfo {
77
77
  /**
78
78
  * <p>The account name that you provided for the Amazon Quick Sight subscription in your
79
- * Amazon Web Services account. You create this name when you sign up for QuickSight. It's unique over all of Amazon Web Services, and it appears only when
79
+ * Amazon Web Services account. You create this name when you sign up for Quick Suite. It's unique over all of Amazon Web Services, and it appears only when
80
80
  * users sign in.</p>
81
81
  * @public
82
82
  */
@@ -136,7 +136,7 @@ export interface AccountSettings {
136
136
  */
137
137
  NotificationEmail?: string | undefined;
138
138
  /**
139
- * <p>A Boolean value that indicates whether public sharing is turned on for an QuickSight account. For more information about turning on public sharing, see <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html">UpdatePublicSharingSettings</a>.</p>
139
+ * <p>A Boolean value that indicates whether public sharing is turned on for an Quick Suite account. For more information about turning on public sharing, see <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html">UpdatePublicSharingSettings</a>.</p>
140
140
  * @public
141
141
  */
142
142
  PublicSharingEnabled?: boolean | undefined;
@@ -869,6 +869,164 @@ export interface AggFunction {
869
869
  */
870
870
  PeriodField?: string | undefined;
871
871
  }
872
+ /**
873
+ * <p>An aggregation function that concatenates values from multiple rows into a single string with a specified
874
+ * separator.</p>
875
+ * @public
876
+ */
877
+ export interface DataPrepListAggregationFunction {
878
+ /**
879
+ * <p>The name of the column containing values to be concatenated.</p>
880
+ * @public
881
+ */
882
+ InputColumnName?: string | undefined;
883
+ /**
884
+ * <p>The string used to separate values in the concatenated result.</p>
885
+ * @public
886
+ */
887
+ Separator: string | undefined;
888
+ /**
889
+ * <p>Whether to include only distinct values in the concatenated result, removing duplicates.</p>
890
+ * @public
891
+ */
892
+ Distinct: boolean | undefined;
893
+ }
894
+ /**
895
+ * @public
896
+ * @enum
897
+ */
898
+ export declare const DataPrepSimpleAggregationFunctionType: {
899
+ readonly AVERAGE: "AVERAGE";
900
+ readonly COUNT: "COUNT";
901
+ readonly DISTINCT_COUNT: "DISTINCT_COUNT";
902
+ readonly MAX: "MAX";
903
+ readonly MIN: "MIN";
904
+ readonly SUM: "SUM";
905
+ };
906
+ /**
907
+ * @public
908
+ */
909
+ export type DataPrepSimpleAggregationFunctionType = (typeof DataPrepSimpleAggregationFunctionType)[keyof typeof DataPrepSimpleAggregationFunctionType];
910
+ /**
911
+ * <p>A simple aggregation function that performs standard statistical operations on a column.</p>
912
+ * @public
913
+ */
914
+ export interface DataPrepSimpleAggregationFunction {
915
+ /**
916
+ * <p>The name of the column on which to perform the aggregation function.</p>
917
+ * @public
918
+ */
919
+ InputColumnName?: string | undefined;
920
+ /**
921
+ * <p>The type of aggregation function to perform, such as <code>COUNT</code>, <code>SUM</code>, <code>AVERAGE</code>,
922
+ * <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>VARIANCE</code>, or <code>STANDARD_DEVIATION</code>.</p>
923
+ * @public
924
+ */
925
+ FunctionType: DataPrepSimpleAggregationFunctionType | undefined;
926
+ }
927
+ /**
928
+ * <p>Defines the type of aggregation function to apply to data during data preparation, supporting simple
929
+ * and list aggregations.</p>
930
+ * @public
931
+ */
932
+ export interface DataPrepAggregationFunction {
933
+ /**
934
+ * <p>A simple aggregation function such as <code>SUM</code>, <code>COUNT</code>, <code>AVERAGE</code>,
935
+ * <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>VARIANCE</code>, or <code>STANDARD_DEVIATION</code>.</p>
936
+ * @public
937
+ */
938
+ SimpleAggregation?: DataPrepSimpleAggregationFunction | undefined;
939
+ /**
940
+ * <p>A list aggregation function that concatenates values from multiple rows into a single delimited string.</p>
941
+ * @public
942
+ */
943
+ ListAggregation?: DataPrepListAggregationFunction | undefined;
944
+ }
945
+ /**
946
+ * <p>Defines an aggregation function to be applied to grouped data, creating a new column with
947
+ * the calculated result.</p>
948
+ * @public
949
+ */
950
+ export interface Aggregation {
951
+ /**
952
+ * <p>The aggregation function to apply, such as <code>SUM</code>, <code>COUNT</code>, <code>AVERAGE</code>,
953
+ * <code>MIN</code>, <code>MAX</code>
954
+ * </p>
955
+ * @public
956
+ */
957
+ AggregationFunction: DataPrepAggregationFunction | undefined;
958
+ /**
959
+ * <p>The name for the new column that will contain the aggregated values.</p>
960
+ * @public
961
+ */
962
+ NewColumnName: string | undefined;
963
+ /**
964
+ * <p>A unique identifier for the new column that will contain the aggregated values.</p>
965
+ * @public
966
+ */
967
+ NewColumnId: string | undefined;
968
+ }
969
+ /**
970
+ * <p>Maps a source column identifier to a target column identifier during transform operations.</p>
971
+ * @public
972
+ */
973
+ export interface DataSetColumnIdMapping {
974
+ /**
975
+ * <p>Source column ID.</p>
976
+ * @public
977
+ */
978
+ SourceColumnId: string | undefined;
979
+ /**
980
+ * <p>Target column ID.</p>
981
+ * @public
982
+ */
983
+ TargetColumnId: string | undefined;
984
+ }
985
+ /**
986
+ * <p>Specifies the source of data for a transform operation, including the source operation and column mappings.</p>
987
+ * @public
988
+ */
989
+ export interface TransformOperationSource {
990
+ /**
991
+ * <p>The identifier of the transform operation that provides input data.</p>
992
+ * @public
993
+ */
994
+ TransformOperationId: string | undefined;
995
+ /**
996
+ * <p>The mappings between source column identifiers and target column identifiers for this transformation.</p>
997
+ * @public
998
+ */
999
+ ColumnIdMappings?: DataSetColumnIdMapping[] | undefined;
1000
+ }
1001
+ /**
1002
+ * <p>A transform operation that groups rows by specified columns and applies aggregation functions
1003
+ * to calculate summary values.</p>
1004
+ * @public
1005
+ */
1006
+ export interface AggregateOperation {
1007
+ /**
1008
+ * <p>Alias for this operation.</p>
1009
+ * @public
1010
+ */
1011
+ Alias: string | undefined;
1012
+ /**
1013
+ * <p>The source transform operation that provides input data for the aggregation.</p>
1014
+ * @public
1015
+ */
1016
+ Source: TransformOperationSource | undefined;
1017
+ /**
1018
+ * <p>The list of column names to group by when performing the aggregation. Rows with the same values in
1019
+ * these columns will be grouped together.</p>
1020
+ * @public
1021
+ */
1022
+ GroupByColumnNames?: string[] | undefined;
1023
+ /**
1024
+ * <p>The list of aggregation functions to apply to the grouped data, such as <code>SUM</code>,
1025
+ * <code>COUNT</code>, or <code>AVERAGE</code>.</p>
1026
+ * @public
1027
+ */
1028
+ Aggregations: Aggregation[] | undefined;
1029
+ }
872
1030
  /**
873
1031
  * @public
874
1032
  * @enum
@@ -6397,180 +6555,6 @@ export interface VisibleRangeOptions {
6397
6555
  */
6398
6556
  PercentRange?: PercentVisibleRange | undefined;
6399
6557
  }
6400
- /**
6401
- * <p>The visual display options for a data zoom scroll bar.</p>
6402
- * @public
6403
- */
6404
- export interface ScrollBarOptions {
6405
- /**
6406
- * <p>The visibility of the data zoom scroll bar.</p>
6407
- * @public
6408
- */
6409
- Visibility?: Visibility | undefined;
6410
- /**
6411
- * <p>The visibility range for the data zoom scroll bar.</p>
6412
- * @public
6413
- */
6414
- VisibleRange?: VisibleRangeOptions | undefined;
6415
- }
6416
- /**
6417
- * <p>The tick label options of an axis.</p>
6418
- * @public
6419
- */
6420
- export interface AxisTickLabelOptions {
6421
- /**
6422
- * <p>Determines whether or not the axis ticks are visible.</p>
6423
- * @public
6424
- */
6425
- LabelOptions?: LabelOptions | undefined;
6426
- /**
6427
- * <p>The rotation angle of the axis tick labels.</p>
6428
- * @public
6429
- */
6430
- RotationAngle?: number | undefined;
6431
- }
6432
- /**
6433
- * <p>The display options for the axis label.</p>
6434
- * @public
6435
- */
6436
- export interface AxisDisplayOptions {
6437
- /**
6438
- * <p>The tick label options of an axis.</p>
6439
- * @public
6440
- */
6441
- TickLabelOptions?: AxisTickLabelOptions | undefined;
6442
- /**
6443
- * <p>Determines whether or not the axis line is visible.</p>
6444
- * @public
6445
- */
6446
- AxisLineVisibility?: Visibility | undefined;
6447
- /**
6448
- * <p>Determines whether or not the grid line is visible.</p>
6449
- * @public
6450
- */
6451
- GridLineVisibility?: Visibility | undefined;
6452
- /**
6453
- * <p>The data options for an axis.</p>
6454
- * @public
6455
- */
6456
- DataOptions?: AxisDataOptions | undefined;
6457
- /**
6458
- * <p>The scroll bar options for an axis.</p>
6459
- * @public
6460
- */
6461
- ScrollbarOptions?: ScrollBarOptions | undefined;
6462
- /**
6463
- * <p>The offset value that determines the starting placement of the axis within a visual's bounds.</p>
6464
- * @public
6465
- */
6466
- AxisOffset?: string | undefined;
6467
- }
6468
- /**
6469
- * <p>The reference that specifies where the axis label is applied to.</p>
6470
- * @public
6471
- */
6472
- export interface AxisLabelReferenceOptions {
6473
- /**
6474
- * <p>The field that the axis label is targeted to.</p>
6475
- * @public
6476
- */
6477
- FieldId: string | undefined;
6478
- /**
6479
- * <p>The column that the axis label is targeted to.</p>
6480
- * @public
6481
- */
6482
- Column: ColumnIdentifier | undefined;
6483
- }
6484
- /**
6485
- * <p>The label options for a chart axis. You must specify the field that the label is targeted to.</p>
6486
- * @public
6487
- */
6488
- export interface AxisLabelOptions {
6489
- /**
6490
- * <p>The font configuration of the axis label.</p>
6491
- * @public
6492
- */
6493
- FontConfiguration?: FontConfiguration | undefined;
6494
- /**
6495
- * <p>The text for the axis label.</p>
6496
- * @public
6497
- */
6498
- CustomLabel?: string | undefined;
6499
- /**
6500
- * <p>The options that indicate which field the label belongs to.</p>
6501
- * @public
6502
- */
6503
- ApplyTo?: AxisLabelReferenceOptions | undefined;
6504
- }
6505
- /**
6506
- * <p>The label options for an axis on a chart.</p>
6507
- * @public
6508
- */
6509
- export interface ChartAxisLabelOptions {
6510
- /**
6511
- * <p>The visibility of an axis label on a chart. Choose one of the following options:</p>
6512
- * <ul>
6513
- * <li>
6514
- * <p>
6515
- * <code>VISIBLE</code>: Shows the axis.</p>
6516
- * </li>
6517
- * <li>
6518
- * <p>
6519
- * <code>HIDDEN</code>: Hides the axis.</p>
6520
- * </li>
6521
- * </ul>
6522
- * @public
6523
- */
6524
- Visibility?: Visibility | undefined;
6525
- /**
6526
- * <p>The visibility configuration of the sort icon on a chart's axis label.</p>
6527
- * @public
6528
- */
6529
- SortIconVisibility?: Visibility | undefined;
6530
- /**
6531
- * <p>The label options for a chart axis.</p>
6532
- * @public
6533
- */
6534
- AxisLabelOptions?: AxisLabelOptions[] | undefined;
6535
- }
6536
- /**
6537
- * <p>The contribution analysis visual display for a line, pie, or bar chart.</p>
6538
- * @public
6539
- */
6540
- export interface ContributionAnalysisDefault {
6541
- /**
6542
- * <p>The measure field that is used in the contribution analysis.</p>
6543
- * @public
6544
- */
6545
- MeasureFieldId: string | undefined;
6546
- /**
6547
- * <p>The dimensions columns that are used in the contribution analysis,
6548
- * usually a list of <code>ColumnIdentifiers</code>.</p>
6549
- * @public
6550
- */
6551
- ContributorDimensions: ColumnIdentifier[] | undefined;
6552
- }
6553
- /**
6554
- * <p>The option that specifies individual data values for labels.</p>
6555
- * @public
6556
- */
6557
- export interface DataPathLabelType {
6558
- /**
6559
- * <p>The field ID of the field that the data label needs to be applied to.</p>
6560
- * @public
6561
- */
6562
- FieldId?: string | undefined;
6563
- /**
6564
- * <p>The actual value of the field that is labeled.</p>
6565
- * @public
6566
- */
6567
- FieldValue?: string | undefined;
6568
- /**
6569
- * <p>The visibility of the data label.</p>
6570
- * @public
6571
- */
6572
- Visibility?: Visibility | undefined;
6573
- }
6574
6558
  /**
6575
6559
  * @internal
6576
6560
  */
@@ -6815,7 +6799,3 @@ export declare const VisualCustomActionOperationFilterSensitiveLog: (obj: Visual
6815
6799
  * @internal
6816
6800
  */
6817
6801
  export declare const VisualCustomActionFilterSensitiveLog: (obj: VisualCustomAction) => any;
6818
- /**
6819
- * @internal
6820
- */
6821
- export declare const DataPathLabelTypeFilterSensitiveLog: (obj: DataPathLabelType) => any;