@aws-sdk/client-quicksight 3.614.0 → 3.615.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 (87) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +778 -396
  3. package/dist-es/QuickSight.js +6 -0
  4. package/dist-es/commands/BatchCreateTopicReviewedAnswerCommand.js +25 -0
  5. package/dist-es/commands/BatchDeleteTopicReviewedAnswerCommand.js +24 -0
  6. package/dist-es/commands/CreateTemplateCommand.js +1 -1
  7. package/dist-es/commands/GenerateEmbedUrlForAnonymousUserCommand.js +1 -1
  8. package/dist-es/commands/GenerateEmbedUrlForRegisteredUserCommand.js +1 -1
  9. package/dist-es/commands/GetDashboardEmbedUrlCommand.js +1 -1
  10. package/dist-es/commands/GetSessionEmbedUrlCommand.js +1 -1
  11. package/dist-es/commands/ListTopicReviewedAnswersCommand.js +25 -0
  12. package/dist-es/commands/index.js +3 -0
  13. package/dist-es/models/models_0.js +43 -16
  14. package/dist-es/models/models_1.js +5 -7
  15. package/dist-es/models/models_2.js +138 -101
  16. package/dist-es/models/models_3.js +70 -136
  17. package/dist-es/models/models_4.js +131 -2
  18. package/dist-es/protocols/Aws_restJson1.js +174 -4
  19. package/dist-types/QuickSight.d.ts +21 -0
  20. package/dist-types/QuickSightClient.d.ts +5 -2
  21. package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +567 -0
  22. package/dist-types/commands/BatchDeleteTopicReviewedAnswerCommand.d.ts +99 -0
  23. package/dist-types/commands/CreateAnalysisCommand.d.ts +10 -0
  24. package/dist-types/commands/CreateDashboardCommand.d.ts +10 -0
  25. package/dist-types/commands/CreateFolderCommand.d.ts +2 -1
  26. package/dist-types/commands/CreateFolderMembershipCommand.d.ts +1 -1
  27. package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +1 -1
  30. package/dist-types/commands/CreateIngestionCommand.d.ts +1 -1
  31. package/dist-types/commands/CreateNamespaceCommand.d.ts +1 -1
  32. package/dist-types/commands/CreateRefreshScheduleCommand.d.ts +1 -1
  33. package/dist-types/commands/CreateRoleMembershipCommand.d.ts +1 -1
  34. package/dist-types/commands/CreateTemplateAliasCommand.d.ts +1 -1
  35. package/dist-types/commands/CreateTemplateCommand.d.ts +11 -1
  36. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +10 -0
  37. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +10 -0
  38. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +10 -0
  39. package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +1 -1
  40. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +1 -1
  41. package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
  42. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +1 -1
  43. package/dist-types/commands/ListAnalysesCommand.d.ts +1 -1
  44. package/dist-types/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
  45. package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +1 -2
  46. package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +556 -0
  47. package/dist-types/commands/UpdateAnalysisCommand.d.ts +10 -0
  48. package/dist-types/commands/UpdateDashboardCommand.d.ts +10 -0
  49. package/dist-types/commands/UpdateTemplateCommand.d.ts +10 -0
  50. package/dist-types/commands/index.d.ts +3 -0
  51. package/dist-types/models/models_0.d.ts +119 -115
  52. package/dist-types/models/models_1.d.ts +97 -68
  53. package/dist-types/models/models_2.d.ts +2333 -2490
  54. package/dist-types/models/models_3.d.ts +4173 -4215
  55. package/dist-types/models/models_4.d.ts +1183 -2
  56. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  57. package/dist-types/ts3.4/QuickSight.d.ts +51 -0
  58. package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
  59. package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +38 -0
  60. package/dist-types/ts3.4/commands/BatchDeleteTopicReviewedAnswerCommand.d.ts +40 -0
  61. package/dist-types/ts3.4/commands/CreateFolderCommand.d.ts +2 -1
  62. package/dist-types/ts3.4/commands/CreateFolderMembershipCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/CreateGroupMembershipCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/CreateIAMPolicyAssignmentCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/CreateIngestionCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/CreateNamespaceCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/CreateRefreshScheduleCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/CreateRoleMembershipCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/CreateTemplateAliasCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/CreateTemplateCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListAssetBundleExportJobsCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/ListAssetBundleImportJobsCommand.d.ts +4 -2
  79. package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +40 -0
  80. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  81. package/dist-types/ts3.4/models/models_0.d.ts +60 -38
  82. package/dist-types/ts3.4/models/models_1.d.ts +26 -25
  83. package/dist-types/ts3.4/models/models_2.d.ts +339 -316
  84. package/dist-types/ts3.4/models/models_3.d.ts +286 -313
  85. package/dist-types/ts3.4/models/models_4.d.ts +317 -13
  86. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  87. package/package.json +1 -1
@@ -1,6 +1,975 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
1
2
  import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
2
- import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, 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, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, FailedKeyRegistrationEntry, FolderSearchFilter, FolderSummary, GroupSearchFilter, IAMPolicyAssignmentSummary, IdentityType, Ingestion, MemberIdArnPair, NamespaceInfoV2, NetworkInterface, RegisteredCustomerManagedKey, SessionTag, SnapshotConfiguration, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
3
+ import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, FilterOperator, FolderType, LinkSharingConfiguration, LogicalTable, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SharingModel, SslProperties, Tag, TopicIR, TopicTemplate, ValidationStrategy, VisualRole, VpcConnectionProperties } from "./models_2";
4
+ import { DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, EmbeddingIdentityType, FailedKeyRegistrationEntry, Group, GroupMember, IdentityType, Ingestion, NamespaceInfoV2, NetworkInterface, RefreshSchedule, RegisteredCustomerManagedKey, Role, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
5
+ import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
6
+ /**
7
+ * @public
8
+ * @enum
9
+ */
10
+ export declare const FolderFilterAttribute: {
11
+ readonly DIRECT_QUICKSIGHT_OWNER: "DIRECT_QUICKSIGHT_OWNER";
12
+ readonly DIRECT_QUICKSIGHT_SOLE_OWNER: "DIRECT_QUICKSIGHT_SOLE_OWNER";
13
+ readonly DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER";
14
+ readonly FOLDER_NAME: "FOLDER_NAME";
15
+ readonly PARENT_FOLDER_ARN: "PARENT_FOLDER_ARN";
16
+ readonly QUICKSIGHT_OWNER: "QUICKSIGHT_OWNER";
17
+ readonly QUICKSIGHT_VIEWER_OR_OWNER: "QUICKSIGHT_VIEWER_OR_OWNER";
18
+ };
19
+ /**
20
+ * @public
21
+ */
22
+ export type FolderFilterAttribute = (typeof FolderFilterAttribute)[keyof typeof FolderFilterAttribute];
23
+ /**
24
+ * <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
25
+ * @public
26
+ */
27
+ export interface MemberIdArnPair {
28
+ /**
29
+ * <p>The ID of the member.</p>
30
+ * @public
31
+ */
32
+ MemberId?: string;
33
+ /**
34
+ * <p>The Amazon Resource Name (ARN) of the member.</p>
35
+ * @public
36
+ */
37
+ MemberArn?: string;
38
+ }
39
+ /**
40
+ * <p>A filter to use to search an Amazon QuickSight folder.</p>
41
+ * @public
42
+ */
43
+ export interface FolderSearchFilter {
44
+ /**
45
+ * <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
46
+ * <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose folders you want to search in the <code>"Value"</code> field. For example, <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
47
+ * <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the folders you are searching for. For example, <code>"Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>FOLDER_NAME</code>.</p>
48
+ * @public
49
+ */
50
+ Operator?: FilterOperator;
51
+ /**
52
+ * <p>The name of a value that you want to use in the filter. For example, <code>"Name": "QUICKSIGHT_OWNER"</code>.</p>
53
+ * <p>Valid values are defined as follows:</p>
54
+ * <ul>
55
+ * <li>
56
+ * <p>
57
+ * <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.</p>
58
+ * </li>
59
+ * <li>
60
+ * <p>
61
+ * <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.</p>
62
+ * </li>
63
+ * <li>
64
+ * <p>
65
+ * <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.</p>
66
+ * </li>
67
+ * <li>
68
+ * <p>
69
+ * <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.</p>
70
+ * </li>
71
+ * <li>
72
+ * <p>
73
+ * <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. </p>
74
+ * </li>
75
+ * <li>
76
+ * <p>
77
+ * <code>FOLDER_NAME</code>: Any folders whose names have a substring match to this value will be returned.</p>
78
+ * </li>
79
+ * <li>
80
+ * <p>
81
+ * <code>PARENT_FOLDER_ARN</code>: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned. </p>
82
+ * </li>
83
+ * </ul>
84
+ * @public
85
+ */
86
+ Name?: FolderFilterAttribute;
87
+ /**
88
+ * <p>The value of the named item (in this example, <code>PARENT_FOLDER_ARN</code>), that you want to use as a filter. For example, <code>"Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"</code>.</p>
89
+ * @public
90
+ */
91
+ Value?: string;
92
+ }
93
+ /**
94
+ * <p>A summary of information about an existing Amazon QuickSight folder. </p>
95
+ * @public
96
+ */
97
+ export interface FolderSummary {
98
+ /**
99
+ * <p>The Amazon Resource Name (ARN) of the folder.</p>
100
+ * @public
101
+ */
102
+ Arn?: string;
103
+ /**
104
+ * <p>The ID of the folder.</p>
105
+ * @public
106
+ */
107
+ FolderId?: string;
108
+ /**
109
+ * <p>The display name of the folder.</p>
110
+ * @public
111
+ */
112
+ Name?: string;
113
+ /**
114
+ * <p>The type of folder.</p>
115
+ * @public
116
+ */
117
+ FolderType?: FolderType;
118
+ /**
119
+ * <p>The time that the folder was created.</p>
120
+ * @public
121
+ */
122
+ CreatedTime?: Date;
123
+ /**
124
+ * <p>The time that the folder was last updated.</p>
125
+ * @public
126
+ */
127
+ LastUpdatedTime?: Date;
128
+ /**
129
+ * <p>The sharing scope of the folder.</p>
130
+ * @public
131
+ */
132
+ SharingModel?: SharingModel;
133
+ }
134
+ /**
135
+ * <p>The key-value pair used for the row-level security tags feature.</p>
136
+ * @public
137
+ */
138
+ export interface SessionTag {
139
+ /**
140
+ * <p>The key for the tag.</p>
141
+ * @public
142
+ */
143
+ Key: string | undefined;
144
+ /**
145
+ * <p>The value that you want to assign the tag.</p>
146
+ * @public
147
+ */
148
+ Value: string | undefined;
149
+ }
150
+ /**
151
+ * @public
152
+ */
153
+ export interface GenerateEmbedUrlForAnonymousUserRequest {
154
+ /**
155
+ * <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
156
+ * @public
157
+ */
158
+ AwsAccountId: string | undefined;
159
+ /**
160
+ * <p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>
161
+ * @public
162
+ */
163
+ SessionLifetimeInMinutes?: number;
164
+ /**
165
+ * <p>The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to <code>default</code>.</p>
166
+ * @public
167
+ */
168
+ Namespace: string | undefined;
169
+ /**
170
+ * <p>The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the <code>DataSet$RowLevelPermissionTagConfiguration</code> parameter so that session tags can be used to provide row-level security.</p>
171
+ * <p>These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</p>
172
+ * @public
173
+ */
174
+ SessionTags?: SessionTag[];
175
+ /**
176
+ * <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
177
+ * is authorized to access during the lifetime of the session.</p>
178
+ * <p>If you choose <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the
179
+ * account that you want the user to be able to view.</p>
180
+ * <p>If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.</p>
181
+ * <p>Currently, you can pass up to 25 theme ARNs in each API call.</p>
182
+ * @public
183
+ */
184
+ AuthorizedResourceArns: string[] | undefined;
185
+ /**
186
+ * <p>The configuration of the experience that you are embedding.</p>
187
+ * @public
188
+ */
189
+ ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined;
190
+ /**
191
+ * <p>The domains that you want to add to the allow list for access to the generated URL that
192
+ * is then embedded. This optional parameter overrides the static domains that are
193
+ * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
194
+ * allows only the domains that you include in this parameter. You can list up to three
195
+ * domains or subdomains in each API call.</p>
196
+ * <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
197
+ * For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
198
+ * <code>https://sapp.amazon.com</code>.</p>
199
+ * @public
200
+ */
201
+ AllowedDomains?: string[];
202
+ }
203
+ /**
204
+ * @public
205
+ */
206
+ export interface GenerateEmbedUrlForAnonymousUserResponse {
207
+ /**
208
+ * <p>The embed URL for the dashboard.</p>
209
+ * @public
210
+ */
211
+ EmbedUrl: string | undefined;
212
+ /**
213
+ * <p>The HTTP status of the request.</p>
214
+ * @public
215
+ */
216
+ Status: number | undefined;
217
+ /**
218
+ * <p>The Amazon Web Services request ID for this operation.</p>
219
+ * @public
220
+ */
221
+ RequestId: string | undefined;
222
+ /**
223
+ * <p>The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.</p>
224
+ * @public
225
+ */
226
+ AnonymousUserArn: string | undefined;
227
+ }
228
+ /**
229
+ * <p>The number of minutes specified for the lifetime of a session isn't valid. The session
230
+ * lifetime must be 15-600 minutes.</p>
231
+ * @public
232
+ */
233
+ export declare class SessionLifetimeInMinutesInvalidException extends __BaseException {
234
+ readonly name: "SessionLifetimeInMinutesInvalidException";
235
+ readonly $fault: "client";
236
+ Message?: string;
237
+ /**
238
+ * <p>The Amazon Web Services request ID for this request.</p>
239
+ * @public
240
+ */
241
+ RequestId?: string;
242
+ /**
243
+ * @internal
244
+ */
245
+ constructor(opts: __ExceptionOptionType<SessionLifetimeInMinutesInvalidException, __BaseException>);
246
+ }
247
+ /**
248
+ * <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
249
+ * without the required pricing plan on your Amazon Web Services account. Before you can use embedding
250
+ * for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
251
+ * can do this on the <b>Manage Amazon QuickSight</b> page. </p>
252
+ * <p>After capacity pricing is added, you can use the
253
+ * <code>
254
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
255
+ * </code> API operation with the
256
+ * <code>--identity-type ANONYMOUS</code> option.</p>
257
+ * @public
258
+ */
259
+ export declare class UnsupportedPricingPlanException extends __BaseException {
260
+ readonly name: "UnsupportedPricingPlanException";
261
+ readonly $fault: "client";
262
+ Message?: string;
263
+ /**
264
+ * <p>The Amazon Web Services request ID for this request.</p>
265
+ * @public
266
+ */
267
+ RequestId?: string;
268
+ /**
269
+ * @internal
270
+ */
271
+ constructor(opts: __ExceptionOptionType<UnsupportedPricingPlanException, __BaseException>);
272
+ }
273
+ /**
274
+ * <p>The state perssitence configuration of an embedded dashboard.</p>
275
+ * @public
276
+ */
277
+ export interface StatePersistenceConfigurations {
278
+ /**
279
+ * <p>Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.</p>
280
+ * @public
281
+ */
282
+ Enabled: boolean | undefined;
283
+ }
284
+ /**
285
+ * <p>The feature configuration for an embedded dashboard.</p>
286
+ * @public
287
+ */
288
+ export interface RegisteredUserDashboardFeatureConfigurations {
289
+ /**
290
+ * <p>The state persistence settings of an embedded dashboard.</p>
291
+ * @public
292
+ */
293
+ StatePersistence?: StatePersistenceConfigurations;
294
+ /**
295
+ * <p>The bookmarks configuration for an embedded dashboard in Amazon QuickSight.</p>
296
+ * @public
297
+ */
298
+ Bookmarks?: BookmarksConfigurations;
299
+ }
300
+ /**
301
+ * <p>Information about the dashboard you want to embed.</p>
302
+ * @public
303
+ */
304
+ export interface RegisteredUserDashboardEmbeddingConfiguration {
305
+ /**
306
+ * <p>The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.</p>
307
+ * <p>If the user does not have permission to view this dashboard, they see a permissions error message.</p>
308
+ * @public
309
+ */
310
+ InitialDashboardId: string | undefined;
311
+ /**
312
+ * <p>The feature configurations of an embbedded Amazon QuickSight dashboard.</p>
313
+ * @public
314
+ */
315
+ FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations;
316
+ }
317
+ /**
318
+ * <p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>
319
+ * @public
320
+ */
321
+ export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
322
+ /**
323
+ * <p>The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p>
324
+ * <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
325
+ * @public
326
+ */
327
+ InitialDashboardVisualId: DashboardVisualId | undefined;
328
+ }
329
+ /**
330
+ * <p>An object that provides information about the configuration of a Generative Q&A experience.</p>
331
+ * @public
332
+ */
333
+ export interface RegisteredUserGenerativeQnAEmbeddingConfiguration {
334
+ /**
335
+ * <p>The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.
336
+ * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
337
+ * a topic. The ID is in the URL for the topic that you open.</p>
338
+ * <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>
339
+ * @public
340
+ */
341
+ InitialTopicId?: string;
342
+ }
343
+ /**
344
+ * <p>Information about the Q search bar embedding experience.</p>
345
+ * @public
346
+ */
347
+ export interface RegisteredUserQSearchBarEmbeddingConfiguration {
348
+ /**
349
+ * <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
350
+ * are allowed to select other topics from the list of available topics.</p>
351
+ * <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>
352
+ * @public
353
+ */
354
+ InitialTopicId?: string;
355
+ }
356
+ /**
357
+ * <p>The feature configurations of an embedded Amazon QuickSight console.</p>
358
+ * @public
359
+ */
360
+ export interface RegisteredUserConsoleFeatureConfigurations {
361
+ /**
362
+ * <p>The state persistence configurations of an embedded Amazon QuickSight console.</p>
363
+ * @public
364
+ */
365
+ StatePersistence?: StatePersistenceConfigurations;
366
+ }
367
+ /**
368
+ * <p>Information about the Amazon QuickSight console that you want to embed.</p>
369
+ * @public
370
+ */
371
+ export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
372
+ /**
373
+ * <p>The initial URL path for the Amazon QuickSight console. <code>InitialPath</code> is required.</p>
374
+ * <p>The entry point URL is constrained to the following paths:</p>
375
+ * <ul>
376
+ * <li>
377
+ * <p>
378
+ * <code>/start</code>
379
+ * </p>
380
+ * </li>
381
+ * <li>
382
+ * <p>
383
+ * <code>/start/analyses</code>
384
+ * </p>
385
+ * </li>
386
+ * <li>
387
+ * <p>
388
+ * <code>/start/dashboards</code>
389
+ * </p>
390
+ * </li>
391
+ * <li>
392
+ * <p>
393
+ * <code>/start/favorites</code>
394
+ * </p>
395
+ * </li>
396
+ * <li>
397
+ * <p>
398
+ * <code>/dashboards/DashboardId</code>. <i>DashboardId</i> is the actual ID key from the Amazon QuickSight console URL of the dashboard.</p>
399
+ * </li>
400
+ * <li>
401
+ * <p>
402
+ * <code>/analyses/AnalysisId</code>. <i>AnalysisId</i> is the actual ID key from the Amazon QuickSight console URL of the analysis.</p>
403
+ * </li>
404
+ * </ul>
405
+ * @public
406
+ */
407
+ InitialPath?: string;
408
+ /**
409
+ * <p>The embedding configuration of an embedded Amazon QuickSight console.</p>
410
+ * @public
411
+ */
412
+ FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations;
413
+ }
414
+ /**
415
+ * <p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p>
416
+ * <note>
417
+ * <p>Exactly one of the experience configurations is required. You can choose
418
+ * <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
419
+ * than one experience configuration.</p>
420
+ * </note>
421
+ * @public
422
+ */
423
+ export interface RegisteredUserEmbeddingExperienceConfiguration {
424
+ /**
425
+ * <p>The configuration details for providing a dashboard embedding experience.</p>
426
+ * @public
427
+ */
428
+ Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
429
+ /**
430
+ * <p>The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User
431
+ * Guide</i>.</p>
432
+ * <p>Use <code>
433
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html">GenerateEmbedUrlForRegisteredUser</a>
434
+ * </code>
435
+ * where
436
+ * you want to provide an authoring portal that allows users to create data sources,
437
+ * datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
438
+ * needs to belong to the author or admin security cohort. If you want to restrict permissions
439
+ * to some of these features, add a custom permissions profile to the user with the
440
+ * <code>
441
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
442
+ * </code> API operation. Use the <code>
443
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
444
+ * </code> API operation to add a new user with a custom permission profile attached. For more
445
+ * information, see the following sections in the <i>Amazon QuickSight User
446
+ * Guide</i>:</p>
447
+ * <ul>
448
+ * <li>
449
+ * <p>
450
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html">Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users</a>
451
+ * </p>
452
+ * </li>
453
+ * <li>
454
+ * <p>
455
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a>
456
+ * </p>
457
+ * </li>
458
+ * </ul>
459
+ * <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>.</p>
460
+ * @public
461
+ */
462
+ QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
463
+ /**
464
+ * <p>The configuration details for embedding the Q search bar.</p>
465
+ * <p>For more information about embedding the Q search bar, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a> in
466
+ * the <i>Amazon QuickSight User Guide</i>.</p>
467
+ * @public
468
+ */
469
+ QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
470
+ /**
471
+ * <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
472
+ * @public
473
+ */
474
+ DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
475
+ /**
476
+ * <p>The configuration details for embedding the Generative Q&A experience.</p>
477
+ * <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
478
+ * the <i>Amazon QuickSight User Guide</i>.</p>
479
+ * @public
480
+ */
481
+ GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration;
482
+ }
483
+ /**
484
+ * @public
485
+ */
486
+ export interface GenerateEmbedUrlForRegisteredUserRequest {
487
+ /**
488
+ * <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
489
+ * @public
490
+ */
491
+ AwsAccountId: string | undefined;
492
+ /**
493
+ * <p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>
494
+ * @public
495
+ */
496
+ SessionLifetimeInMinutes?: number;
497
+ /**
498
+ * <p>The Amazon Resource Name for the registered user.</p>
499
+ * @public
500
+ */
501
+ UserArn: string | undefined;
502
+ /**
503
+ * <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>
504
+ * @public
505
+ */
506
+ ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
507
+ /**
508
+ * <p>The domains that you want to add to the allow list for access to the generated URL that
509
+ * is then embedded. This optional parameter overrides the static domains that are
510
+ * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
511
+ * allows only the domains that you include in this parameter. You can list up to three
512
+ * domains or subdomains in each API call.</p>
513
+ * <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
514
+ * For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
515
+ * <code>https://sapp.amazon.com</code>.</p>
516
+ * @public
517
+ */
518
+ AllowedDomains?: string[];
519
+ }
520
+ /**
521
+ * @public
522
+ */
523
+ export interface GenerateEmbedUrlForRegisteredUserResponse {
524
+ /**
525
+ * <p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.</p>
526
+ * @public
527
+ */
528
+ EmbedUrl: string | undefined;
529
+ /**
530
+ * <p>The HTTP status of the request.</p>
531
+ * @public
532
+ */
533
+ Status: number | undefined;
534
+ /**
535
+ * <p>The Amazon Web Services request ID for this operation.</p>
536
+ * @public
537
+ */
538
+ RequestId: string | undefined;
539
+ }
540
+ /**
541
+ * <p>The user with the provided name isn't found. This error can happen in any operation
542
+ * that requires finding a user based on a provided user name, such as
543
+ * <code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>
544
+ * @public
545
+ */
546
+ export declare class QuickSightUserNotFoundException extends __BaseException {
547
+ readonly name: "QuickSightUserNotFoundException";
548
+ readonly $fault: "client";
549
+ Message?: string;
550
+ /**
551
+ * <p>The Amazon Web Services request ID for this request.</p>
552
+ * @public
553
+ */
554
+ RequestId?: string;
555
+ /**
556
+ * @internal
557
+ */
558
+ constructor(opts: __ExceptionOptionType<QuickSightUserNotFoundException, __BaseException>);
559
+ }
560
+ /**
561
+ * @public
562
+ */
563
+ export interface GetDashboardEmbedUrlRequest {
564
+ /**
565
+ * <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
566
+ * @public
567
+ */
568
+ AwsAccountId: string | undefined;
569
+ /**
570
+ * <p>The ID for the dashboard, also added to the Identity and Access Management (IAM)
571
+ * policy.</p>
572
+ * @public
573
+ */
574
+ DashboardId: string | undefined;
575
+ /**
576
+ * <p>The authentication method that the user uses to sign in.</p>
577
+ * @public
578
+ */
579
+ IdentityType: EmbeddingIdentityType | undefined;
580
+ /**
581
+ * <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
582
+ * @public
583
+ */
584
+ SessionLifetimeInMinutes?: number;
585
+ /**
586
+ * <p>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables
587
+ * the undo/redo button.</p>
588
+ * @public
589
+ */
590
+ UndoRedoDisabled?: boolean;
591
+ /**
592
+ * <p>Remove the reset button on the embedded dashboard. The default is FALSE, which enables the
593
+ * reset button.</p>
594
+ * @public
595
+ */
596
+ ResetDisabled?: boolean;
597
+ /**
598
+ * <p>Adds persistence of state for the user session in an embedded dashboard. Persistence
599
+ * applies to the sheet and the parameter settings. These are control settings that the
600
+ * dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
601
+ * set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same
602
+ * dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
603
+ * set to FALSE, the state of the user session is not persisted. The default is
604
+ * <code>FALSE</code>.</p>
605
+ * @public
606
+ */
607
+ StatePersistenceEnabled?: boolean;
608
+ /**
609
+ * <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type.
610
+ * You can use this for any Amazon QuickSight users in your account (readers, authors, or
611
+ * admins) authenticated as one of the following:</p>
612
+ * <ul>
613
+ * <li>
614
+ * <p>Active Directory (AD) users or group members</p>
615
+ * </li>
616
+ * <li>
617
+ * <p>Invited nonfederated users</p>
618
+ * </li>
619
+ * <li>
620
+ * <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using
621
+ * SAML, OpenID Connect, or IAM federation.</p>
622
+ * </li>
623
+ * </ul>
624
+ * <p>Omit this parameter for users in the third group – IAM users and IAM
625
+ * role-based sessions.</p>
626
+ * @public
627
+ */
628
+ UserArn?: string;
629
+ /**
630
+ * <p>The Amazon QuickSight namespace that contains the dashboard IDs in this request.
631
+ * If you're not using a custom namespace, set <code>Namespace = default</code>.</p>
632
+ * @public
633
+ */
634
+ Namespace?: string;
635
+ /**
636
+ * <p>A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the <code>IdentityType</code> parameter must be set to <code>ANONYMOUS</code> because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.</p>
637
+ * @public
638
+ */
639
+ AdditionalDashboardIds?: string[];
640
+ }
641
+ /**
642
+ * <p>Output returned from the <code>GetDashboardEmbedUrl</code> operation.</p>
643
+ * @public
644
+ */
645
+ export interface GetDashboardEmbedUrlResponse {
646
+ /**
647
+ * <p>A single-use URL that you can put into your server-side webpage to embed your
648
+ * dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an
649
+ * <code>auth_code</code> value that enables one (and only one) sign-on to a user session
650
+ * that is valid for 10 hours. </p>
651
+ * @public
652
+ */
653
+ EmbedUrl?: string;
654
+ /**
655
+ * <p>The HTTP status of the request.</p>
656
+ * @public
657
+ */
658
+ Status?: number;
659
+ /**
660
+ * <p>The Amazon Web Services request ID for this operation.</p>
661
+ * @public
662
+ */
663
+ RequestId?: string;
664
+ }
665
+ /**
666
+ * <p>The identity type specified isn't supported. Supported identity types include
667
+ * <code>IAM</code> and <code>QUICKSIGHT</code>.</p>
668
+ * @public
669
+ */
670
+ export declare class IdentityTypeNotSupportedException extends __BaseException {
671
+ readonly name: "IdentityTypeNotSupportedException";
672
+ readonly $fault: "client";
673
+ Message?: string;
674
+ /**
675
+ * <p>The Amazon Web Services request ID for this request.</p>
676
+ * @public
677
+ */
678
+ RequestId?: string;
679
+ /**
680
+ * @internal
681
+ */
682
+ constructor(opts: __ExceptionOptionType<IdentityTypeNotSupportedException, __BaseException>);
683
+ }
684
+ /**
685
+ * @public
686
+ */
687
+ export interface GetSessionEmbedUrlRequest {
688
+ /**
689
+ * <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
690
+ * @public
691
+ */
692
+ AwsAccountId: string | undefined;
693
+ /**
694
+ * <p>The URL you use to access the embedded session. The entry point URL is constrained to
695
+ * the following paths:</p>
696
+ * <ul>
697
+ * <li>
698
+ * <p>
699
+ * <code>/start</code>
700
+ * </p>
701
+ * </li>
702
+ * <li>
703
+ * <p>
704
+ * <code>/start/analyses</code>
705
+ * </p>
706
+ * </li>
707
+ * <li>
708
+ * <p>
709
+ * <code>/start/dashboards</code>
710
+ * </p>
711
+ * </li>
712
+ * <li>
713
+ * <p>
714
+ * <code>/start/favorites</code>
715
+ * </p>
716
+ * </li>
717
+ * <li>
718
+ * <p>
719
+ * <code>/dashboards/<i>DashboardId</i>
720
+ * </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p>
721
+ * </li>
722
+ * <li>
723
+ * <p>
724
+ * <code>/analyses/<i>AnalysisId</i>
725
+ * </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p>
726
+ * </li>
727
+ * </ul>
728
+ * @public
729
+ */
730
+ EntryPoint?: string;
731
+ /**
732
+ * <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
733
+ * @public
734
+ */
735
+ SessionLifetimeInMinutes?: number;
736
+ /**
737
+ * <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type.
738
+ * You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
739
+ * admins). They need to be authenticated as one of the following:</p>
740
+ * <ol>
741
+ * <li>
742
+ * <p>Active Directory (AD) users or group members</p>
743
+ * </li>
744
+ * <li>
745
+ * <p>Invited nonfederated users</p>
746
+ * </li>
747
+ * <li>
748
+ * <p>IAM users and IAM role-based sessions authenticated
749
+ * through Federated Single Sign-On using SAML, OpenID Connect, or IAM
750
+ * federation</p>
751
+ * </li>
752
+ * </ol>
753
+ * <p>Omit this parameter for users in the third group, IAM users and IAM role-based
754
+ * sessions.</p>
755
+ * @public
756
+ */
757
+ UserArn?: string;
758
+ }
759
+ /**
760
+ * @public
761
+ */
762
+ export interface GetSessionEmbedUrlResponse {
763
+ /**
764
+ * <p>A single-use URL that you can put into your server-side web page to embed your
765
+ * Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
766
+ * <code>auth_code</code> value that enables one (and only one) sign-on to a user session
767
+ * that is valid for 10 hours. </p>
768
+ * @public
769
+ */
770
+ EmbedUrl?: string;
771
+ /**
772
+ * <p>The HTTP status of the request.</p>
773
+ * @public
774
+ */
775
+ Status?: number;
776
+ /**
777
+ * <p>The Amazon Web Services request ID for this operation.</p>
778
+ * @public
779
+ */
780
+ RequestId?: string;
781
+ }
782
+ /**
783
+ * @public
784
+ * @enum
785
+ */
786
+ export declare const GroupFilterAttribute: {
787
+ readonly GROUP_NAME: "GROUP_NAME";
788
+ };
789
+ /**
790
+ * @public
791
+ */
792
+ export type GroupFilterAttribute = (typeof GroupFilterAttribute)[keyof typeof GroupFilterAttribute];
793
+ /**
794
+ * @public
795
+ * @enum
796
+ */
797
+ export declare const GroupFilterOperator: {
798
+ readonly StartsWith: "StartsWith";
799
+ };
800
+ /**
801
+ * @public
802
+ */
803
+ export type GroupFilterOperator = (typeof GroupFilterOperator)[keyof typeof GroupFilterOperator];
804
+ /**
805
+ * <p>A <code>GroupSearchFilter</code> object that you want to apply to your search.</p>
806
+ * @public
807
+ */
808
+ export interface GroupSearchFilter {
809
+ /**
810
+ * <p>The comparison operator that you want to use as a filter, for example <code>"Operator":
811
+ * "StartsWith"</code>. Currently, the only supported operator is
812
+ * <code>StartsWith</code>.</p>
813
+ * @public
814
+ */
815
+ Operator: GroupFilterOperator | undefined;
816
+ /**
817
+ * <p>The name of the value that you want to use as a filter, for example <code>"Name":
818
+ * "GROUP_NAME"</code>. Currently, the only supported name is
819
+ * <code>GROUP_NAME</code>.</p>
820
+ * @public
821
+ */
822
+ Name: GroupFilterAttribute | undefined;
823
+ /**
824
+ * <p>The value of the named item, in this case <code>GROUP_NAME</code>, that you want to use as a filter.</p>
825
+ * @public
826
+ */
827
+ Value: string | undefined;
828
+ }
829
+ /**
830
+ * <p>IAM policy assignment summary.</p>
831
+ * @public
832
+ */
833
+ export interface IAMPolicyAssignmentSummary {
834
+ /**
835
+ * <p>Assignment name.</p>
836
+ * @public
837
+ */
838
+ AssignmentName?: string;
839
+ /**
840
+ * <p>Assignment status.</p>
841
+ * @public
842
+ */
843
+ AssignmentStatus?: AssignmentStatus;
844
+ }
845
+ /**
846
+ * <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
847
+ * @public
848
+ */
849
+ export declare class InvalidRequestException extends __BaseException {
850
+ readonly name: "InvalidRequestException";
851
+ readonly $fault: "client";
852
+ Message?: string;
853
+ /**
854
+ * <p>The Amazon Web Services request ID for this request.</p>
855
+ * @public
856
+ */
857
+ RequestId?: string;
858
+ /**
859
+ * @internal
860
+ */
861
+ constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
862
+ }
863
+ /**
864
+ * @public
865
+ */
866
+ export interface ListAnalysesRequest {
867
+ /**
868
+ * <p>The ID of the Amazon Web Services account that contains the analyses.</p>
869
+ * @public
870
+ */
871
+ AwsAccountId: string | undefined;
872
+ /**
873
+ * <p>A pagination token that can be used in a subsequent request.</p>
874
+ * @public
875
+ */
876
+ NextToken?: string;
877
+ /**
878
+ * <p>The maximum number of results to return.</p>
879
+ * @public
880
+ */
881
+ MaxResults?: number;
882
+ }
883
+ /**
884
+ * @public
885
+ */
886
+ export interface ListAnalysesResponse {
887
+ /**
888
+ * <p>Metadata describing each of the analyses that are listed.</p>
889
+ * @public
890
+ */
891
+ AnalysisSummaryList?: AnalysisSummary[];
892
+ /**
893
+ * <p>A pagination token that can be used in a subsequent request.</p>
894
+ * @public
895
+ */
896
+ NextToken?: string;
897
+ /**
898
+ * <p>The HTTP status of the request.</p>
899
+ * @public
900
+ */
901
+ Status?: number;
902
+ /**
903
+ * <p>The Amazon Web Services request ID for this operation.</p>
904
+ * @public
905
+ */
906
+ RequestId?: string;
907
+ }
908
+ /**
909
+ * @public
910
+ */
911
+ export interface ListAssetBundleExportJobsRequest {
912
+ /**
913
+ * <p>The ID of the Amazon Web Services account that the export jobs were executed in. </p>
914
+ * @public
915
+ */
916
+ AwsAccountId: string | undefined;
917
+ /**
918
+ * <p>The token for the next set of results, or null if there are no more results.</p>
919
+ * @public
920
+ */
921
+ NextToken?: string;
922
+ /**
923
+ * <p>The maximum number of results to be returned per request.</p>
924
+ * @public
925
+ */
926
+ MaxResults?: number;
927
+ }
928
+ /**
929
+ * @public
930
+ */
931
+ export interface ListAssetBundleExportJobsResponse {
932
+ /**
933
+ * <p>A list of export job summaries.</p>
934
+ * @public
935
+ */
936
+ AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[];
937
+ /**
938
+ * <p>The token for the next set of results, or null if there are no more results.</p>
939
+ * @public
940
+ */
941
+ NextToken?: string;
942
+ /**
943
+ * <p>The Amazon Web Services request ID for this operation.</p>
944
+ * @public
945
+ */
946
+ RequestId?: string;
947
+ /**
948
+ * <p>The HTTP status of the request.</p>
949
+ * @public
950
+ */
951
+ Status?: number;
952
+ }
953
+ /**
954
+ * @public
955
+ */
956
+ export interface ListAssetBundleImportJobsRequest {
957
+ /**
958
+ * <p>The ID of the Amazon Web Services account that the import jobs were executed in.</p>
959
+ * @public
960
+ */
961
+ AwsAccountId: string | undefined;
962
+ /**
963
+ * <p>The token for the next set of results, or null if there are no more results.</p>
964
+ * @public
965
+ */
966
+ NextToken?: string;
967
+ /**
968
+ * <p>The maximum number of results to be returned per request.</p>
969
+ * @public
970
+ */
971
+ MaxResults?: number;
972
+ }
4
973
  /**
5
974
  * @public
6
975
  */
@@ -1305,6 +2274,21 @@ export interface ListTopicRefreshSchedulesResponse {
1305
2274
  */
1306
2275
  RequestId?: string;
1307
2276
  }
2277
+ /**
2278
+ * @public
2279
+ */
2280
+ export interface ListTopicReviewedAnswersRequest {
2281
+ /**
2282
+ * <p>The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.</p>
2283
+ * @public
2284
+ */
2285
+ AwsAccountId: string | undefined;
2286
+ /**
2287
+ * <p>The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
2288
+ * @public
2289
+ */
2290
+ TopicId: string | undefined;
2291
+ }
1308
2292
  /**
1309
2293
  * @public
1310
2294
  */
@@ -4658,6 +5642,183 @@ export interface UpdateVPCConnectionResponse {
4658
5642
  */
4659
5643
  Status?: number;
4660
5644
  }
5645
+ /**
5646
+ * <p>The definition for a <code>TopicVisual</code>.</p>
5647
+ * @public
5648
+ */
5649
+ export interface TopicVisual {
5650
+ /**
5651
+ * <p>The visual ID for the <code>TopicVisual</code>.</p>
5652
+ * @public
5653
+ */
5654
+ VisualId?: string;
5655
+ /**
5656
+ * <p>The role for the <code>TopicVisual</code>.</p>
5657
+ * @public
5658
+ */
5659
+ Role?: VisualRole;
5660
+ /**
5661
+ * <p>The ir for the <code>TopicVisual</code>.</p>
5662
+ * @public
5663
+ */
5664
+ Ir?: TopicIR;
5665
+ /**
5666
+ * <p>The supporting visuals for the <code>TopicVisual</code>.</p>
5667
+ * @public
5668
+ */
5669
+ SupportingVisuals?: TopicVisual[];
5670
+ }
5671
+ /**
5672
+ * <p>The definition for a <code>CreateTopicReviewedAnswer</code>.</p>
5673
+ * @public
5674
+ */
5675
+ export interface CreateTopicReviewedAnswer {
5676
+ /**
5677
+ * <p>The answer ID for the <code>CreateTopicReviewedAnswer</code>.</p>
5678
+ * @public
5679
+ */
5680
+ AnswerId: string | undefined;
5681
+ /**
5682
+ * <p>The Dataset arn for the <code>CreateTopicReviewedAnswer</code>.</p>
5683
+ * @public
5684
+ */
5685
+ DatasetArn: string | undefined;
5686
+ /**
5687
+ * <p>The Question to be created.</p>
5688
+ * @public
5689
+ */
5690
+ Question: string | undefined;
5691
+ /**
5692
+ * <p>The Mir for the <code>CreateTopicReviewedAnswer</code>.</p>
5693
+ * @public
5694
+ */
5695
+ Mir?: TopicIR;
5696
+ /**
5697
+ * <p>The <code>PrimaryVisual</code> for the <code>CreateTopicReviewedAnswer</code>.</p>
5698
+ * @public
5699
+ */
5700
+ PrimaryVisual?: TopicVisual;
5701
+ /**
5702
+ * <p>The template for the <code>CreateTopicReviewedAnswer</code>.</p>
5703
+ * @public
5704
+ */
5705
+ Template?: TopicTemplate;
5706
+ }
5707
+ /**
5708
+ * <p>The deinition for a <code>TopicReviewedAnswer</code>.</p>
5709
+ * @public
5710
+ */
5711
+ export interface TopicReviewedAnswer {
5712
+ /**
5713
+ * <p>The Amazon Resource Name (ARN) of the reviewed answer.</p>
5714
+ * @public
5715
+ */
5716
+ Arn?: string;
5717
+ /**
5718
+ * <p>The answer ID of the reviewed answer.</p>
5719
+ * @public
5720
+ */
5721
+ AnswerId: string | undefined;
5722
+ /**
5723
+ * <p>The Dataset ARN for the <code>TopicReviewedAnswer</code>.</p>
5724
+ * @public
5725
+ */
5726
+ DatasetArn: string | undefined;
5727
+ /**
5728
+ * <p>The question for the <code>TopicReviewedAnswer</code>.</p>
5729
+ * @public
5730
+ */
5731
+ Question: string | undefined;
5732
+ /**
5733
+ * <p>The mir for the <code>TopicReviewedAnswer</code>.</p>
5734
+ * @public
5735
+ */
5736
+ Mir?: TopicIR;
5737
+ /**
5738
+ * <p>The primary visual for the <code>TopicReviewedAnswer</code>.</p>
5739
+ * @public
5740
+ */
5741
+ PrimaryVisual?: TopicVisual;
5742
+ /**
5743
+ * <p>The template for the <code>TopicReviewedAnswer</code>.</p>
5744
+ * @public
5745
+ */
5746
+ Template?: TopicTemplate;
5747
+ }
5748
+ /**
5749
+ * @public
5750
+ */
5751
+ export interface BatchCreateTopicReviewedAnswerRequest {
5752
+ /**
5753
+ * <p>The ID of the Amazon Web Services account that you want to create a reviewed answer in.</p>
5754
+ * @public
5755
+ */
5756
+ AwsAccountId: string | undefined;
5757
+ /**
5758
+ * <p>The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
5759
+ * @public
5760
+ */
5761
+ TopicId: string | undefined;
5762
+ /**
5763
+ * <p>The definition of the Answers to be created.</p>
5764
+ * @public
5765
+ */
5766
+ Answers: CreateTopicReviewedAnswer[] | undefined;
5767
+ }
5768
+ /**
5769
+ * @public
5770
+ */
5771
+ export interface ListTopicReviewedAnswersResponse {
5772
+ /**
5773
+ * <p>The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
5774
+ * @public
5775
+ */
5776
+ TopicId?: string;
5777
+ /**
5778
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
5779
+ * @public
5780
+ */
5781
+ TopicArn?: string;
5782
+ /**
5783
+ * <p>The definition of all Answers in the topic.</p>
5784
+ * @public
5785
+ */
5786
+ Answers?: TopicReviewedAnswer[];
5787
+ /**
5788
+ * <p>The HTTP status of the request.</p>
5789
+ * @public
5790
+ */
5791
+ Status?: number;
5792
+ /**
5793
+ * <p>The Amazon Web Services request ID for this operation.</p>
5794
+ * @public
5795
+ */
5796
+ RequestId?: string;
5797
+ }
5798
+ /**
5799
+ * @internal
5800
+ */
5801
+ export declare const SessionTagFilterSensitiveLog: (obj: SessionTag) => any;
5802
+ /**
5803
+ * @internal
5804
+ */
5805
+ export declare const GenerateEmbedUrlForAnonymousUserRequestFilterSensitiveLog: (obj: GenerateEmbedUrlForAnonymousUserRequest) => any;
5806
+ /**
5807
+ * @internal
5808
+ */
5809
+ export declare const GenerateEmbedUrlForAnonymousUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForAnonymousUserResponse) => any;
5810
+ /**
5811
+ * @internal
5812
+ */
5813
+ export declare const GenerateEmbedUrlForRegisteredUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForRegisteredUserResponse) => any;
5814
+ /**
5815
+ * @internal
5816
+ */
5817
+ export declare const GetDashboardEmbedUrlResponseFilterSensitiveLog: (obj: GetDashboardEmbedUrlResponse) => any;
5818
+ /**
5819
+ * @internal
5820
+ */
5821
+ export declare const GetSessionEmbedUrlResponseFilterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
4661
5822
  /**
4662
5823
  * @internal
4663
5824
  */
@@ -4698,3 +5859,23 @@ export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTempla
4698
5859
  * @internal
4699
5860
  */
4700
5861
  export declare const UpdateTopicRequestFilterSensitiveLog: (obj: UpdateTopicRequest) => any;
5862
+ /**
5863
+ * @internal
5864
+ */
5865
+ export declare const TopicVisualFilterSensitiveLog: (obj: TopicVisual) => any;
5866
+ /**
5867
+ * @internal
5868
+ */
5869
+ export declare const CreateTopicReviewedAnswerFilterSensitiveLog: (obj: CreateTopicReviewedAnswer) => any;
5870
+ /**
5871
+ * @internal
5872
+ */
5873
+ export declare const TopicReviewedAnswerFilterSensitiveLog: (obj: TopicReviewedAnswer) => any;
5874
+ /**
5875
+ * @internal
5876
+ */
5877
+ export declare const BatchCreateTopicReviewedAnswerRequestFilterSensitiveLog: (obj: BatchCreateTopicReviewedAnswerRequest) => any;
5878
+ /**
5879
+ * @internal
5880
+ */
5881
+ export declare const ListTopicReviewedAnswersResponseFilterSensitiveLog: (obj: ListTopicReviewedAnswersResponse) => any;