@aws-sdk/client-quicksight 3.370.0 → 3.376.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 (139) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/QuickSight.js +6 -0
  3. package/dist-cjs/commands/DescribeDashboardSnapshotJobCommand.js +47 -0
  4. package/dist-cjs/commands/DescribeDashboardSnapshotJobResultCommand.js +47 -0
  5. package/dist-cjs/commands/StartDashboardSnapshotJobCommand.js +47 -0
  6. package/dist-cjs/commands/UpdateDataSetCommand.js +2 -2
  7. package/dist-cjs/commands/UpdateDataSourceCommand.js +2 -2
  8. package/dist-cjs/commands/UpdateTemplateCommand.js +2 -2
  9. package/dist-cjs/commands/index.js +3 -0
  10. package/dist-cjs/models/models_0.js +6 -12
  11. package/dist-cjs/models/models_1.js +35 -26
  12. package/dist-cjs/models/models_2.js +25 -3
  13. package/dist-cjs/models/models_3.js +39 -24
  14. package/dist-cjs/models/models_4.js +26 -1
  15. package/dist-cjs/pagination/ListGroupMembershipsPaginator.js +29 -0
  16. package/dist-cjs/pagination/ListGroupsPaginator.js +29 -0
  17. package/dist-cjs/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListIAMPolicyAssignmentsPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListUserGroupsPaginator.js +29 -0
  20. package/dist-cjs/pagination/ListUsersPaginator.js +29 -0
  21. package/dist-cjs/pagination/SearchGroupsPaginator.js +29 -0
  22. package/dist-cjs/pagination/index.js +7 -0
  23. package/dist-cjs/protocols/Aws_restJson1.js +326 -6
  24. package/dist-es/QuickSight.js +6 -0
  25. package/dist-es/commands/DescribeDashboardSnapshotJobCommand.js +43 -0
  26. package/dist-es/commands/DescribeDashboardSnapshotJobResultCommand.js +43 -0
  27. package/dist-es/commands/StartDashboardSnapshotJobCommand.js +43 -0
  28. package/dist-es/commands/UpdateDataSetCommand.js +1 -1
  29. package/dist-es/commands/UpdateDataSourceCommand.js +1 -1
  30. package/dist-es/commands/UpdateTemplateCommand.js +1 -1
  31. package/dist-es/commands/index.js +3 -0
  32. package/dist-es/models/models_0.js +3 -7
  33. package/dist-es/models/models_1.js +26 -22
  34. package/dist-es/models/models_2.js +22 -0
  35. package/dist-es/models/models_3.js +30 -19
  36. package/dist-es/models/models_4.js +22 -0
  37. package/dist-es/pagination/ListGroupMembershipsPaginator.js +25 -0
  38. package/dist-es/pagination/ListGroupsPaginator.js +25 -0
  39. package/dist-es/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +25 -0
  40. package/dist-es/pagination/ListIAMPolicyAssignmentsPaginator.js +25 -0
  41. package/dist-es/pagination/ListUserGroupsPaginator.js +25 -0
  42. package/dist-es/pagination/ListUsersPaginator.js +25 -0
  43. package/dist-es/pagination/SearchGroupsPaginator.js +25 -0
  44. package/dist-es/pagination/index.js +7 -0
  45. package/dist-es/protocols/Aws_restJson1.js +314 -0
  46. package/dist-types/QuickSight.d.ts +21 -0
  47. package/dist-types/QuickSightClient.d.ts +5 -2
  48. package/dist-types/commands/CreateAnalysisCommand.d.ts +48 -0
  49. package/dist-types/commands/CreateDashboardCommand.d.ts +48 -0
  50. package/dist-types/commands/CreateTemplateCommand.d.ts +48 -0
  51. package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +6 -0
  52. package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
  53. package/dist-types/commands/DeleteAnalysisCommand.d.ts +1 -1
  54. package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
  55. package/dist-types/commands/DeleteDataSetCommand.d.ts +1 -1
  56. package/dist-types/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
  57. package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
  58. package/dist-types/commands/DeleteFolderCommand.d.ts +1 -2
  59. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +48 -0
  60. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +48 -0
  61. package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +179 -0
  62. package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +155 -0
  63. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +48 -0
  64. package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +197 -0
  65. package/dist-types/commands/UpdateAnalysisCommand.d.ts +48 -0
  66. package/dist-types/commands/UpdateDashboardCommand.d.ts +48 -0
  67. package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
  68. package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
  69. package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
  70. package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
  71. package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
  73. package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
  75. package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
  76. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  77. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  78. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  79. package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
  80. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -2
  81. package/dist-types/commands/UpdateTemplateCommand.d.ts +49 -1
  82. package/dist-types/commands/index.d.ts +3 -0
  83. package/dist-types/models/models_0.d.ts +77 -47
  84. package/dist-types/models/models_1.d.ts +208 -213
  85. package/dist-types/models/models_2.d.ts +219 -220
  86. package/dist-types/models/models_3.d.ts +602 -805
  87. package/dist-types/models/models_4.d.ts +770 -2
  88. package/dist-types/pagination/ListGroupMembershipsPaginator.d.ts +7 -0
  89. package/dist-types/pagination/ListGroupsPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListUserGroupsPaginator.d.ts +7 -0
  93. package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
  94. package/dist-types/pagination/SearchGroupsPaginator.d.ts +7 -0
  95. package/dist-types/pagination/index.d.ts +7 -0
  96. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  97. package/dist-types/ts3.4/QuickSight.d.ts +57 -0
  98. package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
  99. package/dist-types/ts3.4/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/DeleteAnalysisCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/DeleteDataSetCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +1 -2
  106. package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobCommand.d.ts +42 -0
  107. package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +42 -0
  108. package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +42 -0
  109. package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
  111. package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
  114. package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
  115. package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
  116. package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
  117. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
  118. package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  119. package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  120. package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  121. package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
  122. package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +4 -2
  123. package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
  124. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  125. package/dist-types/ts3.4/models/models_0.d.ts +21 -17
  126. package/dist-types/ts3.4/models/models_1.d.ts +71 -81
  127. package/dist-types/ts3.4/models/models_2.d.ts +85 -67
  128. package/dist-types/ts3.4/models/models_3.d.ts +176 -222
  129. package/dist-types/ts3.4/models/models_4.d.ts +222 -1
  130. package/dist-types/ts3.4/pagination/ListGroupMembershipsPaginator.d.ts +11 -0
  131. package/dist-types/ts3.4/pagination/ListGroupsPaginator.d.ts +11 -0
  132. package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +11 -0
  133. package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +11 -0
  134. package/dist-types/ts3.4/pagination/ListUserGroupsPaginator.d.ts +11 -0
  135. package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
  136. package/dist-types/ts3.4/pagination/SearchGroupsPaginator.d.ts +11 -0
  137. package/dist-types/ts3.4/pagination/index.d.ts +7 -0
  138. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  139. package/package.json +1 -1
@@ -1,4 +1,43 @@
1
- import { AnalysisDefaults, AxisBinding, AxisDisplayOptions, BarChartVisual, BarsArrangement, BoxPlotFieldWells, BoxPlotOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathValue, DataSetIdentifierDeclaration, DimensionField, FieldSort, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, PaginationConfiguration, ParameterControl, ParameterDeclaration, PercentageDisplayFormatConfiguration, ReferenceLine, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WidgetStatus } from "./models_0";
1
+ import { AnalysisDefaults, AxisBinding, AxisDisplayOptions, BarChartVisual, BarsArrangement, BoxPlotOptions, CalculatedField, ChartAxisLabelOptions, ColumnConfiguration, ColumnHierarchy, ColumnIdentifier, ColumnSort, ContributionAnalysisDefault, DataLabelOptions, DataLabelPosition, DataPathValue, DataSetIdentifierDeclaration, DimensionField, FieldSort, FieldSortOptions, FilterControl, FilterGroup, FontConfiguration, FormatConfiguration, HorizontalTextAlignment, ItemsLimitConfiguration, Layout, LegendOptions, MeasureField, NumberDisplayFormatConfiguration, ParameterControl, ParameterDeclaration, PercentageDisplayFormatConfiguration, ReferenceLine, ResourceStatus, SheetContentType, SheetControlLayout, SheetTextBox, SmallMultiplesOptions, SortDirection, TimeGranularity, TooltipOptions, URLTargetConfiguration, Visibility, VisualCustomAction, VisualPalette, VisualSubtitleLabelOptions, VisualTitleLabelOptions, WidgetStatus } from "./models_0";
2
+ /**
3
+ * @public
4
+ * <p>The aggregated field well for a box plot.</p>
5
+ */
6
+ export interface BoxPlotAggregatedFieldWells {
7
+ /**
8
+ * <p>The group by field well of a box plot chart. Values are grouped based on group by fields.</p>
9
+ */
10
+ GroupBy?: DimensionField[];
11
+ /**
12
+ * <p>The value field well of a box plot chart. Values are aggregated based on group by fields.</p>
13
+ */
14
+ Values?: MeasureField[];
15
+ }
16
+ /**
17
+ * @public
18
+ * <p>The field wells of a <code>BoxPlotVisual</code>.</p>
19
+ * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
20
+ */
21
+ export interface BoxPlotFieldWells {
22
+ /**
23
+ * <p>The aggregated field wells of a box plot.</p>
24
+ */
25
+ BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells;
26
+ }
27
+ /**
28
+ * @public
29
+ * <p>The pagination configuration for a table visual or boxplot.</p>
30
+ */
31
+ export interface PaginationConfiguration {
32
+ /**
33
+ * <p>Indicates how many items render in one page.</p>
34
+ */
35
+ PageSize: number | undefined;
36
+ /**
37
+ * <p>Indicates the page number.</p>
38
+ */
39
+ PageNumber: number | undefined;
40
+ }
2
41
  /**
3
42
  * @public
4
43
  * <p>The sort configuration of a <code>BoxPlotVisual</code>.</p>
@@ -5591,371 +5630,315 @@ export interface AnonymousUserEmbeddingExperienceConfiguration {
5591
5630
  * @public
5592
5631
  * @enum
5593
5632
  */
5594
- export declare const AssetBundleExportJobAnalysisPropertyToOverride: {
5595
- readonly NAME: "Name";
5633
+ export declare const SnapshotFileFormatType: {
5634
+ readonly CSV: "CSV";
5635
+ readonly PDF: "PDF";
5596
5636
  };
5597
5637
  /**
5598
5638
  * @public
5599
5639
  */
5600
- export type AssetBundleExportJobAnalysisPropertyToOverride = (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride];
5601
- /**
5602
- * @public
5603
- * <p>Controls how a specific <code>Analysis</code> resource is parameterized in the returned CloudFormation template.</p>
5604
- */
5605
- export interface AssetBundleExportJobAnalysisOverrideProperties {
5606
- /**
5607
- * <p>The ARN of the specific <code>Analysis</code> resource whose override properties are configured in this structure.</p>
5608
- */
5609
- Arn?: string;
5610
- /**
5611
- * <p>A list of <code>Analysis</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5612
- */
5613
- Properties: (AssetBundleExportJobAnalysisPropertyToOverride | string)[] | undefined;
5614
- }
5640
+ export type SnapshotFileFormatType = (typeof SnapshotFileFormatType)[keyof typeof SnapshotFileFormatType];
5615
5641
  /**
5616
5642
  * @public
5617
5643
  * @enum
5618
5644
  */
5619
- export declare const AssetBundleExportJobDashboardPropertyToOverride: {
5620
- readonly NAME: "Name";
5645
+ export declare const SnapshotFileSheetSelectionScope: {
5646
+ readonly ALL_VISUALS: "ALL_VISUALS";
5647
+ readonly SELECTED_VISUALS: "SELECTED_VISUALS";
5621
5648
  };
5622
5649
  /**
5623
5650
  * @public
5624
5651
  */
5625
- export type AssetBundleExportJobDashboardPropertyToOverride = (typeof AssetBundleExportJobDashboardPropertyToOverride)[keyof typeof AssetBundleExportJobDashboardPropertyToOverride];
5652
+ export type SnapshotFileSheetSelectionScope = (typeof SnapshotFileSheetSelectionScope)[keyof typeof SnapshotFileSheetSelectionScope];
5626
5653
  /**
5627
5654
  * @public
5628
- * <p>Controls how a specific <code>Dashboard</code> resource is parameterized in the returned CloudFormation template.</p>
5655
+ * <p>A structure that contains information that identifies the snapshot that needs to be generated.</p>
5629
5656
  */
5630
- export interface AssetBundleExportJobDashboardOverrideProperties {
5657
+ export interface SnapshotFileSheetSelection {
5631
5658
  /**
5632
- * <p>The ARN of the specific <code>Dashboard</code> resource whose override properties are configured in this structure.</p>
5659
+ * <p>The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.</p>
5633
5660
  */
5634
- Arn?: string;
5661
+ SheetId: string | undefined;
5635
5662
  /**
5636
- * <p>A list of <code>Dashboard</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5663
+ * <p>The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.</p>
5664
+ * <ul>
5665
+ * <li>
5666
+ * <p>
5667
+ * <code>ALL_VISUALS</code> - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.</p>
5668
+ * </li>
5669
+ * <li>
5670
+ * <p>
5671
+ * <code>SELECTED_VISUALS</code> - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.</p>
5672
+ * </li>
5673
+ * </ul>
5637
5674
  */
5638
- Properties: (AssetBundleExportJobDashboardPropertyToOverride | string)[] | undefined;
5675
+ SelectionScope: SnapshotFileSheetSelectionScope | string | undefined;
5676
+ /**
5677
+ * <p>
5678
+ * A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.
5679
+ * </p>
5680
+ */
5681
+ VisualIds?: string[];
5639
5682
  }
5640
5683
  /**
5641
5684
  * @public
5642
- * @enum
5643
- */
5644
- export declare const AssetBundleExportJobDataSetPropertyToOverride: {
5645
- readonly NAME: "Name";
5646
- };
5647
- /**
5648
- * @public
5685
+ * <p>A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.</p>
5649
5686
  */
5650
- export type AssetBundleExportJobDataSetPropertyToOverride = (typeof AssetBundleExportJobDataSetPropertyToOverride)[keyof typeof AssetBundleExportJobDataSetPropertyToOverride];
5651
- /**
5652
- * @public
5653
- * <p>Controls how a specific <code>DataSet</code> resource is parameterized in the returned CloudFormation template.</p>
5654
- */
5655
- export interface AssetBundleExportJobDataSetOverrideProperties {
5687
+ export interface SnapshotFile {
5656
5688
  /**
5657
- * <p>The ARN of the specific <code>DataSet</code> resource whose override properties are configured in this structure.</p>
5689
+ * <p>A list of <code>SnapshotFileSheetSelection</code> objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations or 1 configuration for PDF.</p>
5658
5690
  */
5659
- Arn?: string;
5691
+ SheetSelections: SnapshotFileSheetSelection[] | undefined;
5660
5692
  /**
5661
- * <p>A list of <code>DataSet</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5693
+ * <p>The format of the snapshot file to be generated. You can choose between <code>CSV</code> and <code>PDF</code>.</p>
5662
5694
  */
5663
- Properties: (AssetBundleExportJobDataSetPropertyToOverride | string)[] | undefined;
5695
+ FormatType: SnapshotFileFormatType | string | undefined;
5664
5696
  }
5665
5697
  /**
5666
5698
  * @public
5667
- * @enum
5699
+ * <p>Information on the error that caused the snapshot job to fail.</p>
5668
5700
  */
5669
- export declare const AssetBundleExportJobDataSourcePropertyToOverride: {
5670
- readonly CATALOG: "Catalog";
5671
- readonly CLUSTER_ID: "ClusterId";
5672
- readonly DATABASE: "Database";
5673
- readonly DATA_SET_NAME: "DataSetName";
5674
- readonly DISABLE_SSL: "DisableSsl";
5675
- readonly DOMAIN: "Domain";
5676
- readonly HOST: "Host";
5677
- readonly INSTANCE_ID: "InstanceId";
5678
- readonly MANIFEST_FILE_LOCATION: "ManifestFileLocation";
5679
- readonly NAME: "Name";
5680
- readonly PASSWORD: "Password";
5681
- readonly PORT: "Port";
5682
- readonly ROLE_ARN: "RoleArn";
5683
- readonly SECRET_ARN: "SecretArn";
5684
- readonly USERNAME: "Username";
5685
- readonly WAREHOUSE: "Warehouse";
5686
- readonly WORK_GROUP: "WorkGroup";
5687
- };
5688
- /**
5689
- * @public
5690
- */
5691
- export type AssetBundleExportJobDataSourcePropertyToOverride = (typeof AssetBundleExportJobDataSourcePropertyToOverride)[keyof typeof AssetBundleExportJobDataSourcePropertyToOverride];
5701
+ export interface SnapshotJobResultErrorInfo {
5702
+ /**
5703
+ * <p>The error message.</p>
5704
+ */
5705
+ ErrorMessage?: string;
5706
+ /**
5707
+ * <p>The error type.</p>
5708
+ */
5709
+ ErrorType?: string;
5710
+ }
5692
5711
  /**
5693
5712
  * @public
5694
- * <p>Controls how a specific <code>DataSource</code> resource is parameterized in the returned CloudFormation template.</p>
5713
+ * <p>An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.</p>
5695
5714
  */
5696
- export interface AssetBundleExportJobDataSourceOverrideProperties {
5715
+ export interface S3BucketConfiguration {
5697
5716
  /**
5698
- * <p>The ARN of the specific <code>DataSource</code> resource whose override properties are configured in this structure.</p>
5717
+ * <p>The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.</p>
5699
5718
  */
5700
- Arn?: string;
5719
+ BucketName: string | undefined;
5701
5720
  /**
5702
- * <p>A list of <code>DataSource</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5721
+ * <p>The prefix of the Amazon S3 bucket that the generated snapshots are stored in.</p>
5703
5722
  */
5704
- Properties: (AssetBundleExportJobDataSourcePropertyToOverride | string)[] | undefined;
5723
+ BucketPrefix: string | undefined;
5724
+ /**
5725
+ * <p>The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the <code>StartDashboardSnapshotJob</code> API call is made.</p>
5726
+ */
5727
+ BucketRegion: string | undefined;
5705
5728
  }
5706
5729
  /**
5707
5730
  * @public
5708
- * @enum
5731
+ * <p>A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.</p>
5709
5732
  */
5710
- export declare const AssetBundleExportJobRefreshSchedulePropertyToOverride: {
5711
- readonly START_AFTER_DATE_TIME: "StartAfterDateTime";
5712
- };
5733
+ export interface SnapshotS3DestinationConfiguration {
5734
+ /**
5735
+ * <p>A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.</p>
5736
+ */
5737
+ BucketConfiguration?: S3BucketConfiguration;
5738
+ }
5713
5739
  /**
5714
5740
  * @public
5741
+ * <p>The Amazon S3 result from the snapshot job. The result includes the <code>DestinationConfiguration</code> and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.</p>
5715
5742
  */
5716
- export type AssetBundleExportJobRefreshSchedulePropertyToOverride = (typeof AssetBundleExportJobRefreshSchedulePropertyToOverride)[keyof typeof AssetBundleExportJobRefreshSchedulePropertyToOverride];
5743
+ export interface SnapshotJobS3Result {
5744
+ /**
5745
+ * <p>A list of Amazon S3 bucket configurations that are provided when you make a <code>StartDashboardSnapshotJob</code> API call.
5746
+ * </p>
5747
+ */
5748
+ S3DestinationConfiguration?: SnapshotS3DestinationConfiguration;
5749
+ /**
5750
+ * <p>The Amazon S3 Uri.</p>
5751
+ */
5752
+ S3Uri?: string;
5753
+ /**
5754
+ * <p>An array of error records that describe any failures that occur while the dashboard snapshot job runs.</p>
5755
+ */
5756
+ ErrorInfo?: SnapshotJobResultErrorInfo[];
5757
+ }
5717
5758
  /**
5718
5759
  * @public
5719
- * <p>Controls how a specific <code>RefreshSchedule</code> resource is parameterized in the returned CloudFormation template.</p>
5760
+ * <p>A structure that contains information on the generated snapshot file groups.</p>
5720
5761
  */
5721
- export interface AssetBundleExportJobRefreshScheduleOverrideProperties {
5762
+ export interface SnapshotJobResultFileGroup {
5722
5763
  /**
5723
- * <p>The ARN of the specific <code>RefreshSchedule</code> resource whose override properties are configured in this structure.</p>
5764
+ * <p> A list of <code>SnapshotFile</code> objects.</p>
5724
5765
  */
5725
- Arn?: string;
5766
+ Files?: SnapshotFile[];
5726
5767
  /**
5727
- * <p>A list of <code>RefreshSchedule</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5768
+ * <p> A list of <code>SnapshotJobS3Result</code> objects.</p>
5728
5769
  */
5729
- Properties: (AssetBundleExportJobRefreshSchedulePropertyToOverride | string)[] | undefined;
5770
+ S3Results?: SnapshotJobS3Result[];
5730
5771
  }
5731
5772
  /**
5732
5773
  * @public
5733
- * <p>An optional structure that configures resource ID overrides for the export job.</p>
5774
+ * <p>A structure that contains the file groups that are requested for the artifact generation in a <code>StartDashboardSnapshotJob</code> API call.
5775
+ * </p>
5734
5776
  */
5735
- export interface AssetBundleExportJobResourceIdOverrideConfiguration {
5777
+ export interface AnonymousUserSnapshotJobResult {
5736
5778
  /**
5737
- * <p>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</p>
5779
+ * <p>A list of <code>SnapshotJobResultFileGroup</code> objects that contain information on the files that are requested during a <code>StartDashboardSnapshotJob</code> API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.</p>
5738
5780
  */
5739
- PrefixForAllResources?: boolean;
5781
+ FileGroups?: SnapshotJobResultFileGroup[];
5740
5782
  }
5741
5783
  /**
5742
5784
  * @public
5743
5785
  * @enum
5744
5786
  */
5745
- export declare const AssetBundleExportJobThemePropertyToOverride: {
5787
+ export declare const AssetBundleExportJobAnalysisPropertyToOverride: {
5746
5788
  readonly NAME: "Name";
5747
5789
  };
5748
5790
  /**
5749
5791
  * @public
5750
5792
  */
5751
- export type AssetBundleExportJobThemePropertyToOverride = (typeof AssetBundleExportJobThemePropertyToOverride)[keyof typeof AssetBundleExportJobThemePropertyToOverride];
5793
+ export type AssetBundleExportJobAnalysisPropertyToOverride = (typeof AssetBundleExportJobAnalysisPropertyToOverride)[keyof typeof AssetBundleExportJobAnalysisPropertyToOverride];
5752
5794
  /**
5753
5795
  * @public
5754
- * <p>Controls how a specific <code>Theme</code> resource is parameterized in the returned CloudFormation template.</p>
5796
+ * <p>Controls how a specific <code>Analysis</code> resource is parameterized in the returned CloudFormation template.</p>
5755
5797
  */
5756
- export interface AssetBundleExportJobThemeOverrideProperties {
5798
+ export interface AssetBundleExportJobAnalysisOverrideProperties {
5757
5799
  /**
5758
- * <p>The ARN of the specific <code>Theme</code> resource whose override properties are configured in this structure.</p>
5800
+ * <p>The ARN of the specific <code>Analysis</code> resource whose override properties are configured in this structure.</p>
5759
5801
  */
5760
5802
  Arn?: string;
5761
5803
  /**
5762
- * <p>A list of <code>Theme</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5804
+ * <p>A list of <code>Analysis</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5763
5805
  */
5764
- Properties: (AssetBundleExportJobThemePropertyToOverride | string)[] | undefined;
5806
+ Properties: (AssetBundleExportJobAnalysisPropertyToOverride | string)[] | undefined;
5765
5807
  }
5766
5808
  /**
5767
5809
  * @public
5768
5810
  * @enum
5769
5811
  */
5770
- export declare const AssetBundleExportJobVPCConnectionPropertyToOverride: {
5771
- readonly DNS_RESOLVERS: "DnsResolvers";
5812
+ export declare const AssetBundleExportJobDashboardPropertyToOverride: {
5772
5813
  readonly NAME: "Name";
5773
- readonly ROLE_ARN: "RoleArn";
5774
5814
  };
5775
5815
  /**
5776
5816
  * @public
5777
5817
  */
5778
- export type AssetBundleExportJobVPCConnectionPropertyToOverride = (typeof AssetBundleExportJobVPCConnectionPropertyToOverride)[keyof typeof AssetBundleExportJobVPCConnectionPropertyToOverride];
5818
+ export type AssetBundleExportJobDashboardPropertyToOverride = (typeof AssetBundleExportJobDashboardPropertyToOverride)[keyof typeof AssetBundleExportJobDashboardPropertyToOverride];
5779
5819
  /**
5780
5820
  * @public
5781
- * <p>Controls how a specific <code>VPCConnection</code> resource is parameterized in the outputted CloudFormation template.</p>
5821
+ * <p>Controls how a specific <code>Dashboard</code> resource is parameterized in the returned CloudFormation template.</p>
5782
5822
  */
5783
- export interface AssetBundleExportJobVPCConnectionOverrideProperties {
5823
+ export interface AssetBundleExportJobDashboardOverrideProperties {
5784
5824
  /**
5785
- * <p>The ARN of the specific <code>VPCConnection</code> resource whose override properties are configured in this structure.</p>
5825
+ * <p>The ARN of the specific <code>Dashboard</code> resource whose override properties are configured in this structure.</p>
5786
5826
  */
5787
5827
  Arn?: string;
5788
5828
  /**
5789
- * <p>A list of <code>VPCConnection</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5790
- */
5791
- Properties: (AssetBundleExportJobVPCConnectionPropertyToOverride | string)[] | undefined;
5792
- }
5793
- /**
5794
- * @public
5795
- * <p>An optional collection of CloudFormation property configurations that control how the export job is generated.</p>
5796
- */
5797
- export interface AssetBundleCloudFormationOverridePropertyConfiguration {
5798
- /**
5799
- * <p>An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.</p>
5800
- */
5801
- ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration;
5802
- /**
5803
- * <p>An optional list of structures that control how <code>VPCConnection</code> resources are parameterized in the returned CloudFormation template.</p>
5804
- */
5805
- VPCConnections?: AssetBundleExportJobVPCConnectionOverrideProperties[];
5806
- /**
5807
- * <p>An optional list of structures that control how <code>RefreshSchedule</code> resources are parameterized in the returned CloudFormation template.</p>
5808
- */
5809
- RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverrideProperties[];
5810
- /**
5811
- * <p>An optional list of structures that control how <code>DataSource</code> resources are parameterized in the returned CloudFormation template.</p>
5812
- */
5813
- DataSources?: AssetBundleExportJobDataSourceOverrideProperties[];
5814
- /**
5815
- * <p>An optional list of structures that control how <code>DataSet</code> resources are parameterized in the returned CloudFormation template.</p>
5816
- */
5817
- DataSets?: AssetBundleExportJobDataSetOverrideProperties[];
5818
- /**
5819
- * <p>An optional list of structures that control how <code>Theme</code> resources are parameterized in the returned CloudFormation template.</p>
5820
- */
5821
- Themes?: AssetBundleExportJobThemeOverrideProperties[];
5822
- /**
5823
- * <p>An optional list of structures that control how <code>Analysis</code> resources are parameterized in the returned CloudFormation template.</p>
5824
- */
5825
- Analyses?: AssetBundleExportJobAnalysisOverrideProperties[];
5826
- /**
5827
- * <p>An optional list of structures that control how <code>Dashboard</code> resources are parameterized in the returned CloudFormation template.</p>
5829
+ * <p>A list of <code>Dashboard</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5828
5830
  */
5829
- Dashboards?: AssetBundleExportJobDashboardOverrideProperties[];
5831
+ Properties: (AssetBundleExportJobDashboardPropertyToOverride | string)[] | undefined;
5830
5832
  }
5831
5833
  /**
5832
5834
  * @public
5833
5835
  * @enum
5834
5836
  */
5835
- export declare const AssetBundleExportFormat: {
5836
- readonly CLOUDFORMATION_JSON: "CLOUDFORMATION_JSON";
5837
- readonly QUICKSIGHT_JSON: "QUICKSIGHT_JSON";
5837
+ export declare const AssetBundleExportJobDataSetPropertyToOverride: {
5838
+ readonly NAME: "Name";
5838
5839
  };
5839
5840
  /**
5840
5841
  * @public
5841
5842
  */
5842
- export type AssetBundleExportFormat = (typeof AssetBundleExportFormat)[keyof typeof AssetBundleExportFormat];
5843
+ export type AssetBundleExportJobDataSetPropertyToOverride = (typeof AssetBundleExportJobDataSetPropertyToOverride)[keyof typeof AssetBundleExportJobDataSetPropertyToOverride];
5843
5844
  /**
5844
5845
  * @public
5845
- * <p>Describes an error that occurred during an Asset Bundle export job.</p>
5846
+ * <p>Controls how a specific <code>DataSet</code> resource is parameterized in the returned CloudFormation template.</p>
5846
5847
  */
5847
- export interface AssetBundleExportJobError {
5848
+ export interface AssetBundleExportJobDataSetOverrideProperties {
5848
5849
  /**
5849
- * <p>The ARN of the resource whose processing caused an error.</p>
5850
+ * <p>The ARN of the specific <code>DataSet</code> resource whose override properties are configured in this structure.</p>
5850
5851
  */
5851
5852
  Arn?: string;
5852
5853
  /**
5853
- * <p>The specific error type of the error that occurred.</p>
5854
- */
5855
- Type?: string;
5856
- /**
5857
- * <p>A description of the error.</p>
5854
+ * <p>A list of <code>DataSet</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5858
5855
  */
5859
- Message?: string;
5856
+ Properties: (AssetBundleExportJobDataSetPropertyToOverride | string)[] | undefined;
5860
5857
  }
5861
5858
  /**
5862
5859
  * @public
5863
5860
  * @enum
5864
5861
  */
5865
- export declare const AssetBundleExportJobStatus: {
5866
- readonly FAILED: "FAILED";
5867
- readonly IN_PROGRESS: "IN_PROGRESS";
5868
- readonly QUEUED_FOR_IMMEDIATE_EXECUTION: "QUEUED_FOR_IMMEDIATE_EXECUTION";
5869
- readonly SUCCESSFUL: "SUCCESSFUL";
5862
+ export declare const AssetBundleExportJobDataSourcePropertyToOverride: {
5863
+ readonly CATALOG: "Catalog";
5864
+ readonly CLUSTER_ID: "ClusterId";
5865
+ readonly DATABASE: "Database";
5866
+ readonly DATA_SET_NAME: "DataSetName";
5867
+ readonly DISABLE_SSL: "DisableSsl";
5868
+ readonly DOMAIN: "Domain";
5869
+ readonly HOST: "Host";
5870
+ readonly INSTANCE_ID: "InstanceId";
5871
+ readonly MANIFEST_FILE_LOCATION: "ManifestFileLocation";
5872
+ readonly NAME: "Name";
5873
+ readonly PASSWORD: "Password";
5874
+ readonly PORT: "Port";
5875
+ readonly ROLE_ARN: "RoleArn";
5876
+ readonly SECRET_ARN: "SecretArn";
5877
+ readonly USERNAME: "Username";
5878
+ readonly WAREHOUSE: "Warehouse";
5879
+ readonly WORK_GROUP: "WorkGroup";
5870
5880
  };
5871
5881
  /**
5872
5882
  * @public
5873
5883
  */
5874
- export type AssetBundleExportJobStatus = (typeof AssetBundleExportJobStatus)[keyof typeof AssetBundleExportJobStatus];
5884
+ export type AssetBundleExportJobDataSourcePropertyToOverride = (typeof AssetBundleExportJobDataSourcePropertyToOverride)[keyof typeof AssetBundleExportJobDataSourcePropertyToOverride];
5875
5885
  /**
5876
5886
  * @public
5877
- * <p>A summary of the export job that includes details of the job's configuration and its current status.</p>
5887
+ * <p>Controls how a specific <code>DataSource</code> resource is parameterized in the returned CloudFormation template.</p>
5878
5888
  */
5879
- export interface AssetBundleExportJobSummary {
5880
- /**
5881
- * <p>The current status of the export job.</p>
5882
- */
5883
- JobStatus?: AssetBundleExportJobStatus | string;
5889
+ export interface AssetBundleExportJobDataSourceOverrideProperties {
5884
5890
  /**
5885
- * <p>The ARN of the export job.</p>
5891
+ * <p>The ARN of the specific <code>DataSource</code> resource whose override properties are configured in this structure.</p>
5886
5892
  */
5887
5893
  Arn?: string;
5888
5894
  /**
5889
- * <p>The time that the export job was created.</p>
5890
- */
5891
- CreatedTime?: Date;
5892
- /**
5893
- * <p>The ID of the export job.</p>
5894
- */
5895
- AssetBundleExportJobId?: string;
5896
- /**
5897
- * <p>The flag that determines the inclusion of resource dependencies in the returned asset bundle.</p>
5898
- */
5899
- IncludeAllDependencies?: boolean;
5900
- /**
5901
- * <p>The format for the export job.</p>
5895
+ * <p>A list of <code>DataSource</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5902
5896
  */
5903
- ExportFormat?: AssetBundleExportFormat | string;
5897
+ Properties: (AssetBundleExportJobDataSourcePropertyToOverride | string)[] | undefined;
5904
5898
  }
5905
5899
  /**
5906
5900
  * @public
5907
5901
  * @enum
5908
5902
  */
5909
- export declare const AssetBundleImportFailureAction: {
5910
- readonly DO_NOTHING: "DO_NOTHING";
5911
- readonly ROLLBACK: "ROLLBACK";
5903
+ export declare const AssetBundleExportJobRefreshSchedulePropertyToOverride: {
5904
+ readonly START_AFTER_DATE_TIME: "StartAfterDateTime";
5912
5905
  };
5913
5906
  /**
5914
5907
  * @public
5915
5908
  */
5916
- export type AssetBundleImportFailureAction = (typeof AssetBundleImportFailureAction)[keyof typeof AssetBundleImportFailureAction];
5909
+ export type AssetBundleExportJobRefreshSchedulePropertyToOverride = (typeof AssetBundleExportJobRefreshSchedulePropertyToOverride)[keyof typeof AssetBundleExportJobRefreshSchedulePropertyToOverride];
5917
5910
  /**
5918
5911
  * @public
5919
- * <p>The override parameters for a single analysis that is being imported.</p>
5912
+ * <p>Controls how a specific <code>RefreshSchedule</code> resource is parameterized in the returned CloudFormation template.</p>
5920
5913
  */
5921
- export interface AssetBundleImportJobAnalysisOverrideParameters {
5914
+ export interface AssetBundleExportJobRefreshScheduleOverrideProperties {
5922
5915
  /**
5923
- * <p>The ID of the analysis that you ant to apply overrides to.</p>
5916
+ * <p>The ARN of the specific <code>RefreshSchedule</code> resource whose override properties are configured in this structure.</p>
5924
5917
  */
5925
- AnalysisId: string | undefined;
5918
+ Arn?: string;
5926
5919
  /**
5927
- * <p>A new name for the analysis.</p>
5920
+ * <p>A list of <code>RefreshSchedule</code> resource properties to generate variables for in the returned CloudFormation template.</p>
5928
5921
  */
5929
- Name?: string;
5922
+ Properties: (AssetBundleExportJobRefreshSchedulePropertyToOverride | string)[] | undefined;
5930
5923
  }
5931
5924
  /**
5932
5925
  * @public
5933
- * <p>The override parameters for a single dashboard that is being imported.</p>
5926
+ * <p>An optional structure that configures resource ID overrides for the export job.</p>
5934
5927
  */
5935
- export interface AssetBundleImportJobDashboardOverrideParameters {
5936
- /**
5937
- * <p>The ID of the dashboard that you want to apply overrides to.</p>
5938
- */
5939
- DashboardId: string | undefined;
5928
+ export interface AssetBundleExportJobResourceIdOverrideConfiguration {
5940
5929
  /**
5941
- * <p>A new name for the dashboard.</p>
5930
+ * <p>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</p>
5942
5931
  */
5943
- Name?: string;
5932
+ PrefixForAllResources?: boolean;
5944
5933
  }
5945
5934
  /**
5946
- * @public
5947
- * <p>The override parameters for a single dataset that is being imported.</p>
5935
+ * @internal
5948
5936
  */
5949
- export interface AssetBundleImportJobDataSetOverrideParameters {
5950
- /**
5951
- * <p>The ID of the dataset to apply overrides to.</p>
5952
- */
5953
- DataSetId: string | undefined;
5954
- /**
5955
- * <p>A new name for the dataset.</p>
5956
- */
5957
- Name?: string;
5958
- }
5937
+ export declare const BoxPlotAggregatedFieldWellsFilterSensitiveLog: (obj: BoxPlotAggregatedFieldWells) => any;
5938
+ /**
5939
+ * @internal
5940
+ */
5941
+ export declare const BoxPlotFieldWellsFilterSensitiveLog: (obj: BoxPlotFieldWells) => any;
5959
5942
  /**
5960
5943
  * @internal
5961
5944
  */
@@ -6488,3 +6471,15 @@ export declare const SheetDefinitionFilterSensitiveLog: (obj: SheetDefinition) =
6488
6471
  * @internal
6489
6472
  */
6490
6473
  export declare const AnalysisDefinitionFilterSensitiveLog: (obj: AnalysisDefinition) => any;
6474
+ /**
6475
+ * @internal
6476
+ */
6477
+ export declare const SnapshotJobS3ResultFilterSensitiveLog: (obj: SnapshotJobS3Result) => any;
6478
+ /**
6479
+ * @internal
6480
+ */
6481
+ export declare const SnapshotJobResultFileGroupFilterSensitiveLog: (obj: SnapshotJobResultFileGroup) => any;
6482
+ /**
6483
+ * @internal
6484
+ */
6485
+ export declare const AnonymousUserSnapshotJobResultFilterSensitiveLog: (obj: AnonymousUserSnapshotJobResult) => any;