@aws-sdk/client-quicksight 3.565.0 → 3.567.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 (56) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/index.js +76 -6
  3. package/dist-es/QuickSight.js +2 -0
  4. package/dist-es/commands/UpdateSPICECapacityConfigurationCommand.js +24 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/models_1.js +0 -4
  7. package/dist-es/models/models_2.js +7 -0
  8. package/dist-es/models/models_3.js +3 -0
  9. package/dist-es/models/models_4.js +4 -0
  10. package/dist-es/protocols/Aws_restJson1.js +36 -0
  11. package/dist-types/QuickSight.d.ts +7 -0
  12. package/dist-types/QuickSightClient.d.ts +3 -2
  13. package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +8 -1
  14. package/dist-types/commands/CreateAnalysisCommand.d.ts +4 -0
  15. package/dist-types/commands/CreateDashboardCommand.d.ts +4 -0
  16. package/dist-types/commands/CreateRoleMembershipCommand.d.ts +1 -1
  17. package/dist-types/commands/CreateTemplateCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteRoleCustomPermissionCommand.d.ts +1 -1
  19. package/dist-types/commands/DeleteRoleMembershipCommand.d.ts +1 -1
  20. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +4 -0
  21. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +4 -0
  22. package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +4 -0
  24. package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
  25. package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +3 -0
  26. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +3 -0
  27. package/dist-types/commands/ListFoldersCommand.d.ts +2 -1
  28. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +1 -1
  29. package/dist-types/commands/ListRoleMembershipsCommand.d.ts +1 -1
  30. package/dist-types/commands/ListTopicsCommand.d.ts +1 -0
  31. package/dist-types/commands/ListUsersCommand.d.ts +1 -1
  32. package/dist-types/commands/RegisterUserCommand.d.ts +2 -2
  33. package/dist-types/commands/UpdateAnalysisCommand.d.ts +4 -0
  34. package/dist-types/commands/UpdateDashboardCommand.d.ts +4 -0
  35. package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +79 -0
  37. package/dist-types/commands/UpdateTemplateCommand.d.ts +4 -0
  38. package/dist-types/commands/UpdateUserCommand.d.ts +2 -2
  39. package/dist-types/commands/index.d.ts +1 -0
  40. package/dist-types/models/models_1.d.ts +21 -12
  41. package/dist-types/models/models_2.d.ts +55 -133
  42. package/dist-types/models/models_3.d.ts +170 -90
  43. package/dist-types/models/models_4.d.ts +154 -17
  44. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  45. package/dist-types/ts3.4/QuickSight.d.ts +17 -0
  46. package/dist-types/ts3.4/QuickSightClient.d.ts +6 -0
  47. package/dist-types/ts3.4/commands/ListFoldersCommand.d.ts +2 -1
  48. package/dist-types/ts3.4/commands/ListGroupMembershipsCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/UpdateSPICECapacityConfigurationCommand.d.ts +39 -0
  50. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  51. package/dist-types/ts3.4/models/models_1.d.ts +5 -6
  52. package/dist-types/ts3.4/models/models_2.d.ts +17 -26
  53. package/dist-types/ts3.4/models/models_3.d.ts +34 -20
  54. package/dist-types/ts3.4/models/models_4.d.ts +36 -1
  55. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  56. package/package.json +14 -15
@@ -1,7 +1,135 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { AccountCustomization, AccountInfo, AccountSettings, Analysis, AnalysisError, Entity, NumberScale, ResourceStatus, Sheet } from "./models_0";
3
- import { _Parameters, AnalysisDefinition, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, AssignmentStatus, AuthorSpecifiedAggregation, BookmarksConfigurations, CategoryFilterFunction, CategoryFilterType, CellValueSynonym, CollectiveConstant, ColumnDataRole, ColumnDataSubType, ColumnDataType, ColumnGroup, ColumnLevelPermissionRule, ComparativeOrder, ConstantType, DashboardPublishOptions, DashboardVersionDefinition, DashboardVisualId, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, DataSourceType, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LinkSharingConfiguration, LogicalTable, MemberType, NamespaceStatus, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SharingModel, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Tag, TemplateAlias, TemplateVersionDefinition, ThemeConfiguration, VpcConnectionProperties } from "./models_2";
3
+ import { _Parameters, AnalysisDefinition, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportJobWarning, AssetBundleImportSourceDescription, AssignmentStatus, AuthorSpecifiedAggregation, BookmarksConfigurations, CategoryFilterFunction, CategoryFilterType, CellValueSynonym, CollectiveConstant, ColumnDataRole, ColumnDataSubType, ColumnDataType, ColumnGroup, ColumnLevelPermissionRule, ComparativeOrder, ConstantType, DashboardPublishOptions, DashboardVersionDefinition, DashboardVisualId, DataColorPalette, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, DataSourceType, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LinkSharingConfiguration, LogicalTable, MemberType, NamespaceStatus, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SharingModel, SheetStyle, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Tag, TemplateAlias, TemplateVersionDefinition, Typography, VpcConnectionProperties } from "./models_2";
4
4
  import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
5
+ /**
6
+ * <p>The theme colors that apply to UI and to charts, excluding data colors. The colors
7
+ * description is a hexadecimal color code that consists of six alphanumerical characters,
8
+ * prefixed with <code>#</code>, for example #37BFF5. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User
9
+ * Guide.</i>
10
+ * </p>
11
+ * @public
12
+ */
13
+ export interface UIColorPalette {
14
+ /**
15
+ * <p>The color of text and other foreground elements that appear over the primary
16
+ * background regions, such as grid lines, borders, table banding, icons, and so on.</p>
17
+ * @public
18
+ */
19
+ PrimaryForeground?: string;
20
+ /**
21
+ * <p>The background color that applies to visuals and other high emphasis UI.</p>
22
+ * @public
23
+ */
24
+ PrimaryBackground?: string;
25
+ /**
26
+ * <p>The foreground color that applies to any sheet title, sheet control text, or UI that
27
+ * appears over the secondary background.</p>
28
+ * @public
29
+ */
30
+ SecondaryForeground?: string;
31
+ /**
32
+ * <p>The background color that applies to the sheet background and sheet controls.</p>
33
+ * @public
34
+ */
35
+ SecondaryBackground?: string;
36
+ /**
37
+ * <p>This color is that applies to selected states and buttons.</p>
38
+ * @public
39
+ */
40
+ Accent?: string;
41
+ /**
42
+ * <p>The foreground color that applies to any text or other elements that appear over the
43
+ * accent color.</p>
44
+ * @public
45
+ */
46
+ AccentForeground?: string;
47
+ /**
48
+ * <p>The color that applies to error messages.</p>
49
+ * @public
50
+ */
51
+ Danger?: string;
52
+ /**
53
+ * <p>The foreground color that applies to any text or other elements that appear over the
54
+ * error color.</p>
55
+ * @public
56
+ */
57
+ DangerForeground?: string;
58
+ /**
59
+ * <p>This color that applies to warning and informational messages.</p>
60
+ * @public
61
+ */
62
+ Warning?: string;
63
+ /**
64
+ * <p>The foreground color that applies to any text or other elements that appear over the
65
+ * warning color.</p>
66
+ * @public
67
+ */
68
+ WarningForeground?: string;
69
+ /**
70
+ * <p>The color that applies to success messages, for example the check mark for a
71
+ * successful download.</p>
72
+ * @public
73
+ */
74
+ Success?: string;
75
+ /**
76
+ * <p>The foreground color that applies to any text or other elements that appear over the
77
+ * success color.</p>
78
+ * @public
79
+ */
80
+ SuccessForeground?: string;
81
+ /**
82
+ * <p>The color that applies to the names of fields that are identified as
83
+ * dimensions.</p>
84
+ * @public
85
+ */
86
+ Dimension?: string;
87
+ /**
88
+ * <p>The foreground color that applies to any text or other elements that appear over the
89
+ * dimension color.</p>
90
+ * @public
91
+ */
92
+ DimensionForeground?: string;
93
+ /**
94
+ * <p>The color that applies to the names of fields that are identified as measures.</p>
95
+ * @public
96
+ */
97
+ Measure?: string;
98
+ /**
99
+ * <p>The foreground color that applies to any text or other elements that appear over the
100
+ * measure color.</p>
101
+ * @public
102
+ */
103
+ MeasureForeground?: string;
104
+ }
105
+ /**
106
+ * <p>The theme configuration. This configuration contains all of the display properties for
107
+ * a theme.</p>
108
+ * @public
109
+ */
110
+ export interface ThemeConfiguration {
111
+ /**
112
+ * <p>Color properties that apply to chart data colors.</p>
113
+ * @public
114
+ */
115
+ DataColorPalette?: DataColorPalette;
116
+ /**
117
+ * <p>Color properties that apply to the UI and to charts, excluding the colors that apply
118
+ * to data. </p>
119
+ * @public
120
+ */
121
+ UIColorPalette?: UIColorPalette;
122
+ /**
123
+ * <p>Display options related to sheets.</p>
124
+ * @public
125
+ */
126
+ Sheet?: SheetStyle;
127
+ /**
128
+ * <p>Determines the typography options.</p>
129
+ * @public
130
+ */
131
+ Typography?: Typography;
132
+ }
5
133
  /**
6
134
  * @public
7
135
  */
@@ -6427,8 +6555,11 @@ export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
6427
6555
  */
6428
6556
  export declare const UserRole: {
6429
6557
  readonly ADMIN: "ADMIN";
6558
+ readonly ADMIN_PRO: "ADMIN_PRO";
6430
6559
  readonly AUTHOR: "AUTHOR";
6560
+ readonly AUTHOR_PRO: "AUTHOR_PRO";
6431
6561
  readonly READER: "READER";
6562
+ readonly READER_PRO: "READER_PRO";
6432
6563
  readonly RESTRICTED_AUTHOR: "RESTRICTED_AUTHOR";
6433
6564
  readonly RESTRICTED_READER: "RESTRICTED_READER";
6434
6565
  };
@@ -6478,6 +6609,18 @@ export interface User {
6478
6609
  * </li>
6479
6610
  * <li>
6480
6611
  * <p>
6612
+ * <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
6613
+ * </li>
6614
+ * <li>
6615
+ * <p>
6616
+ * <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
6617
+ * </li>
6618
+ * <li>
6619
+ * <p>
6620
+ * <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
6621
+ * </li>
6622
+ * <li>
6623
+ * <p>
6481
6624
  * <code>RESTRICTED_READER</code>: This role isn't currently available for
6482
6625
  * use.</p>
6483
6626
  * </li>
@@ -7070,18 +7213,29 @@ export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
7070
7213
  */
7071
7214
  InitialDashboardVisualId: DashboardVisualId | undefined;
7072
7215
  }
7216
+ /**
7217
+ * <p>An object that provides information about the configuration of a Generative Q&A experience.</p>
7218
+ * @public
7219
+ */
7220
+ export interface RegisteredUserGenerativeQnAEmbeddingConfiguration {
7221
+ /**
7222
+ * <p>The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.
7223
+ * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
7224
+ * a topic. The ID is in the URL for the topic that you open.</p>
7225
+ * <p>If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.</p>
7226
+ * @public
7227
+ */
7228
+ InitialTopicId?: string;
7229
+ }
7073
7230
  /**
7074
7231
  * <p>Information about the Q search bar embedding experience.</p>
7075
7232
  * @public
7076
7233
  */
7077
7234
  export interface RegisteredUserQSearchBarEmbeddingConfiguration {
7078
7235
  /**
7079
- * <p>The ID of the Q topic that you want to make the starting topic in the Q search bar.
7080
- * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
7081
- * a topic. The ID is in the URL for the topic that you open.</p>
7082
- * <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar
7083
- * for your readers. When you select an initial topic, you can specify whether or not readers
7084
- * are allowed to select other topics from the available ones in the list.</p>
7236
+ * <p>The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the <a href="https://quicksight.aws.amazon.com/">Amazon QuickSight console</a>, navigate to the <b>Topics</b> pane, and choose thre topic that you want to use. The <code>TopicID</code> is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers
7237
+ * are allowed to select other topics from the list of available topics.</p>
7238
+ * <p>If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar. </p>
7085
7239
  * @public
7086
7240
  */
7087
7241
  InitialTopicId?: string;
@@ -7205,6 +7359,13 @@ export interface RegisteredUserEmbeddingExperienceConfiguration {
7205
7359
  * @public
7206
7360
  */
7207
7361
  DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
7362
+ /**
7363
+ * <p>The configuration details for embedding the Generative Q&A experience.</p>
7364
+ * <p>For more information about embedding the Generative Q&A experience, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a> in
7365
+ * the <i>Amazon QuickSight User Guide</i>.</p>
7366
+ * @public
7367
+ */
7368
+ GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration;
7208
7369
  }
7209
7370
  /**
7210
7371
  * @public
@@ -7226,7 +7387,7 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
7226
7387
  */
7227
7388
  UserArn: string | undefined;
7228
7389
  /**
7229
- * <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.</p>
7390
+ * <p>The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.</p>
7230
7391
  * @public
7231
7392
  */
7232
7393
  ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
@@ -7248,7 +7409,7 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
7248
7409
  */
7249
7410
  export interface GenerateEmbedUrlForRegisteredUserResponse {
7250
7411
  /**
7251
- * <p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.</p>
7412
+ * <p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.</p>
7252
7413
  * @public
7253
7414
  */
7254
7415
  EmbedUrl: string | undefined;
@@ -7979,87 +8140,6 @@ export interface ListFoldersRequest {
7979
8140
  */
7980
8141
  MaxResults?: number;
7981
8142
  }
7982
- /**
7983
- * @public
7984
- */
7985
- export interface ListFoldersResponse {
7986
- /**
7987
- * <p>The HTTP status of the request.</p>
7988
- * @public
7989
- */
7990
- Status?: number;
7991
- /**
7992
- * <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
7993
- * @public
7994
- */
7995
- FolderSummaryList?: FolderSummary[];
7996
- /**
7997
- * <p>The token for the next set of results, or null if there are no more results.</p>
7998
- * @public
7999
- */
8000
- NextToken?: string;
8001
- /**
8002
- * <p>The Amazon Web Services request ID for this operation.</p>
8003
- * @public
8004
- */
8005
- RequestId?: string;
8006
- }
8007
- /**
8008
- * @public
8009
- */
8010
- export interface ListGroupMembershipsRequest {
8011
- /**
8012
- * <p>The name of the group that you want to see a membership list of.</p>
8013
- * @public
8014
- */
8015
- GroupName: string | undefined;
8016
- /**
8017
- * <p>A pagination token that can be used in a subsequent request.</p>
8018
- * @public
8019
- */
8020
- NextToken?: string;
8021
- /**
8022
- * <p>The maximum number of results to return from this request.</p>
8023
- * @public
8024
- */
8025
- MaxResults?: number;
8026
- /**
8027
- * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
8028
- * Amazon Web Services account that contains your Amazon QuickSight account.</p>
8029
- * @public
8030
- */
8031
- AwsAccountId: string | undefined;
8032
- /**
8033
- * <p>The namespace of the group that you want a list of users from.</p>
8034
- * @public
8035
- */
8036
- Namespace: string | undefined;
8037
- }
8038
- /**
8039
- * @public
8040
- */
8041
- export interface ListGroupMembershipsResponse {
8042
- /**
8043
- * <p>The list of the members of the group.</p>
8044
- * @public
8045
- */
8046
- GroupMemberList?: GroupMember[];
8047
- /**
8048
- * <p>A pagination token that can be used in a subsequent request.</p>
8049
- * @public
8050
- */
8051
- NextToken?: string;
8052
- /**
8053
- * <p>The Amazon Web Services request ID for this operation.</p>
8054
- * @public
8055
- */
8056
- RequestId?: string;
8057
- /**
8058
- * <p>The HTTP status of the request.</p>
8059
- * @public
8060
- */
8061
- Status?: number;
8062
- }
8063
8143
  /**
8064
8144
  * @internal
8065
8145
  */
@@ -1,6 +1,87 @@
1
1
  import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
2
- import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeConfiguration, ValidationStrategy, VpcConnectionProperties } from "./models_2";
3
- import { DashboardSearchFilter, DashboardSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSourceSearchFilter, DataSourceSummary, FolderSearchFilter, FolderSummary, GroupSearchFilter, IAMPolicyAssignmentSummary, IdentityType, Ingestion, NamespaceInfoV2, NetworkInterface, SessionTag, SnapshotConfiguration, ThemeAlias, ThemeType, TopicDetails, TopicRefreshSchedule, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
2
+ import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, GroupMember, LinkSharingConfiguration, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ValidationStrategy, VpcConnectionProperties } from "./models_2";
3
+ import { DashboardSearchFilter, DashboardSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSourceSearchFilter, DataSourceSummary, FolderSearchFilter, FolderSummary, GroupSearchFilter, IAMPolicyAssignmentSummary, IdentityType, Ingestion, NamespaceInfoV2, NetworkInterface, SessionTag, SnapshotConfiguration, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface ListFoldersResponse {
8
+ /**
9
+ * <p>The HTTP status of the request.</p>
10
+ * @public
11
+ */
12
+ Status?: number;
13
+ /**
14
+ * <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
15
+ * @public
16
+ */
17
+ FolderSummaryList?: FolderSummary[];
18
+ /**
19
+ * <p>The token for the next set of results, or null if there are no more results.</p>
20
+ * @public
21
+ */
22
+ NextToken?: string;
23
+ /**
24
+ * <p>The Amazon Web Services request ID for this operation.</p>
25
+ * @public
26
+ */
27
+ RequestId?: string;
28
+ }
29
+ /**
30
+ * @public
31
+ */
32
+ export interface ListGroupMembershipsRequest {
33
+ /**
34
+ * <p>The name of the group that you want to see a membership list of.</p>
35
+ * @public
36
+ */
37
+ GroupName: string | undefined;
38
+ /**
39
+ * <p>A pagination token that can be used in a subsequent request.</p>
40
+ * @public
41
+ */
42
+ NextToken?: string;
43
+ /**
44
+ * <p>The maximum number of results to return from this request.</p>
45
+ * @public
46
+ */
47
+ MaxResults?: number;
48
+ /**
49
+ * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
50
+ * Amazon Web Services account that contains your Amazon QuickSight account.</p>
51
+ * @public
52
+ */
53
+ AwsAccountId: string | undefined;
54
+ /**
55
+ * <p>The namespace of the group that you want a list of users from.</p>
56
+ * @public
57
+ */
58
+ Namespace: string | undefined;
59
+ }
60
+ /**
61
+ * @public
62
+ */
63
+ export interface ListGroupMembershipsResponse {
64
+ /**
65
+ * <p>The list of the members of the group.</p>
66
+ * @public
67
+ */
68
+ GroupMemberList?: GroupMember[];
69
+ /**
70
+ * <p>A pagination token that can be used in a subsequent request.</p>
71
+ * @public
72
+ */
73
+ NextToken?: string;
74
+ /**
75
+ * <p>The Amazon Web Services request ID for this operation.</p>
76
+ * @public
77
+ */
78
+ RequestId?: string;
79
+ /**
80
+ * <p>The HTTP status of the request.</p>
81
+ * @public
82
+ */
83
+ Status?: number;
84
+ }
4
85
  /**
5
86
  * @public
6
87
  */
@@ -982,6 +1063,11 @@ export interface TopicSummary {
982
1063
  * @public
983
1064
  */
984
1065
  Name?: string;
1066
+ /**
1067
+ * <p>The user experience version of the topic.</p>
1068
+ * @public
1069
+ */
1070
+ UserExperienceVersion?: TopicUserExperienceVersion;
985
1071
  }
986
1072
  /**
987
1073
  * @public
@@ -1233,6 +1319,18 @@ export interface ListVPCConnectionsResponse {
1233
1319
  */
1234
1320
  Status?: number;
1235
1321
  }
1322
+ /**
1323
+ * @public
1324
+ * @enum
1325
+ */
1326
+ export declare const PurchaseMode: {
1327
+ readonly AUTO_PURCHASE: "AUTO_PURCHASE";
1328
+ readonly MANUAL: "MANUAL";
1329
+ };
1330
+ /**
1331
+ * @public
1332
+ */
1333
+ export type PurchaseMode = (typeof PurchaseMode)[keyof typeof PurchaseMode];
1236
1334
  /**
1237
1335
  * @public
1238
1336
  */
@@ -1273,20 +1371,7 @@ export interface PutDataSetRefreshPropertiesResponse {
1273
1371
  */
1274
1372
  export interface RegisterUserRequest {
1275
1373
  /**
1276
- * <p>Amazon QuickSight supports several ways of managing the identity of users. This
1277
- * parameter accepts two values:</p>
1278
- * <ul>
1279
- * <li>
1280
- * <p>
1281
- * <code>IAM</code>: A user whose identity maps to an existing IAM user or role.
1282
- * </p>
1283
- * </li>
1284
- * <li>
1285
- * <p>
1286
- * <code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by
1287
- * Amazon QuickSight. </p>
1288
- * </li>
1289
- * </ul>
1374
+ * <p>The identity type that your Amazon QuickSight account uses to manage the identity of users.</p>
1290
1375
  * @public
1291
1376
  */
1292
1377
  IdentityType: IdentityType | undefined;
@@ -1388,7 +1473,7 @@ export interface RegisterUserRequest {
1388
1473
  * permissions to a Amazon QuickSight user. </p>
1389
1474
  * <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
1390
1475
  * override the permissions typically granted by assigning Amazon QuickSight users to one of the
1391
- * default security cohorts in Amazon QuickSight (admin, author, reader).</p>
1476
+ * default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).</p>
1392
1477
  * <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
1393
1478
  * @public
1394
1479
  */
@@ -3428,6 +3513,46 @@ export interface UpdateRoleCustomPermissionResponse {
3428
3513
  */
3429
3514
  Status?: number;
3430
3515
  }
3516
+ /**
3517
+ * @public
3518
+ */
3519
+ export interface UpdateSPICECapacityConfigurationRequest {
3520
+ /**
3521
+ * <p>The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.</p>
3522
+ * @public
3523
+ */
3524
+ AwsAccountId: string | undefined;
3525
+ /**
3526
+ * <p>Determines how SPICE capacity can be purchased. The following options are available. </p>
3527
+ * <ul>
3528
+ * <li>
3529
+ * <p>
3530
+ * <code>MANUAL</code>: SPICE capacity can only be purchased manually.</p>
3531
+ * </li>
3532
+ * <li>
3533
+ * <p>
3534
+ * <code>AUTO_PURCHASE</code>: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.</p>
3535
+ * </li>
3536
+ * </ul>
3537
+ * @public
3538
+ */
3539
+ PurchaseMode: PurchaseMode | undefined;
3540
+ }
3541
+ /**
3542
+ * @public
3543
+ */
3544
+ export interface UpdateSPICECapacityConfigurationResponse {
3545
+ /**
3546
+ * <p>The Amazon Web Services request ID for this operation.</p>
3547
+ * @public
3548
+ */
3549
+ RequestId?: string;
3550
+ /**
3551
+ * <p>The HTTP status of the request.</p>
3552
+ * @public
3553
+ */
3554
+ Status?: number;
3555
+ }
3431
3556
  /**
3432
3557
  * @public
3433
3558
  */
@@ -3998,6 +4123,18 @@ export interface UpdateUserRequest {
3998
4123
  * <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight
3999
4124
  * settings.</p>
4000
4125
  * </li>
4126
+ * <li>
4127
+ * <p>
4128
+ * <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
4129
+ * </li>
4130
+ * <li>
4131
+ * <p>
4132
+ * <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
4133
+ * </li>
4134
+ * <li>
4135
+ * <p>
4136
+ * <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
4137
+ * </li>
4001
4138
  * </ul>
4002
4139
  * <p>The name of the Amazon QuickSight role is invisible to the user except for the console
4003
4140
  * screens dealing with permissions.</p>
@@ -160,6 +160,7 @@ import { UpdateIpRestrictionCommandInput, UpdateIpRestrictionCommandOutput } fro
160
160
  import { UpdatePublicSharingSettingsCommandInput, UpdatePublicSharingSettingsCommandOutput } from "../commands/UpdatePublicSharingSettingsCommand";
161
161
  import { UpdateRefreshScheduleCommandInput, UpdateRefreshScheduleCommandOutput } from "../commands/UpdateRefreshScheduleCommand";
162
162
  import { UpdateRoleCustomPermissionCommandInput, UpdateRoleCustomPermissionCommandOutput } from "../commands/UpdateRoleCustomPermissionCommand";
163
+ import { UpdateSPICECapacityConfigurationCommandInput, UpdateSPICECapacityConfigurationCommandOutput } from "../commands/UpdateSPICECapacityConfigurationCommand";
163
164
  import { UpdateTemplateAliasCommandInput, UpdateTemplateAliasCommandOutput } from "../commands/UpdateTemplateAliasCommand";
164
165
  import { UpdateTemplateCommandInput, UpdateTemplateCommandOutput } from "../commands/UpdateTemplateCommand";
165
166
  import { UpdateTemplatePermissionsCommandInput, UpdateTemplatePermissionsCommandOutput } from "../commands/UpdateTemplatePermissionsCommand";
@@ -811,6 +812,10 @@ export declare const se_UpdateRefreshScheduleCommand: (input: UpdateRefreshSched
811
812
  * serializeAws_restJson1UpdateRoleCustomPermissionCommand
812
813
  */
813
814
  export declare const se_UpdateRoleCustomPermissionCommand: (input: UpdateRoleCustomPermissionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
815
+ /**
816
+ * serializeAws_restJson1UpdateSPICECapacityConfigurationCommand
817
+ */
818
+ export declare const se_UpdateSPICECapacityConfigurationCommand: (input: UpdateSPICECapacityConfigurationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
814
819
  /**
815
820
  * serializeAws_restJson1UpdateTemplateCommand
816
821
  */
@@ -1495,6 +1500,10 @@ export declare const de_UpdateRefreshScheduleCommand: (output: __HttpResponse, c
1495
1500
  * deserializeAws_restJson1UpdateRoleCustomPermissionCommand
1496
1501
  */
1497
1502
  export declare const de_UpdateRoleCustomPermissionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateRoleCustomPermissionCommandOutput>;
1503
+ /**
1504
+ * deserializeAws_restJson1UpdateSPICECapacityConfigurationCommand
1505
+ */
1506
+ export declare const de_UpdateSPICECapacityConfigurationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateSPICECapacityConfigurationCommandOutput>;
1498
1507
  /**
1499
1508
  * deserializeAws_restJson1UpdateTemplateCommand
1500
1509
  */
@@ -639,6 +639,10 @@ import {
639
639
  UpdateRoleCustomPermissionCommandInput,
640
640
  UpdateRoleCustomPermissionCommandOutput,
641
641
  } from "./commands/UpdateRoleCustomPermissionCommand";
642
+ import {
643
+ UpdateSPICECapacityConfigurationCommandInput,
644
+ UpdateSPICECapacityConfigurationCommandOutput,
645
+ } from "./commands/UpdateSPICECapacityConfigurationCommand";
642
646
  import {
643
647
  UpdateTemplateAliasCommandInput,
644
648
  UpdateTemplateAliasCommandOutput,
@@ -2783,6 +2787,19 @@ export interface QuickSight {
2783
2787
  options: __HttpHandlerOptions,
2784
2788
  cb: (err: any, data?: UpdateRoleCustomPermissionCommandOutput) => void
2785
2789
  ): void;
2790
+ updateSPICECapacityConfiguration(
2791
+ args: UpdateSPICECapacityConfigurationCommandInput,
2792
+ options?: __HttpHandlerOptions
2793
+ ): Promise<UpdateSPICECapacityConfigurationCommandOutput>;
2794
+ updateSPICECapacityConfiguration(
2795
+ args: UpdateSPICECapacityConfigurationCommandInput,
2796
+ cb: (err: any, data?: UpdateSPICECapacityConfigurationCommandOutput) => void
2797
+ ): void;
2798
+ updateSPICECapacityConfiguration(
2799
+ args: UpdateSPICECapacityConfigurationCommandInput,
2800
+ options: __HttpHandlerOptions,
2801
+ cb: (err: any, data?: UpdateSPICECapacityConfigurationCommandOutput) => void
2802
+ ): void;
2786
2803
  updateTemplate(
2787
2804
  args: UpdateTemplateCommandInput,
2788
2805
  options?: __HttpHandlerOptions
@@ -685,6 +685,10 @@ import {
685
685
  UpdateRoleCustomPermissionCommandInput,
686
686
  UpdateRoleCustomPermissionCommandOutput,
687
687
  } from "./commands/UpdateRoleCustomPermissionCommand";
688
+ import {
689
+ UpdateSPICECapacityConfigurationCommandInput,
690
+ UpdateSPICECapacityConfigurationCommandOutput,
691
+ } from "./commands/UpdateSPICECapacityConfigurationCommand";
688
692
  import {
689
693
  UpdateTemplateAliasCommandInput,
690
694
  UpdateTemplateAliasCommandOutput,
@@ -897,6 +901,7 @@ export type ServiceInputTypes =
897
901
  | UpdatePublicSharingSettingsCommandInput
898
902
  | UpdateRefreshScheduleCommandInput
899
903
  | UpdateRoleCustomPermissionCommandInput
904
+ | UpdateSPICECapacityConfigurationCommandInput
900
905
  | UpdateTemplateAliasCommandInput
901
906
  | UpdateTemplateCommandInput
902
907
  | UpdateTemplatePermissionsCommandInput
@@ -1069,6 +1074,7 @@ export type ServiceOutputTypes =
1069
1074
  | UpdatePublicSharingSettingsCommandOutput
1070
1075
  | UpdateRefreshScheduleCommandOutput
1071
1076
  | UpdateRoleCustomPermissionCommandOutput
1077
+ | UpdateSPICECapacityConfigurationCommandOutput
1072
1078
  | UpdateTemplateAliasCommandOutput
1073
1079
  | UpdateTemplateCommandOutput
1074
1080
  | UpdateTemplatePermissionsCommandOutput
@@ -1,6 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { ListFoldersRequest, ListFoldersResponse } from "../models/models_3";
3
+ import { ListFoldersRequest } from "../models/models_3";
4
+ import { ListFoldersResponse } from "../models/models_4";
4
5
  import {
5
6
  QuickSightClientResolvedConfig,
6
7
  ServiceInputTypes,
@@ -3,7 +3,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import {
4
4
  ListGroupMembershipsRequest,
5
5
  ListGroupMembershipsResponse,
6
- } from "../models/models_3";
6
+ } from "../models/models_4";
7
7
  import {
8
8
  QuickSightClientResolvedConfig,
9
9
  ServiceInputTypes,