@aws-sdk/client-quicksight 3.554.0 → 3.558.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 (46) hide show
  1. package/dist-cjs/index.js +16644 -16530
  2. package/dist-es/models/models_0.js +31 -51
  3. package/dist-es/models/models_1.js +21 -53
  4. package/dist-es/models/models_2.js +54 -25
  5. package/dist-es/models/models_3.js +25 -0
  6. package/dist-es/protocols/Aws_restJson1.js +115 -4
  7. package/dist-types/commands/CreateAnalysisCommand.d.ts +300 -0
  8. package/dist-types/commands/CreateDashboardCommand.d.ts +300 -0
  9. package/dist-types/commands/CreateTemplateCommand.d.ts +300 -0
  10. package/dist-types/commands/CreateThemeAliasCommand.d.ts +1 -1
  11. package/dist-types/commands/CreateThemeCommand.d.ts +1 -1
  12. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +300 -0
  13. package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +1 -1
  14. package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +6 -0
  15. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +300 -0
  16. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +300 -0
  17. package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
  19. package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
  20. package/dist-types/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
  21. package/dist-types/commands/ListIngestionsCommand.d.ts +1 -1
  22. package/dist-types/commands/ListNamespacesCommand.d.ts +1 -2
  23. package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +1 -1
  24. package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +52 -5
  25. package/dist-types/commands/UpdateAnalysisCommand.d.ts +300 -0
  26. package/dist-types/commands/UpdateDashboardCommand.d.ts +300 -0
  27. package/dist-types/commands/UpdateTemplateCommand.d.ts +300 -0
  28. package/dist-types/models/models_0.d.ts +717 -725
  29. package/dist-types/models/models_1.d.ts +286 -446
  30. package/dist-types/models/models_2.d.ts +463 -302
  31. package/dist-types/models/models_3.d.ts +316 -280
  32. package/dist-types/models/models_4.d.ts +280 -4
  33. package/dist-types/ts3.4/commands/CreateThemeAliasCommand.d.ts +1 -1
  34. package/dist-types/ts3.4/commands/CreateThemeCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/ListIngestionsCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +4 -2
  41. package/dist-types/ts3.4/models/models_0.d.ts +174 -190
  42. package/dist-types/ts3.4/models/models_1.d.ts +77 -134
  43. package/dist-types/ts3.4/models/models_2.d.ts +159 -91
  44. package/dist-types/ts3.4/models/models_3.d.ts +91 -72
  45. package/dist-types/ts3.4/models/models_4.d.ts +76 -3
  46. package/package.json +4 -4
@@ -420,6 +420,18 @@ declare const DescribeTemplateDefinitionCommand_base: {
420
420
  * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
421
421
  * // },
422
422
  * // },
423
+ * // CrossSheet: { // FilterCrossSheetControl
424
+ * // FilterControlId: "STRING_VALUE", // required
425
+ * // SourceFilterId: "STRING_VALUE", // required
426
+ * // CascadingControlConfiguration: {
427
+ * // SourceControls: [
428
+ * // {
429
+ * // SourceSheetControlId: "STRING_VALUE",
430
+ * // ColumnToMatch: "<ColumnIdentifier>",
431
+ * // },
432
+ * // ],
433
+ * // },
434
+ * // },
423
435
  * // },
424
436
  * // ],
425
437
  * // Visuals: [ // VisualList
@@ -4464,6 +4476,82 @@ declare const DescribeTemplateDefinitionCommand_base: {
4464
4476
  * // NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required
4465
4477
  * // },
4466
4478
  * // },
4479
+ * // DefaultFilterControlConfiguration: { // DefaultFilterControlConfiguration
4480
+ * // Title: "STRING_VALUE", // required
4481
+ * // ControlOptions: { // DefaultFilterControlOptions
4482
+ * // DefaultDateTimePickerOptions: { // DefaultDateTimePickerControlOptions
4483
+ * // Type: "SINGLE_VALUED" || "DATE_RANGE",
4484
+ * // DisplayOptions: {
4485
+ * // TitleOptions: "<LabelOptions>",
4486
+ * // DateTimeFormat: "STRING_VALUE",
4487
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4488
+ * // },
4489
+ * // },
4490
+ * // DefaultListOptions: { // DefaultFilterListControlOptions
4491
+ * // DisplayOptions: {
4492
+ * // SearchOptions: {
4493
+ * // Visibility: "HIDDEN" || "VISIBLE",
4494
+ * // },
4495
+ * // SelectAllOptions: {
4496
+ * // Visibility: "HIDDEN" || "VISIBLE",
4497
+ * // },
4498
+ * // TitleOptions: "<LabelOptions>",
4499
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4500
+ * // },
4501
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4502
+ * // SelectableValues: {
4503
+ * // Values: [
4504
+ * // "STRING_VALUE",
4505
+ * // ],
4506
+ * // },
4507
+ * // },
4508
+ * // DefaultDropdownOptions: { // DefaultFilterDropDownControlOptions
4509
+ * // DisplayOptions: {
4510
+ * // SelectAllOptions: "<ListControlSelectAllOptions>",
4511
+ * // TitleOptions: "<LabelOptions>",
4512
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4513
+ * // },
4514
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4515
+ * // SelectableValues: {
4516
+ * // Values: "<ParameterSelectableValueList>",
4517
+ * // },
4518
+ * // },
4519
+ * // DefaultTextFieldOptions: { // DefaultTextFieldControlOptions
4520
+ * // DisplayOptions: {
4521
+ * // TitleOptions: "<LabelOptions>",
4522
+ * // PlaceholderOptions: {
4523
+ * // Visibility: "HIDDEN" || "VISIBLE",
4524
+ * // },
4525
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4526
+ * // },
4527
+ * // },
4528
+ * // DefaultTextAreaOptions: { // DefaultTextAreaControlOptions
4529
+ * // Delimiter: "STRING_VALUE",
4530
+ * // DisplayOptions: {
4531
+ * // TitleOptions: "<LabelOptions>",
4532
+ * // PlaceholderOptions: "<TextControlPlaceholderOptions>",
4533
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4534
+ * // },
4535
+ * // },
4536
+ * // DefaultSliderOptions: { // DefaultSliderControlOptions
4537
+ * // DisplayOptions: {
4538
+ * // TitleOptions: "<LabelOptions>",
4539
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4540
+ * // },
4541
+ * // Type: "SINGLE_POINT" || "RANGE",
4542
+ * // MaximumValue: Number("double"), // required
4543
+ * // MinimumValue: Number("double"), // required
4544
+ * // StepSize: Number("double"), // required
4545
+ * // },
4546
+ * // DefaultRelativeDateTimeOptions: { // DefaultRelativeDateTimeControlOptions
4547
+ * // DisplayOptions: {
4548
+ * // TitleOptions: "<LabelOptions>",
4549
+ * // DateTimeFormat: "STRING_VALUE",
4550
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4551
+ * // },
4552
+ * // },
4553
+ * // },
4554
+ * // },
4467
4555
  * // },
4468
4556
  * // NumericRangeFilter: { // NumericRangeFilter
4469
4557
  * // FilterId: "STRING_VALUE", // required
@@ -4481,6 +4569,74 @@ declare const DescribeTemplateDefinitionCommand_base: {
4481
4569
  * // SelectAllOptions: "FILTER_ALL_VALUES",
4482
4570
  * // AggregationFunction: "<AggregationFunction>",
4483
4571
  * // NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required
4572
+ * // DefaultFilterControlConfiguration: {
4573
+ * // Title: "STRING_VALUE", // required
4574
+ * // ControlOptions: {
4575
+ * // DefaultDateTimePickerOptions: {
4576
+ * // Type: "SINGLE_VALUED" || "DATE_RANGE",
4577
+ * // DisplayOptions: {
4578
+ * // TitleOptions: "<LabelOptions>",
4579
+ * // DateTimeFormat: "STRING_VALUE",
4580
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4581
+ * // },
4582
+ * // },
4583
+ * // DefaultListOptions: {
4584
+ * // DisplayOptions: {
4585
+ * // SearchOptions: {
4586
+ * // Visibility: "HIDDEN" || "VISIBLE",
4587
+ * // },
4588
+ * // SelectAllOptions: "<ListControlSelectAllOptions>",
4589
+ * // TitleOptions: "<LabelOptions>",
4590
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4591
+ * // },
4592
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4593
+ * // SelectableValues: {
4594
+ * // Values: "<ParameterSelectableValueList>",
4595
+ * // },
4596
+ * // },
4597
+ * // DefaultDropdownOptions: {
4598
+ * // DisplayOptions: {
4599
+ * // SelectAllOptions: "<ListControlSelectAllOptions>",
4600
+ * // TitleOptions: "<LabelOptions>",
4601
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4602
+ * // },
4603
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4604
+ * // SelectableValues: "<FilterSelectableValues>",
4605
+ * // },
4606
+ * // DefaultTextFieldOptions: {
4607
+ * // DisplayOptions: {
4608
+ * // TitleOptions: "<LabelOptions>",
4609
+ * // PlaceholderOptions: "<TextControlPlaceholderOptions>",
4610
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4611
+ * // },
4612
+ * // },
4613
+ * // DefaultTextAreaOptions: {
4614
+ * // Delimiter: "STRING_VALUE",
4615
+ * // DisplayOptions: {
4616
+ * // TitleOptions: "<LabelOptions>",
4617
+ * // PlaceholderOptions: "<TextControlPlaceholderOptions>",
4618
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4619
+ * // },
4620
+ * // },
4621
+ * // DefaultSliderOptions: {
4622
+ * // DisplayOptions: {
4623
+ * // TitleOptions: "<LabelOptions>",
4624
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4625
+ * // },
4626
+ * // Type: "SINGLE_POINT" || "RANGE",
4627
+ * // MaximumValue: Number("double"), // required
4628
+ * // MinimumValue: Number("double"), // required
4629
+ * // StepSize: Number("double"), // required
4630
+ * // },
4631
+ * // DefaultRelativeDateTimeOptions: {
4632
+ * // DisplayOptions: {
4633
+ * // TitleOptions: "<LabelOptions>",
4634
+ * // DateTimeFormat: "STRING_VALUE",
4635
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4636
+ * // },
4637
+ * // },
4638
+ * // },
4639
+ * // },
4484
4640
  * // },
4485
4641
  * // NumericEqualityFilter: { // NumericEqualityFilter
4486
4642
  * // FilterId: "STRING_VALUE", // required
@@ -4491,6 +4647,72 @@ declare const DescribeTemplateDefinitionCommand_base: {
4491
4647
  * // AggregationFunction: "<AggregationFunction>",
4492
4648
  * // ParameterName: "STRING_VALUE",
4493
4649
  * // NullOption: "ALL_VALUES" || "NULLS_ONLY" || "NON_NULLS_ONLY", // required
4650
+ * // DefaultFilterControlConfiguration: {
4651
+ * // Title: "STRING_VALUE", // required
4652
+ * // ControlOptions: {
4653
+ * // DefaultDateTimePickerOptions: {
4654
+ * // Type: "SINGLE_VALUED" || "DATE_RANGE",
4655
+ * // DisplayOptions: {
4656
+ * // TitleOptions: "<LabelOptions>",
4657
+ * // DateTimeFormat: "STRING_VALUE",
4658
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4659
+ * // },
4660
+ * // },
4661
+ * // DefaultListOptions: {
4662
+ * // DisplayOptions: {
4663
+ * // SearchOptions: {
4664
+ * // Visibility: "HIDDEN" || "VISIBLE",
4665
+ * // },
4666
+ * // SelectAllOptions: "<ListControlSelectAllOptions>",
4667
+ * // TitleOptions: "<LabelOptions>",
4668
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4669
+ * // },
4670
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4671
+ * // SelectableValues: "<FilterSelectableValues>",
4672
+ * // },
4673
+ * // DefaultDropdownOptions: {
4674
+ * // DisplayOptions: {
4675
+ * // SelectAllOptions: "<ListControlSelectAllOptions>",
4676
+ * // TitleOptions: "<LabelOptions>",
4677
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4678
+ * // },
4679
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4680
+ * // SelectableValues: "<FilterSelectableValues>",
4681
+ * // },
4682
+ * // DefaultTextFieldOptions: {
4683
+ * // DisplayOptions: {
4684
+ * // TitleOptions: "<LabelOptions>",
4685
+ * // PlaceholderOptions: "<TextControlPlaceholderOptions>",
4686
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4687
+ * // },
4688
+ * // },
4689
+ * // DefaultTextAreaOptions: {
4690
+ * // Delimiter: "STRING_VALUE",
4691
+ * // DisplayOptions: {
4692
+ * // TitleOptions: "<LabelOptions>",
4693
+ * // PlaceholderOptions: "<TextControlPlaceholderOptions>",
4694
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4695
+ * // },
4696
+ * // },
4697
+ * // DefaultSliderOptions: {
4698
+ * // DisplayOptions: {
4699
+ * // TitleOptions: "<LabelOptions>",
4700
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4701
+ * // },
4702
+ * // Type: "SINGLE_POINT" || "RANGE",
4703
+ * // MaximumValue: Number("double"), // required
4704
+ * // MinimumValue: Number("double"), // required
4705
+ * // StepSize: Number("double"), // required
4706
+ * // },
4707
+ * // DefaultRelativeDateTimeOptions: {
4708
+ * // DisplayOptions: {
4709
+ * // TitleOptions: "<LabelOptions>",
4710
+ * // DateTimeFormat: "STRING_VALUE",
4711
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4712
+ * // },
4713
+ * // },
4714
+ * // },
4715
+ * // },
4494
4716
  * // },
4495
4717
  * // TimeEqualityFilter: { // TimeEqualityFilter
4496
4718
  * // FilterId: "STRING_VALUE", // required
@@ -4502,6 +4724,46 @@ declare const DescribeTemplateDefinitionCommand_base: {
4502
4724
  * // DataSetIdentifier: "STRING_VALUE",
4503
4725
  * // Expression: "STRING_VALUE", // required
4504
4726
  * // },
4727
+ * // DefaultFilterControlConfiguration: {
4728
+ * // Title: "STRING_VALUE", // required
4729
+ * // ControlOptions: {
4730
+ * // DefaultDateTimePickerOptions: {
4731
+ * // Type: "SINGLE_VALUED" || "DATE_RANGE",
4732
+ * // DisplayOptions: "<DateTimePickerControlDisplayOptions>",
4733
+ * // },
4734
+ * // DefaultListOptions: {
4735
+ * // DisplayOptions: "<ListControlDisplayOptions>",
4736
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4737
+ * // SelectableValues: "<FilterSelectableValues>",
4738
+ * // },
4739
+ * // DefaultDropdownOptions: {
4740
+ * // DisplayOptions: "<DropDownControlDisplayOptions>",
4741
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4742
+ * // SelectableValues: "<FilterSelectableValues>",
4743
+ * // },
4744
+ * // DefaultTextFieldOptions: {
4745
+ * // DisplayOptions: "<TextFieldControlDisplayOptions>",
4746
+ * // },
4747
+ * // DefaultTextAreaOptions: {
4748
+ * // Delimiter: "STRING_VALUE",
4749
+ * // DisplayOptions: "<TextAreaControlDisplayOptions>",
4750
+ * // },
4751
+ * // DefaultSliderOptions: {
4752
+ * // DisplayOptions: "<SliderControlDisplayOptions>",
4753
+ * // Type: "SINGLE_POINT" || "RANGE",
4754
+ * // MaximumValue: Number("double"), // required
4755
+ * // MinimumValue: Number("double"), // required
4756
+ * // StepSize: Number("double"), // required
4757
+ * // },
4758
+ * // DefaultRelativeDateTimeOptions: {
4759
+ * // DisplayOptions: {
4760
+ * // TitleOptions: "<LabelOptions>",
4761
+ * // DateTimeFormat: "STRING_VALUE",
4762
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
4763
+ * // },
4764
+ * // },
4765
+ * // },
4766
+ * // },
4505
4767
  * // },
4506
4768
  * // TimeRangeFilter: { // TimeRangeFilter
4507
4769
  * // FilterId: "STRING_VALUE", // required
@@ -4525,6 +4787,42 @@ declare const DescribeTemplateDefinitionCommand_base: {
4525
4787
  * // Status: "ENABLED" || "DISABLED",
4526
4788
  * // },
4527
4789
  * // TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND",
4790
+ * // DefaultFilterControlConfiguration: {
4791
+ * // Title: "STRING_VALUE", // required
4792
+ * // ControlOptions: {
4793
+ * // DefaultDateTimePickerOptions: {
4794
+ * // Type: "SINGLE_VALUED" || "DATE_RANGE",
4795
+ * // DisplayOptions: "<DateTimePickerControlDisplayOptions>",
4796
+ * // },
4797
+ * // DefaultListOptions: {
4798
+ * // DisplayOptions: "<ListControlDisplayOptions>",
4799
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4800
+ * // SelectableValues: "<FilterSelectableValues>",
4801
+ * // },
4802
+ * // DefaultDropdownOptions: {
4803
+ * // DisplayOptions: "<DropDownControlDisplayOptions>",
4804
+ * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
4805
+ * // SelectableValues: "<FilterSelectableValues>",
4806
+ * // },
4807
+ * // DefaultTextFieldOptions: {
4808
+ * // DisplayOptions: "<TextFieldControlDisplayOptions>",
4809
+ * // },
4810
+ * // DefaultTextAreaOptions: {
4811
+ * // Delimiter: "STRING_VALUE",
4812
+ * // DisplayOptions: "<TextAreaControlDisplayOptions>",
4813
+ * // },
4814
+ * // DefaultSliderOptions: {
4815
+ * // DisplayOptions: "<SliderControlDisplayOptions>",
4816
+ * // Type: "SINGLE_POINT" || "RANGE",
4817
+ * // MaximumValue: Number("double"), // required
4818
+ * // MinimumValue: Number("double"), // required
4819
+ * // StepSize: Number("double"), // required
4820
+ * // },
4821
+ * // DefaultRelativeDateTimeOptions: {
4822
+ * // DisplayOptions: "<RelativeDateTimeControlDisplayOptions>",
4823
+ * // },
4824
+ * // },
4825
+ * // },
4528
4826
  * // },
4529
4827
  * // RelativeDatesFilter: { // RelativeDatesFilter
4530
4828
  * // FilterId: "STRING_VALUE", // required
@@ -4544,6 +4842,7 @@ declare const DescribeTemplateDefinitionCommand_base: {
4544
4842
  * // Granularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND", // required
4545
4843
  * // Status: "ENABLED" || "DISABLED",
4546
4844
  * // },
4845
+ * // DefaultFilterControlConfiguration: "<DefaultFilterControlConfiguration>",
4547
4846
  * // },
4548
4847
  * // TopBottomFilter: { // TopBottomFilter
4549
4848
  * // FilterId: "STRING_VALUE", // required
@@ -4558,6 +4857,7 @@ declare const DescribeTemplateDefinitionCommand_base: {
4558
4857
  * // ],
4559
4858
  * // TimeGranularity: "YEAR" || "QUARTER" || "MONTH" || "WEEK" || "DAY" || "HOUR" || "MINUTE" || "SECOND" || "MILLISECOND",
4560
4859
  * // ParameterName: "STRING_VALUE",
4860
+ * // DefaultFilterControlConfiguration: "<DefaultFilterControlConfiguration>",
4561
4861
  * // },
4562
4862
  * // },
4563
4863
  * // ],
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListGroupsRequest, ListGroupsResponse } from "../models/models_3";
3
+ import { ListGroupsRequest, ListGroupsResponse } from "../models/models_4";
4
4
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListIAMPolicyAssignmentsRequest, ListIAMPolicyAssignmentsResponse } from "../models/models_3";
3
+ import { ListIAMPolicyAssignmentsRequest, ListIAMPolicyAssignmentsResponse } from "../models/models_4";
4
4
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListIAMPolicyAssignmentsForUserRequest, ListIAMPolicyAssignmentsForUserResponse } from "../models/models_3";
3
+ import { ListIAMPolicyAssignmentsForUserRequest, ListIAMPolicyAssignmentsForUserResponse } from "../models/models_4";
4
4
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListIdentityPropagationConfigsRequest, ListIdentityPropagationConfigsResponse } from "../models/models_3";
3
+ import { ListIdentityPropagationConfigsRequest, ListIdentityPropagationConfigsResponse } from "../models/models_4";
4
4
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListIngestionsRequest, ListIngestionsResponse } from "../models/models_3";
3
+ import { ListIngestionsRequest, ListIngestionsResponse } from "../models/models_4";
4
4
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
5
5
  /**
6
6
  * @public
@@ -1,7 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListNamespacesRequest } from "../models/models_3";
4
- import { ListNamespacesResponse } from "../models/models_4";
3
+ import { ListNamespacesRequest, ListNamespacesResponse } from "../models/models_4";
5
4
  import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
5
  /**
7
6
  * @public
@@ -67,7 +67,7 @@ declare const StartAssetBundleExportJobCommand_base: {
67
67
  * { // AssetBundleExportJobDataSourceOverrideProperties
68
68
  * Arn: "STRING_VALUE", // required
69
69
  * Properties: [ // AssetBundleExportJobDataSourcePropertyToOverrideList // required
70
- * "Name" || "DisableSsl" || "SecretArn" || "Username" || "Password" || "Domain" || "WorkGroup" || "Host" || "Port" || "Database" || "DataSetName" || "Catalog" || "InstanceId" || "ClusterId" || "ManifestFileLocation" || "Warehouse" || "RoleArn",
70
+ * "Name" || "DisableSsl" || "SecretArn" || "Username" || "Password" || "Domain" || "WorkGroup" || "Host" || "Port" || "Database" || "DataSetName" || "Catalog" || "InstanceId" || "ClusterId" || "ManifestFileLocation" || "Warehouse" || "RoleArn" || "ProductType",
71
71
  * ],
72
72
  * },
73
73
  * ],
@@ -26,19 +26,66 @@ declare const StartDashboardSnapshotJobCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.</p>
29
+ * <p>Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.</p>
30
30
  * <ul>
31
31
  * <li>
32
- * <p>1 paginated PDF</p>
32
+ * <p>1 Paginated PDF</p>
33
33
  * </li>
34
34
  * <li>
35
- * <p>1 Excel workbook</p>
35
+ * <p>1 Excel workbook that includes up to 5 table or pivot table visuals</p>
36
36
  * </li>
37
37
  * <li>
38
- * <p>5 CSVs</p>
38
+ * <p>5 CSVs from table or pivot table visuals</p>
39
+ * </li>
40
+ * </ul>
41
+ * <p>The status of a submitted job can be polled with the <code>DescribeDashboardSnapshotJob</code> API. When you call the <code>DescribeDashboardSnapshotJob</code> API, check the <code>JobStatus</code> field in the response. Once the job reaches a <code>COMPLETED</code> or <code>FAILED</code> status, use the <code>DescribeDashboardSnapshotJobResult</code> API to obtain the URLs for the generated files. If the job fails, the <code>DescribeDashboardSnapshotJobResult</code> API returns detailed information about the error that occurred.</p>
42
+ * <p>
43
+ * <b>StartDashboardSnapshotJob API throttling</b>
44
+ * </p>
45
+ * <p>Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the <code>StartDashboardSnapshotJob</code>. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.</p>
46
+ * <p>
47
+ * <b>Common throttling scenarios</b>
48
+ * </p>
49
+ * <p>The following list provides information about the most commin throttling scenarios that can occur.</p>
50
+ * <ul>
51
+ * <li>
52
+ * <p>
53
+ * <b>A large number of <code>SnapshotExport</code> API jobs are running simultaneously on an Amazon Web Services account.</b> When a new <code>StartDashboardSnapshotJob</code> is created and there are already 12 jobs with the <code>RUNNING</code> status, the new job request fails and returns a <code>LimitExceededException</code> error. Wait for a current job to comlpete before you resubmit the new job.</p>
54
+ * </li>
55
+ * <li>
56
+ * <p>
57
+ * <b>A large number of API requests are submitted on an Amazon Web Services account.</b> When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a <code>ThrottlingException</code> is returned.</p>
58
+ * </li>
59
+ * </ul>
60
+ * <p>If your use case requires a higher throttling limit, contact your account admin or <a href="http://aws.amazon.com/contact-us/">Amazon Web ServicesSupport</a> to explore options to tailor a more optimal expereince for your account.</p>
61
+ * <p>
62
+ * <b>Best practices to handle throttling</b>
63
+ * </p>
64
+ * <p>If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example <code>(12 minutes * 9 = 108 minutes)</code>. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.</p>
65
+ * <p>The time that it takes to process a job can be impacted by the following factors:</p>
66
+ * <ul>
67
+ * <li>
68
+ * <p>The dataset type (Direct Query or SPICE).</p>
69
+ * </li>
70
+ * <li>
71
+ * <p>The size of the dataset.</p>
72
+ * </li>
73
+ * <li>
74
+ * <p>The complexity of the calculated fields that are used in the dashboard.</p>
75
+ * </li>
76
+ * <li>
77
+ * <p>The number of visuals that are on a sheet.</p>
78
+ * </li>
79
+ * <li>
80
+ * <p>The types of visuals that are on the sheet.</p>
81
+ * </li>
82
+ * <li>
83
+ * <p>The number of formats and snapshots that are requested in the job configuration.</p>
84
+ * </li>
85
+ * <li>
86
+ * <p>The size of the generated snapshots.</p>
39
87
  * </li>
40
88
  * </ul>
41
- * <p>Poll job descriptions with a <code>DescribeDashboardSnapshotJob</code> API call. Once the job succeeds, use the <code>DescribeDashboardSnapshotJobResult</code> API to obtain the download URIs that the job generates.</p>
42
89
  * @example
43
90
  * Use a bare-bones client and the command you need to make an API call.
44
91
  * ```javascript