@aws-sdk/client-quicksight 3.691.0 → 3.693.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 (117) hide show
  1. package/README.md +143 -7
  2. package/dist-cjs/index.js +1116 -216
  3. package/dist-es/QuickSight.js +34 -0
  4. package/dist-es/commands/CreateBrandCommand.js +22 -0
  5. package/dist-es/commands/CreateCustomPermissionsCommand.js +22 -0
  6. package/dist-es/commands/DeleteBrandAssignmentCommand.js +22 -0
  7. package/dist-es/commands/DeleteBrandCommand.js +22 -0
  8. package/dist-es/commands/DeleteCustomPermissionsCommand.js +22 -0
  9. package/dist-es/commands/DeleteUserCustomPermissionCommand.js +22 -0
  10. package/dist-es/commands/DescribeBrandAssignmentCommand.js +22 -0
  11. package/dist-es/commands/DescribeBrandCommand.js +22 -0
  12. package/dist-es/commands/DescribeBrandPublishedVersionCommand.js +22 -0
  13. package/dist-es/commands/DescribeCustomPermissionsCommand.js +22 -0
  14. package/dist-es/commands/DescribeTemplateDefinitionCommand.js +1 -1
  15. package/dist-es/commands/DescribeTopicCommand.js +1 -1
  16. package/dist-es/commands/ListBrandsCommand.js +22 -0
  17. package/dist-es/commands/ListCustomPermissionsCommand.js +22 -0
  18. package/dist-es/commands/UpdateBrandAssignmentCommand.js +22 -0
  19. package/dist-es/commands/UpdateBrandCommand.js +22 -0
  20. package/dist-es/commands/UpdateBrandPublishedVersionCommand.js +22 -0
  21. package/dist-es/commands/UpdateCustomPermissionsCommand.js +22 -0
  22. package/dist-es/commands/UpdateUserCustomPermissionCommand.js +22 -0
  23. package/dist-es/commands/index.js +17 -0
  24. package/dist-es/models/models_2.js +52 -107
  25. package/dist-es/models/models_3.js +108 -29
  26. package/dist-es/models/models_4.js +30 -16
  27. package/dist-es/pagination/ListBrandsPaginator.js +4 -0
  28. package/dist-es/pagination/ListCustomPermissionsPaginator.js +4 -0
  29. package/dist-es/pagination/index.js +2 -0
  30. package/dist-es/protocols/Aws_restJson1.js +540 -6
  31. package/dist-types/QuickSight.d.ts +119 -0
  32. package/dist-types/QuickSightClient.d.ts +19 -2
  33. package/dist-types/commands/CreateBrandCommand.d.ts +268 -0
  34. package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +132 -0
  35. package/dist-types/commands/DeleteBrandAssignmentCommand.d.ts +92 -0
  36. package/dist-types/commands/DeleteBrandCommand.d.ts +93 -0
  37. package/dist-types/commands/DeleteCustomPermissionsCommand.d.ts +104 -0
  38. package/dist-types/commands/DeleteUserCustomPermissionCommand.d.ts +101 -0
  39. package/dist-types/commands/DescribeBrandAssignmentCommand.d.ts +93 -0
  40. package/dist-types/commands/DescribeBrandCommand.d.ts +204 -0
  41. package/dist-types/commands/DescribeBrandPublishedVersionCommand.d.ts +203 -0
  42. package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +120 -0
  43. package/dist-types/commands/DescribeIngestionCommand.d.ts +2 -1
  44. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
  45. package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts +1 -1
  46. package/dist-types/commands/DescribeNamespaceCommand.d.ts +1 -1
  47. package/dist-types/commands/DescribeQPersonalizationConfigurationCommand.d.ts +1 -1
  48. package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
  49. package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
  50. package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeTemplateCommand.d.ts +1 -1
  52. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
  53. package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
  54. package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
  55. package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
  56. package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
  57. package/dist-types/commands/DescribeTopicCommand.d.ts +1 -1
  58. package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +1 -2
  59. package/dist-types/commands/ListBrandsCommand.d.ts +99 -0
  60. package/dist-types/commands/ListCustomPermissionsCommand.d.ts +124 -0
  61. package/dist-types/commands/UpdateBrandAssignmentCommand.d.ts +94 -0
  62. package/dist-types/commands/UpdateBrandCommand.d.ts +262 -0
  63. package/dist-types/commands/UpdateBrandPublishedVersionCommand.d.ts +95 -0
  64. package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +120 -0
  65. package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +102 -0
  66. package/dist-types/commands/index.d.ts +17 -0
  67. package/dist-types/models/models_2.d.ts +1343 -1408
  68. package/dist-types/models/models_3.d.ts +4131 -4269
  69. package/dist-types/models/models_4.d.ts +1387 -21
  70. package/dist-types/pagination/ListBrandsPaginator.d.ts +7 -0
  71. package/dist-types/pagination/ListCustomPermissionsPaginator.d.ts +7 -0
  72. package/dist-types/pagination/index.d.ts +2 -0
  73. package/dist-types/protocols/Aws_restJson1.d.ts +153 -0
  74. package/dist-types/ts3.4/QuickSight.d.ts +289 -0
  75. package/dist-types/ts3.4/QuickSightClient.d.ts +102 -0
  76. package/dist-types/ts3.4/commands/CreateBrandCommand.d.ts +47 -0
  77. package/dist-types/ts3.4/commands/CreateCustomPermissionsCommand.d.ts +51 -0
  78. package/dist-types/ts3.4/commands/DeleteBrandAssignmentCommand.d.ts +51 -0
  79. package/dist-types/ts3.4/commands/DeleteBrandCommand.d.ts +47 -0
  80. package/dist-types/ts3.4/commands/DeleteCustomPermissionsCommand.d.ts +51 -0
  81. package/dist-types/ts3.4/commands/DeleteUserCustomPermissionCommand.d.ts +51 -0
  82. package/dist-types/ts3.4/commands/DescribeBrandAssignmentCommand.d.ts +51 -0
  83. package/dist-types/ts3.4/commands/DescribeBrandCommand.d.ts +50 -0
  84. package/dist-types/ts3.4/commands/DescribeBrandPublishedVersionCommand.d.ts +51 -0
  85. package/dist-types/ts3.4/commands/DescribeCustomPermissionsCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/DescribeIngestionCommand.d.ts +2 -4
  87. package/dist-types/ts3.4/commands/DescribeIpRestrictionCommand.d.ts +1 -1
  88. package/dist-types/ts3.4/commands/DescribeKeyRegistrationCommand.d.ts +1 -1
  89. package/dist-types/ts3.4/commands/DescribeNamespaceCommand.d.ts +1 -1
  90. package/dist-types/ts3.4/commands/DescribeQPersonalizationConfigurationCommand.d.ts +1 -1
  91. package/dist-types/ts3.4/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/DescribeTemplateAliasCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/DescribeTemplateCommand.d.ts +1 -1
  95. package/dist-types/ts3.4/commands/DescribeTemplateDefinitionCommand.d.ts +1 -1
  96. package/dist-types/ts3.4/commands/DescribeTemplatePermissionsCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
  99. package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +4 -2
  102. package/dist-types/ts3.4/commands/ListBrandsCommand.d.ts +47 -0
  103. package/dist-types/ts3.4/commands/ListCustomPermissionsCommand.d.ts +51 -0
  104. package/dist-types/ts3.4/commands/UpdateBrandAssignmentCommand.d.ts +51 -0
  105. package/dist-types/ts3.4/commands/UpdateBrandCommand.d.ts +47 -0
  106. package/dist-types/ts3.4/commands/UpdateBrandPublishedVersionCommand.d.ts +51 -0
  107. package/dist-types/ts3.4/commands/UpdateCustomPermissionsCommand.d.ts +51 -0
  108. package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts +51 -0
  109. package/dist-types/ts3.4/commands/index.d.ts +17 -0
  110. package/dist-types/ts3.4/models/models_2.d.ts +188 -311
  111. package/dist-types/ts3.4/models/models_3.d.ts +389 -267
  112. package/dist-types/ts3.4/models/models_4.d.ts +342 -18
  113. package/dist-types/ts3.4/pagination/ListBrandsPaginator.d.ts +11 -0
  114. package/dist-types/ts3.4/pagination/ListCustomPermissionsPaginator.d.ts +11 -0
  115. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  116. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +204 -0
  117. package/package.json +35 -35
@@ -1,8 +1,1118 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
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, DataSourceParameters, FieldFolder, FilterOperator, LinkSharingConfiguration, LogicalTable, PhysicalTable, ResourcePermission, ServiceType, SharedViewConfigurations, SslProperties, Tag, TopicIR, TopicTemplate, ValidationStrategy, VisualRole, VpcConnectionProperties } from "./models_2";
4
- import { DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FolderType, Group, GroupMember, IncludeFolderMembers, Ingestion, NamespaceInfoV2, PersonalizationMode, RefreshSchedule, RegisteredCustomerManagedKey, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SharingModel, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
2
+ import { AccountCustomization, ActiveIAMPolicyAssignment, Entity, ResourceStatus, Sheet } from "./models_0";
3
+ import { _Parameters, AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobSummary, AssetBundleImportSource, AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, BrandDefinition, BrandDetail, BrandSummary, Capabilities, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DashboardVisualId, DatasetParameter, DataSourceParameters, FilterOperator, LinkSharingConfiguration, ResourcePermission, ServiceType, SharedViewConfigurations, SslProperties, Tag, TopicIR, TopicTemplate, ValidationStrategy, VisualRole, VpcConnectionProperties } from "./models_2";
4
+ import { CustomPermissions, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetConfiguration, DataSetImportMode, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceSearchFilter, DataSourceSummary, FieldFolder, FolderType, Group, GroupMember, IdentityStore, IncludeFolderMembers, Ingestion, LogicalTable, NamespaceStatus, PhysicalTable, RefreshSchedule, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SharingModel, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, TopicUserExperienceVersion, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
5
5
  import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
6
+ /**
7
+ * @public
8
+ */
9
+ export interface DescribeIngestionResponse {
10
+ /**
11
+ * <p>Information about the ingestion.</p>
12
+ * @public
13
+ */
14
+ Ingestion?: Ingestion | undefined;
15
+ /**
16
+ * <p>The Amazon Web Services request ID for this operation.</p>
17
+ * @public
18
+ */
19
+ RequestId?: string | undefined;
20
+ /**
21
+ * <p>The HTTP status of the request.</p>
22
+ * @public
23
+ */
24
+ Status?: number | undefined;
25
+ }
26
+ /**
27
+ * @public
28
+ */
29
+ export interface DescribeIpRestrictionRequest {
30
+ /**
31
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
32
+ * @public
33
+ */
34
+ AwsAccountId: string | undefined;
35
+ }
36
+ /**
37
+ * @public
38
+ */
39
+ export interface DescribeIpRestrictionResponse {
40
+ /**
41
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
42
+ * @public
43
+ */
44
+ AwsAccountId?: string | undefined;
45
+ /**
46
+ * <p>A map that describes the IP rules with CIDR range and description.</p>
47
+ * @public
48
+ */
49
+ IpRestrictionRuleMap?: Record<string, string> | undefined;
50
+ /**
51
+ * <p>A map of allowed VPC IDs and their rule descriptions.</p>
52
+ * @public
53
+ */
54
+ VpcIdRestrictionRuleMap?: Record<string, string> | undefined;
55
+ /**
56
+ * <p>A map of allowed VPC endpoint IDs and their rule descriptions.</p>
57
+ * @public
58
+ */
59
+ VpcEndpointIdRestrictionRuleMap?: Record<string, string> | undefined;
60
+ /**
61
+ * <p>A value that specifies whether IP rules are turned on.</p>
62
+ * @public
63
+ */
64
+ Enabled?: boolean | undefined;
65
+ /**
66
+ * <p>The Amazon Web Services request ID for this operation.</p>
67
+ * @public
68
+ */
69
+ RequestId?: string | undefined;
70
+ /**
71
+ * <p>The HTTP status of the request.
72
+ * </p>
73
+ * @public
74
+ */
75
+ Status?: number | undefined;
76
+ }
77
+ /**
78
+ * @public
79
+ */
80
+ export interface DescribeKeyRegistrationRequest {
81
+ /**
82
+ * <p>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.</p>
83
+ * @public
84
+ */
85
+ AwsAccountId: string | undefined;
86
+ /**
87
+ * <p>Determines whether the request returns the default key only.</p>
88
+ * @public
89
+ */
90
+ DefaultKeyOnly?: boolean | undefined;
91
+ }
92
+ /**
93
+ * <p>A customer managed key structure that contains the information listed below: </p>
94
+ * <ul>
95
+ * <li>
96
+ * <p>
97
+ * <code>KeyArn</code> - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.</p>
98
+ * </li>
99
+ * <li>
100
+ * <p>
101
+ * <code>DefaultKey</code> - Indicates whether the current key is set as the default key for encryption and decryption use.</p>
102
+ * </li>
103
+ * </ul>
104
+ * @public
105
+ */
106
+ export interface RegisteredCustomerManagedKey {
107
+ /**
108
+ * <p>The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.</p>
109
+ * @public
110
+ */
111
+ KeyArn?: string | undefined;
112
+ /**
113
+ * <p>Indicates whether a <code>RegisteredCustomerManagedKey</code> is set as the default key for encryption and decryption use.</p>
114
+ * @public
115
+ */
116
+ DefaultKey?: boolean | undefined;
117
+ }
118
+ /**
119
+ * @public
120
+ */
121
+ export interface DescribeKeyRegistrationResponse {
122
+ /**
123
+ * <p>The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.</p>
124
+ * @public
125
+ */
126
+ AwsAccountId?: string | undefined;
127
+ /**
128
+ * <p>A list of <code>RegisteredCustomerManagedKey</code> objects in a Amazon QuickSight account.</p>
129
+ * @public
130
+ */
131
+ KeyRegistration?: RegisteredCustomerManagedKey[] | undefined;
132
+ /**
133
+ * <p>The Amazon Web Services request ID for this operation.</p>
134
+ * @public
135
+ */
136
+ RequestId?: string | undefined;
137
+ /**
138
+ * <p>The HTTP status of the request.</p>
139
+ * @public
140
+ */
141
+ Status?: number | undefined;
142
+ }
143
+ /**
144
+ * @public
145
+ */
146
+ export interface DescribeNamespaceRequest {
147
+ /**
148
+ * <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.</p>
149
+ * @public
150
+ */
151
+ AwsAccountId: string | undefined;
152
+ /**
153
+ * <p>The namespace that you want to describe.</p>
154
+ * @public
155
+ */
156
+ Namespace: string | undefined;
157
+ }
158
+ /**
159
+ * @public
160
+ * @enum
161
+ */
162
+ export declare const NamespaceErrorType: {
163
+ readonly INTERNAL_SERVICE_ERROR: "INTERNAL_SERVICE_ERROR";
164
+ readonly PERMISSION_DENIED: "PERMISSION_DENIED";
165
+ };
166
+ /**
167
+ * @public
168
+ */
169
+ export type NamespaceErrorType = (typeof NamespaceErrorType)[keyof typeof NamespaceErrorType];
170
+ /**
171
+ * <p>Errors that occur during namespace creation.</p>
172
+ * @public
173
+ */
174
+ export interface NamespaceError {
175
+ /**
176
+ * <p>The error type.</p>
177
+ * @public
178
+ */
179
+ Type?: NamespaceErrorType | undefined;
180
+ /**
181
+ * <p>The message for the error.</p>
182
+ * @public
183
+ */
184
+ Message?: string | undefined;
185
+ }
186
+ /**
187
+ * <p>The error type.</p>
188
+ * @public
189
+ */
190
+ export interface NamespaceInfoV2 {
191
+ /**
192
+ * <p>The name of the error.</p>
193
+ * @public
194
+ */
195
+ Name?: string | undefined;
196
+ /**
197
+ * <p>The namespace ARN.</p>
198
+ * @public
199
+ */
200
+ Arn?: string | undefined;
201
+ /**
202
+ * <p>The namespace Amazon Web Services Region.</p>
203
+ * @public
204
+ */
205
+ CapacityRegion?: string | undefined;
206
+ /**
207
+ * <p>The creation status of a namespace that is not yet completely created.</p>
208
+ * @public
209
+ */
210
+ CreationStatus?: NamespaceStatus | undefined;
211
+ /**
212
+ * <p>The identity store used for the namespace.</p>
213
+ * @public
214
+ */
215
+ IdentityStore?: IdentityStore | undefined;
216
+ /**
217
+ * <p>An error that occurred when the namespace was created.</p>
218
+ * @public
219
+ */
220
+ NamespaceError?: NamespaceError | undefined;
221
+ }
222
+ /**
223
+ * @public
224
+ */
225
+ export interface DescribeNamespaceResponse {
226
+ /**
227
+ * <p>The information about the namespace that you're describing. The response includes
228
+ * the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. <code>DescribeNamespace</code> also
229
+ * works for namespaces that are in the process of being created. For incomplete namespaces,
230
+ * this API operation lists the namespace error types and messages associated with the creation process.</p>
231
+ * @public
232
+ */
233
+ Namespace?: NamespaceInfoV2 | undefined;
234
+ /**
235
+ * <p>The Amazon Web Services request ID for this operation.</p>
236
+ * @public
237
+ */
238
+ RequestId?: string | undefined;
239
+ /**
240
+ * <p>The HTTP status of the request.</p>
241
+ * @public
242
+ */
243
+ Status?: number | undefined;
244
+ }
245
+ /**
246
+ * @public
247
+ */
248
+ export interface DescribeQPersonalizationConfigurationRequest {
249
+ /**
250
+ * <p>The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.</p>
251
+ * @public
252
+ */
253
+ AwsAccountId: string | undefined;
254
+ }
255
+ /**
256
+ * @public
257
+ * @enum
258
+ */
259
+ export declare const PersonalizationMode: {
260
+ readonly DISABLED: "DISABLED";
261
+ readonly ENABLED: "ENABLED";
262
+ };
263
+ /**
264
+ * @public
265
+ */
266
+ export type PersonalizationMode = (typeof PersonalizationMode)[keyof typeof PersonalizationMode];
267
+ /**
268
+ * @public
269
+ */
270
+ export interface DescribeQPersonalizationConfigurationResponse {
271
+ /**
272
+ * <p>A value that indicates whether personalization is enabled or not.</p>
273
+ * @public
274
+ */
275
+ PersonalizationMode?: PersonalizationMode | undefined;
276
+ /**
277
+ * <p>The Amazon Web Services request ID for this operation.</p>
278
+ * @public
279
+ */
280
+ RequestId?: string | undefined;
281
+ /**
282
+ * <p>The HTTP status of the request.</p>
283
+ * @public
284
+ */
285
+ Status?: number | undefined;
286
+ }
287
+ /**
288
+ * @public
289
+ */
290
+ export interface DescribeRefreshScheduleRequest {
291
+ /**
292
+ * <p>The Amazon Web Services account ID.</p>
293
+ * @public
294
+ */
295
+ AwsAccountId: string | undefined;
296
+ /**
297
+ * <p>The ID of the dataset.</p>
298
+ * @public
299
+ */
300
+ DataSetId: string | undefined;
301
+ /**
302
+ * <p>The ID of the refresh schedule.</p>
303
+ * @public
304
+ */
305
+ ScheduleId: string | undefined;
306
+ }
307
+ /**
308
+ * @public
309
+ */
310
+ export interface DescribeRefreshScheduleResponse {
311
+ /**
312
+ * <p>The refresh schedule.</p>
313
+ * @public
314
+ */
315
+ RefreshSchedule?: RefreshSchedule | undefined;
316
+ /**
317
+ * <p>The HTTP status of the request.</p>
318
+ * @public
319
+ */
320
+ Status?: number | undefined;
321
+ /**
322
+ * <p>The Amazon Web Services request ID for this operation.</p>
323
+ * @public
324
+ */
325
+ RequestId?: string | undefined;
326
+ /**
327
+ * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
328
+ * @public
329
+ */
330
+ Arn?: string | undefined;
331
+ }
332
+ /**
333
+ * @public
334
+ */
335
+ export interface DescribeRoleCustomPermissionRequest {
336
+ /**
337
+ * <p>The name of the role whose permissions you want described.</p>
338
+ * @public
339
+ */
340
+ Role: Role | undefined;
341
+ /**
342
+ * <p>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</p>
343
+ * @public
344
+ */
345
+ AwsAccountId: string | undefined;
346
+ /**
347
+ * <p>The namespace that contains the role.</p>
348
+ * @public
349
+ */
350
+ Namespace: string | undefined;
351
+ }
352
+ /**
353
+ * @public
354
+ */
355
+ export interface DescribeRoleCustomPermissionResponse {
356
+ /**
357
+ * <p>The name of the custom permission that is described.</p>
358
+ * @public
359
+ */
360
+ CustomPermissionsName?: string | undefined;
361
+ /**
362
+ * <p>The Amazon Web Services request ID for this operation.</p>
363
+ * @public
364
+ */
365
+ RequestId?: string | undefined;
366
+ /**
367
+ * <p>The HTTP status of the request.</p>
368
+ * @public
369
+ */
370
+ Status?: number | undefined;
371
+ }
372
+ /**
373
+ * @public
374
+ */
375
+ export interface DescribeTemplateRequest {
376
+ /**
377
+ * <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
378
+ * @public
379
+ */
380
+ AwsAccountId: string | undefined;
381
+ /**
382
+ * <p>The ID for the template.</p>
383
+ * @public
384
+ */
385
+ TemplateId: string | undefined;
386
+ /**
387
+ * <p>(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter
388
+ * value isn't provided, the latest version of the template is described.</p>
389
+ * @public
390
+ */
391
+ VersionNumber?: number | undefined;
392
+ /**
393
+ * <p>The alias of the template that you want to describe. If you name a specific alias, you
394
+ * describe the version that the alias points to. You can specify the latest version of the
395
+ * template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
396
+ * parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
397
+ * @public
398
+ */
399
+ AliasName?: string | undefined;
400
+ }
401
+ /**
402
+ * @public
403
+ * @enum
404
+ */
405
+ export declare const TemplateErrorType: {
406
+ readonly ACCESS_DENIED: "ACCESS_DENIED";
407
+ readonly DATA_SET_NOT_FOUND: "DATA_SET_NOT_FOUND";
408
+ readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
409
+ readonly SOURCE_NOT_FOUND: "SOURCE_NOT_FOUND";
410
+ };
411
+ /**
412
+ * @public
413
+ */
414
+ export type TemplateErrorType = (typeof TemplateErrorType)[keyof typeof TemplateErrorType];
415
+ /**
416
+ * <p>List of errors that occurred when the template version creation failed.</p>
417
+ * @public
418
+ */
419
+ export interface TemplateError {
420
+ /**
421
+ * <p>Type of error.</p>
422
+ * @public
423
+ */
424
+ Type?: TemplateErrorType | undefined;
425
+ /**
426
+ * <p>Description of the error type.</p>
427
+ * @public
428
+ */
429
+ Message?: string | undefined;
430
+ /**
431
+ * <p>An error path that shows which entities caused the template error.</p>
432
+ * @public
433
+ */
434
+ ViolatedEntities?: Entity[] | undefined;
435
+ }
436
+ /**
437
+ * <p>A version of a template.</p>
438
+ * @public
439
+ */
440
+ export interface TemplateVersion {
441
+ /**
442
+ * <p>The time that this template version was created.</p>
443
+ * @public
444
+ */
445
+ CreatedTime?: Date | undefined;
446
+ /**
447
+ * <p>Errors associated with this template version.</p>
448
+ * @public
449
+ */
450
+ Errors?: TemplateError[] | undefined;
451
+ /**
452
+ * <p>The version number of the template version.</p>
453
+ * @public
454
+ */
455
+ VersionNumber?: number | undefined;
456
+ /**
457
+ * <p>The status that is associated with the template.</p>
458
+ * <ul>
459
+ * <li>
460
+ * <p>
461
+ * <code>CREATION_IN_PROGRESS</code>
462
+ * </p>
463
+ * </li>
464
+ * <li>
465
+ * <p>
466
+ * <code>CREATION_SUCCESSFUL</code>
467
+ * </p>
468
+ * </li>
469
+ * <li>
470
+ * <p>
471
+ * <code>CREATION_FAILED</code>
472
+ * </p>
473
+ * </li>
474
+ * <li>
475
+ * <p>
476
+ * <code>UPDATE_IN_PROGRESS</code>
477
+ * </p>
478
+ * </li>
479
+ * <li>
480
+ * <p>
481
+ * <code>UPDATE_SUCCESSFUL</code>
482
+ * </p>
483
+ * </li>
484
+ * <li>
485
+ * <p>
486
+ * <code>UPDATE_FAILED</code>
487
+ * </p>
488
+ * </li>
489
+ * <li>
490
+ * <p>
491
+ * <code>DELETED</code>
492
+ * </p>
493
+ * </li>
494
+ * </ul>
495
+ * @public
496
+ */
497
+ Status?: ResourceStatus | undefined;
498
+ /**
499
+ * <p>Schema of the dataset identified by the placeholder. Any dashboard created from this
500
+ * template should be bound to new datasets matching the same schema described through this
501
+ * API operation.</p>
502
+ * @public
503
+ */
504
+ DataSetConfigurations?: DataSetConfiguration[] | undefined;
505
+ /**
506
+ * <p>The description of the template.</p>
507
+ * @public
508
+ */
509
+ Description?: string | undefined;
510
+ /**
511
+ * <p>The Amazon Resource Name (ARN) of an analysis or template that was used to create this
512
+ * template.</p>
513
+ * @public
514
+ */
515
+ SourceEntityArn?: string | undefined;
516
+ /**
517
+ * <p>The ARN of the theme associated with this version of the template.</p>
518
+ * @public
519
+ */
520
+ ThemeArn?: string | undefined;
521
+ /**
522
+ * <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
523
+ * @public
524
+ */
525
+ Sheets?: Sheet[] | undefined;
526
+ }
527
+ /**
528
+ * <p>A template object. A <i>template</i> is an entity in Amazon QuickSight that
529
+ * encapsulates the metadata required to create an analysis and that you can use to create
530
+ * a dashboard. A template adds a layer of abstraction by using placeholders to replace the
531
+ * dataset associated with an analysis. You can use templates to create dashboards by
532
+ * replacing dataset placeholders with datasets that follow the same schema that was used
533
+ * to create the source analysis and template.</p>
534
+ * <p>You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to
535
+ * create a template or a dashboard from an existing template.</p>
536
+ * @public
537
+ */
538
+ export interface Template {
539
+ /**
540
+ * <p>The Amazon Resource Name (ARN) of the template.</p>
541
+ * @public
542
+ */
543
+ Arn?: string | undefined;
544
+ /**
545
+ * <p>The display name of the template.</p>
546
+ * @public
547
+ */
548
+ Name?: string | undefined;
549
+ /**
550
+ * <p>A structure describing the versions of the template.</p>
551
+ * @public
552
+ */
553
+ Version?: TemplateVersion | undefined;
554
+ /**
555
+ * <p>The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
556
+ * @public
557
+ */
558
+ TemplateId?: string | undefined;
559
+ /**
560
+ * <p>Time when this was last updated.</p>
561
+ * @public
562
+ */
563
+ LastUpdatedTime?: Date | undefined;
564
+ /**
565
+ * <p>Time when this was created.</p>
566
+ * @public
567
+ */
568
+ CreatedTime?: Date | undefined;
569
+ }
570
+ /**
571
+ * @public
572
+ */
573
+ export interface DescribeTemplateResponse {
574
+ /**
575
+ * <p>The template structure for the object you want to describe.</p>
576
+ * @public
577
+ */
578
+ Template?: Template | undefined;
579
+ /**
580
+ * <p>The HTTP status of the request.</p>
581
+ * @public
582
+ */
583
+ Status?: number | undefined;
584
+ /**
585
+ * <p>The Amazon Web Services request ID for this operation.</p>
586
+ * @public
587
+ */
588
+ RequestId?: string | undefined;
589
+ }
590
+ /**
591
+ * @public
592
+ */
593
+ export interface DescribeTemplateAliasRequest {
594
+ /**
595
+ * <p>The ID of the Amazon Web Services account that contains the template alias that you're
596
+ * describing.</p>
597
+ * @public
598
+ */
599
+ AwsAccountId: string | undefined;
600
+ /**
601
+ * <p>The ID for the template.</p>
602
+ * @public
603
+ */
604
+ TemplateId: string | undefined;
605
+ /**
606
+ * <p>The name of the template alias that you want to describe. If you name a specific alias, you
607
+ * describe the version that the alias points to. You can specify the latest version of the
608
+ * template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
609
+ * parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
610
+ * @public
611
+ */
612
+ AliasName: string | undefined;
613
+ }
614
+ /**
615
+ * @public
616
+ */
617
+ export interface DescribeTemplateAliasResponse {
618
+ /**
619
+ * <p>Information about the template alias.</p>
620
+ * @public
621
+ */
622
+ TemplateAlias?: TemplateAlias | undefined;
623
+ /**
624
+ * <p>The HTTP status of the request.</p>
625
+ * @public
626
+ */
627
+ Status?: number | undefined;
628
+ /**
629
+ * <p>The Amazon Web Services request ID for this operation.</p>
630
+ * @public
631
+ */
632
+ RequestId?: string | undefined;
633
+ }
634
+ /**
635
+ * @public
636
+ */
637
+ export interface DescribeTemplateDefinitionRequest {
638
+ /**
639
+ * <p>The ID of the Amazon Web Services account that contains the template. You must be using the
640
+ * Amazon Web Services account that the template is in.</p>
641
+ * @public
642
+ */
643
+ AwsAccountId: string | undefined;
644
+ /**
645
+ * <p>The ID of the template that you're describing.</p>
646
+ * @public
647
+ */
648
+ TemplateId: string | undefined;
649
+ /**
650
+ * <p>The version number of the template.</p>
651
+ * @public
652
+ */
653
+ VersionNumber?: number | undefined;
654
+ /**
655
+ * <p>The alias of the template that you want to describe. If you name a specific alias, you
656
+ * describe the version that the alias points to. You can specify the latest version of the
657
+ * template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
658
+ * parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
659
+ * @public
660
+ */
661
+ AliasName?: string | undefined;
662
+ }
663
+ /**
664
+ * @public
665
+ */
666
+ export interface DescribeTemplateDefinitionResponse {
667
+ /**
668
+ * <p>The descriptive name of the template.</p>
669
+ * @public
670
+ */
671
+ Name?: string | undefined;
672
+ /**
673
+ * <p>The ID of the template described.</p>
674
+ * @public
675
+ */
676
+ TemplateId?: string | undefined;
677
+ /**
678
+ * <p>Errors associated with the template version.</p>
679
+ * @public
680
+ */
681
+ Errors?: TemplateError[] | undefined;
682
+ /**
683
+ * <p>Status associated with the template.</p>
684
+ * <ul>
685
+ * <li>
686
+ * <p>
687
+ * <code>CREATION_IN_PROGRESS</code>
688
+ * </p>
689
+ * </li>
690
+ * <li>
691
+ * <p>
692
+ * <code>CREATION_SUCCESSFUL</code>
693
+ * </p>
694
+ * </li>
695
+ * <li>
696
+ * <p>
697
+ * <code>CREATION_FAILED</code>
698
+ * </p>
699
+ * </li>
700
+ * <li>
701
+ * <p>
702
+ * <code>UPDATE_IN_PROGRESS</code>
703
+ * </p>
704
+ * </li>
705
+ * <li>
706
+ * <p>
707
+ * <code>UPDATE_SUCCESSFUL</code>
708
+ * </p>
709
+ * </li>
710
+ * <li>
711
+ * <p>
712
+ * <code>UPDATE_FAILED</code>
713
+ * </p>
714
+ * </li>
715
+ * <li>
716
+ * <p>
717
+ * <code>DELETED</code>
718
+ * </p>
719
+ * </li>
720
+ * </ul>
721
+ * @public
722
+ */
723
+ ResourceStatus?: ResourceStatus | undefined;
724
+ /**
725
+ * <p>The ARN of the theme of the template.</p>
726
+ * @public
727
+ */
728
+ ThemeArn?: string | undefined;
729
+ /**
730
+ * <p>The definition of the template.</p>
731
+ * <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
732
+ * @public
733
+ */
734
+ Definition?: TemplateVersionDefinition | undefined;
735
+ /**
736
+ * <p>The HTTP status of the request.</p>
737
+ * @public
738
+ */
739
+ Status?: number | undefined;
740
+ /**
741
+ * <p>The Amazon Web Services request ID for this operation.</p>
742
+ * @public
743
+ */
744
+ RequestId?: string | undefined;
745
+ }
746
+ /**
747
+ * @public
748
+ */
749
+ export interface DescribeTemplatePermissionsRequest {
750
+ /**
751
+ * <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
752
+ * @public
753
+ */
754
+ AwsAccountId: string | undefined;
755
+ /**
756
+ * <p>The ID for the template.</p>
757
+ * @public
758
+ */
759
+ TemplateId: string | undefined;
760
+ }
761
+ /**
762
+ * @public
763
+ */
764
+ export interface DescribeTemplatePermissionsResponse {
765
+ /**
766
+ * <p>The ID for the template.</p>
767
+ * @public
768
+ */
769
+ TemplateId?: string | undefined;
770
+ /**
771
+ * <p>The Amazon Resource Name (ARN) of the template.</p>
772
+ * @public
773
+ */
774
+ TemplateArn?: string | undefined;
775
+ /**
776
+ * <p>A list of resource permissions to be set on the template. </p>
777
+ * @public
778
+ */
779
+ Permissions?: ResourcePermission[] | undefined;
780
+ /**
781
+ * <p>The Amazon Web Services request ID for this operation.</p>
782
+ * @public
783
+ */
784
+ RequestId?: string | undefined;
785
+ /**
786
+ * <p>The HTTP status of the request.</p>
787
+ * @public
788
+ */
789
+ Status?: number | undefined;
790
+ }
791
+ /**
792
+ * @public
793
+ */
794
+ export interface DescribeThemeRequest {
795
+ /**
796
+ * <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
797
+ * @public
798
+ */
799
+ AwsAccountId: string | undefined;
800
+ /**
801
+ * <p>The ID for the theme.</p>
802
+ * @public
803
+ */
804
+ ThemeId: string | undefined;
805
+ /**
806
+ * <p>The version number for the version to describe. If a <code>VersionNumber</code> parameter
807
+ * value isn't provided, the latest version of the theme is described.</p>
808
+ * @public
809
+ */
810
+ VersionNumber?: number | undefined;
811
+ /**
812
+ * <p>The alias of the theme that you want to describe. If you name a specific alias, you
813
+ * describe the version that the alias points to. You can specify the latest version of the
814
+ * theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
815
+ * parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>
816
+ * @public
817
+ */
818
+ AliasName?: string | undefined;
819
+ }
820
+ /**
821
+ * @public
822
+ * @enum
823
+ */
824
+ export declare const ThemeType: {
825
+ readonly ALL: "ALL";
826
+ readonly CUSTOM: "CUSTOM";
827
+ readonly QUICKSIGHT: "QUICKSIGHT";
828
+ };
829
+ /**
830
+ * @public
831
+ */
832
+ export type ThemeType = (typeof ThemeType)[keyof typeof ThemeType];
833
+ /**
834
+ * @public
835
+ * @enum
836
+ */
837
+ export declare const ThemeErrorType: {
838
+ readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
839
+ };
840
+ /**
841
+ * @public
842
+ */
843
+ export type ThemeErrorType = (typeof ThemeErrorType)[keyof typeof ThemeErrorType];
844
+ /**
845
+ * <p>Theme error.</p>
846
+ * @public
847
+ */
848
+ export interface ThemeError {
849
+ /**
850
+ * <p>The type of error.</p>
851
+ * @public
852
+ */
853
+ Type?: ThemeErrorType | undefined;
854
+ /**
855
+ * <p>The error message.</p>
856
+ * @public
857
+ */
858
+ Message?: string | undefined;
859
+ }
860
+ /**
861
+ * <p>A version of a theme.</p>
862
+ * @public
863
+ */
864
+ export interface ThemeVersion {
865
+ /**
866
+ * <p>The version number of the theme.</p>
867
+ * @public
868
+ */
869
+ VersionNumber?: number | undefined;
870
+ /**
871
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
872
+ * @public
873
+ */
874
+ Arn?: string | undefined;
875
+ /**
876
+ * <p>The description of the theme.</p>
877
+ * @public
878
+ */
879
+ Description?: string | undefined;
880
+ /**
881
+ * <p>The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All
882
+ * themes initially inherit from a default Amazon QuickSight theme.</p>
883
+ * @public
884
+ */
885
+ BaseThemeId?: string | undefined;
886
+ /**
887
+ * <p>The date and time that this theme version was created.</p>
888
+ * @public
889
+ */
890
+ CreatedTime?: Date | undefined;
891
+ /**
892
+ * <p>The theme configuration, which contains all the theme display properties.</p>
893
+ * @public
894
+ */
895
+ Configuration?: ThemeConfiguration | undefined;
896
+ /**
897
+ * <p>Errors associated with the theme.</p>
898
+ * @public
899
+ */
900
+ Errors?: ThemeError[] | undefined;
901
+ /**
902
+ * <p>The status of the theme version.</p>
903
+ * @public
904
+ */
905
+ Status?: ResourceStatus | undefined;
906
+ }
907
+ /**
908
+ * <p>Summary information about a theme.</p>
909
+ * @public
910
+ */
911
+ export interface Theme {
912
+ /**
913
+ * <p>The Amazon Resource Name (ARN) of the theme.</p>
914
+ * @public
915
+ */
916
+ Arn?: string | undefined;
917
+ /**
918
+ * <p>The name that the user gives to the theme.</p>
919
+ * @public
920
+ */
921
+ Name?: string | undefined;
922
+ /**
923
+ * <p>The identifier that the user gives to the theme.</p>
924
+ * @public
925
+ */
926
+ ThemeId?: string | undefined;
927
+ /**
928
+ * <p>A version of a theme.</p>
929
+ * @public
930
+ */
931
+ Version?: ThemeVersion | undefined;
932
+ /**
933
+ * <p>The date and time that the theme was created.</p>
934
+ * @public
935
+ */
936
+ CreatedTime?: Date | undefined;
937
+ /**
938
+ * <p>The date and time that the theme was last updated.</p>
939
+ * @public
940
+ */
941
+ LastUpdatedTime?: Date | undefined;
942
+ /**
943
+ * <p>The type of theme, based on how it was created. Valid values include:
944
+ * <code>QUICKSIGHT</code> and <code>CUSTOM</code>.</p>
945
+ * @public
946
+ */
947
+ Type?: ThemeType | undefined;
948
+ }
949
+ /**
950
+ * @public
951
+ */
952
+ export interface DescribeThemeResponse {
953
+ /**
954
+ * <p>The information about the theme that you are describing.</p>
955
+ * @public
956
+ */
957
+ Theme?: Theme | undefined;
958
+ /**
959
+ * <p>The HTTP status of the request.</p>
960
+ * @public
961
+ */
962
+ Status?: number | undefined;
963
+ /**
964
+ * <p>The Amazon Web Services request ID for this operation.</p>
965
+ * @public
966
+ */
967
+ RequestId?: string | undefined;
968
+ }
969
+ /**
970
+ * @public
971
+ */
972
+ export interface DescribeThemeAliasRequest {
973
+ /**
974
+ * <p>The ID of the Amazon Web Services account that contains the theme alias that you're
975
+ * describing.</p>
976
+ * @public
977
+ */
978
+ AwsAccountId: string | undefined;
979
+ /**
980
+ * <p>The ID for the theme.</p>
981
+ * @public
982
+ */
983
+ ThemeId: string | undefined;
984
+ /**
985
+ * <p>The name of the theme alias that you want to describe.</p>
986
+ * @public
987
+ */
988
+ AliasName: string | undefined;
989
+ }
990
+ /**
991
+ * @public
992
+ */
993
+ export interface DescribeThemeAliasResponse {
994
+ /**
995
+ * <p>Information about the theme alias.</p>
996
+ * @public
997
+ */
998
+ ThemeAlias?: ThemeAlias | undefined;
999
+ /**
1000
+ * <p>The HTTP status of the request.</p>
1001
+ * @public
1002
+ */
1003
+ Status?: number | undefined;
1004
+ /**
1005
+ * <p>The Amazon Web Services request ID for this operation.</p>
1006
+ * @public
1007
+ */
1008
+ RequestId?: string | undefined;
1009
+ }
1010
+ /**
1011
+ * @public
1012
+ */
1013
+ export interface DescribeThemePermissionsRequest {
1014
+ /**
1015
+ * <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
1016
+ * @public
1017
+ */
1018
+ AwsAccountId: string | undefined;
1019
+ /**
1020
+ * <p>The ID for the theme that you want to describe permissions for.</p>
1021
+ * @public
1022
+ */
1023
+ ThemeId: string | undefined;
1024
+ }
1025
+ /**
1026
+ * @public
1027
+ */
1028
+ export interface DescribeThemePermissionsResponse {
1029
+ /**
1030
+ * <p>The ID for the theme.</p>
1031
+ * @public
1032
+ */
1033
+ ThemeId?: string | undefined;
1034
+ /**
1035
+ * <p>The Amazon Resource Name (ARN) of the theme.</p>
1036
+ * @public
1037
+ */
1038
+ ThemeArn?: string | undefined;
1039
+ /**
1040
+ * <p>A list of resource permissions set on the theme. </p>
1041
+ * @public
1042
+ */
1043
+ Permissions?: ResourcePermission[] | undefined;
1044
+ /**
1045
+ * <p>The Amazon Web Services request ID for this operation.</p>
1046
+ * @public
1047
+ */
1048
+ RequestId?: string | undefined;
1049
+ /**
1050
+ * <p>The HTTP status of the request.</p>
1051
+ * @public
1052
+ */
1053
+ Status?: number | undefined;
1054
+ }
1055
+ /**
1056
+ * @public
1057
+ */
1058
+ export interface DescribeTopicRequest {
1059
+ /**
1060
+ * <p>The Amazon Web Services account ID.</p>
1061
+ * @public
1062
+ */
1063
+ AwsAccountId: string | undefined;
1064
+ /**
1065
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1066
+ * @public
1067
+ */
1068
+ TopicId: string | undefined;
1069
+ }
1070
+ /**
1071
+ * @public
1072
+ */
1073
+ export interface DescribeTopicResponse {
1074
+ /**
1075
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
1076
+ * @public
1077
+ */
1078
+ Arn?: string | undefined;
1079
+ /**
1080
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1081
+ * @public
1082
+ */
1083
+ TopicId?: string | undefined;
1084
+ /**
1085
+ * <p>The definition of a topic.</p>
1086
+ * @public
1087
+ */
1088
+ Topic?: TopicDetails | undefined;
1089
+ /**
1090
+ * <p>The Amazon Web Services request ID for this operation.</p>
1091
+ * @public
1092
+ */
1093
+ RequestId?: string | undefined;
1094
+ /**
1095
+ * <p>The HTTP status of the request.</p>
1096
+ * @public
1097
+ */
1098
+ Status?: number | undefined;
1099
+ }
1100
+ /**
1101
+ * @public
1102
+ */
1103
+ export interface DescribeTopicPermissionsRequest {
1104
+ /**
1105
+ * <p>The ID of the Amazon Web Services account that contains the topic that you want
1106
+ * described.</p>
1107
+ * @public
1108
+ */
1109
+ AwsAccountId: string | undefined;
1110
+ /**
1111
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1112
+ * @public
1113
+ */
1114
+ TopicId: string | undefined;
1115
+ }
6
1116
  /**
7
1117
  * @public
8
1118
  */
@@ -1418,24 +2528,6 @@ export interface IAMPolicyAssignmentSummary {
1418
2528
  */
1419
2529
  AssignmentStatus?: AssignmentStatus | undefined;
1420
2530
  }
1421
- /**
1422
- * <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
1423
- * @public
1424
- */
1425
- export declare class InvalidRequestException extends __BaseException {
1426
- readonly name: "InvalidRequestException";
1427
- readonly $fault: "client";
1428
- Message?: string | undefined;
1429
- /**
1430
- * <p>The Amazon Web Services request ID for this request.</p>
1431
- * @public
1432
- */
1433
- RequestId?: string | undefined;
1434
- /**
1435
- * @internal
1436
- */
1437
- constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
1438
- }
1439
2531
  /**
1440
2532
  * @public
1441
2533
  */
@@ -1571,6 +2663,87 @@ export interface ListAssetBundleImportJobsResponse {
1571
2663
  */
1572
2664
  Status?: number | undefined;
1573
2665
  }
2666
+ /**
2667
+ * @public
2668
+ */
2669
+ export interface ListBrandsRequest {
2670
+ /**
2671
+ * <p>The ID of the Amazon Web Services account that owns the brands that you want to list.</p>
2672
+ * @public
2673
+ */
2674
+ AwsAccountId: string | undefined;
2675
+ /**
2676
+ * <p>The maximum number of results to be returned in a single request.</p>
2677
+ * @public
2678
+ */
2679
+ MaxResults?: number | undefined;
2680
+ /**
2681
+ * <p>The token for the next set of results, or null if there are no more results.</p>
2682
+ * @public
2683
+ */
2684
+ NextToken?: string | undefined;
2685
+ }
2686
+ /**
2687
+ * @public
2688
+ */
2689
+ export interface ListBrandsResponse {
2690
+ /**
2691
+ * <p>The token for the next set of results, or null if there are no more results.</p>
2692
+ * @public
2693
+ */
2694
+ NextToken?: string | undefined;
2695
+ /**
2696
+ * <p>A list of all brands in your Amazon Web Services account. This structure provides basic
2697
+ * information about each brand.</p>
2698
+ * @public
2699
+ */
2700
+ Brands?: BrandSummary[] | undefined;
2701
+ }
2702
+ /**
2703
+ * @public
2704
+ */
2705
+ export interface ListCustomPermissionsRequest {
2706
+ /**
2707
+ * <p>The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.</p>
2708
+ * @public
2709
+ */
2710
+ AwsAccountId: string | undefined;
2711
+ /**
2712
+ * <p>The maximum number of results to return.</p>
2713
+ * @public
2714
+ */
2715
+ MaxResults?: number | undefined;
2716
+ /**
2717
+ * <p>The token for the next set of results, or null if there are no more results.</p>
2718
+ * @public
2719
+ */
2720
+ NextToken?: string | undefined;
2721
+ }
2722
+ /**
2723
+ * @public
2724
+ */
2725
+ export interface ListCustomPermissionsResponse {
2726
+ /**
2727
+ * <p>The HTTP status of the request.</p>
2728
+ * @public
2729
+ */
2730
+ Status?: number | undefined;
2731
+ /**
2732
+ * <p>A list of custom permissions profiles.</p>
2733
+ * @public
2734
+ */
2735
+ CustomPermissionsList?: CustomPermissions[] | undefined;
2736
+ /**
2737
+ * <p>The token for the next set of results, or null if there are no more results.</p>
2738
+ * @public
2739
+ */
2740
+ NextToken?: string | undefined;
2741
+ /**
2742
+ * <p>The Amazon Web Services request ID for this operation.</p>
2743
+ * @public
2744
+ */
2745
+ RequestId?: string | undefined;
2746
+ }
1574
2747
  /**
1575
2748
  * @public
1576
2749
  */
@@ -4434,6 +5607,151 @@ export interface UpdateAnalysisPermissionsResponse {
4434
5607
  */
4435
5608
  Status?: number | undefined;
4436
5609
  }
5610
+ /**
5611
+ * @public
5612
+ */
5613
+ export interface UpdateBrandRequest {
5614
+ /**
5615
+ * <p>The ID of the Amazon Web Services account that owns the brand.</p>
5616
+ * @public
5617
+ */
5618
+ AwsAccountId: string | undefined;
5619
+ /**
5620
+ * <p>The ID of the Amazon QuickSight brand.</p>
5621
+ * @public
5622
+ */
5623
+ BrandId: string | undefined;
5624
+ /**
5625
+ * <p>The definition of the brand.</p>
5626
+ * @public
5627
+ */
5628
+ BrandDefinition?: BrandDefinition | undefined;
5629
+ }
5630
+ /**
5631
+ * @public
5632
+ */
5633
+ export interface UpdateBrandResponse {
5634
+ /**
5635
+ * <p>The Amazon Web Services request ID for this operation.</p>
5636
+ * @public
5637
+ */
5638
+ RequestId?: string | undefined;
5639
+ /**
5640
+ * <p>The details of the brand.</p>
5641
+ * @public
5642
+ */
5643
+ BrandDetail?: BrandDetail | undefined;
5644
+ /**
5645
+ * <p>The definition of the brand.</p>
5646
+ * @public
5647
+ */
5648
+ BrandDefinition?: BrandDefinition | undefined;
5649
+ }
5650
+ /**
5651
+ * @public
5652
+ */
5653
+ export interface UpdateBrandAssignmentRequest {
5654
+ /**
5655
+ * <p>The ID of the Amazon Web Services account that owns the brand assignment.</p>
5656
+ * @public
5657
+ */
5658
+ AwsAccountId: string | undefined;
5659
+ /**
5660
+ * <p>The Amazon Resource Name (ARN) of the brand.</p>
5661
+ * @public
5662
+ */
5663
+ BrandArn: string | undefined;
5664
+ }
5665
+ /**
5666
+ * @public
5667
+ */
5668
+ export interface UpdateBrandAssignmentResponse {
5669
+ /**
5670
+ * <p>The Amazon Web Services request ID for this operation.</p>
5671
+ * @public
5672
+ */
5673
+ RequestId?: string | undefined;
5674
+ /**
5675
+ * <p>The Amazon Resource Name (ARN) of the brand.</p>
5676
+ * @public
5677
+ */
5678
+ BrandArn?: string | undefined;
5679
+ }
5680
+ /**
5681
+ * @public
5682
+ */
5683
+ export interface UpdateBrandPublishedVersionRequest {
5684
+ /**
5685
+ * <p>The ID of the Amazon Web Services account that owns the brand.</p>
5686
+ * @public
5687
+ */
5688
+ AwsAccountId: string | undefined;
5689
+ /**
5690
+ * <p>The ID of the Amazon QuickSight brand.</p>
5691
+ * @public
5692
+ */
5693
+ BrandId: string | undefined;
5694
+ /**
5695
+ * <p>The ID of the published version.</p>
5696
+ * @public
5697
+ */
5698
+ VersionId: string | undefined;
5699
+ }
5700
+ /**
5701
+ * @public
5702
+ */
5703
+ export interface UpdateBrandPublishedVersionResponse {
5704
+ /**
5705
+ * <p>The Amazon Web Services request ID for this operation.</p>
5706
+ * @public
5707
+ */
5708
+ RequestId?: string | undefined;
5709
+ /**
5710
+ * <p>The ID of the published version.</p>
5711
+ * @public
5712
+ */
5713
+ VersionId?: string | undefined;
5714
+ }
5715
+ /**
5716
+ * @public
5717
+ */
5718
+ export interface UpdateCustomPermissionsRequest {
5719
+ /**
5720
+ * <p>The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.</p>
5721
+ * @public
5722
+ */
5723
+ AwsAccountId: string | undefined;
5724
+ /**
5725
+ * <p>The name of the custom permissions profile that you want to update.</p>
5726
+ * @public
5727
+ */
5728
+ CustomPermissionsName: string | undefined;
5729
+ /**
5730
+ * <p>A set of actions to include in the custom permissions profile.</p>
5731
+ * @public
5732
+ */
5733
+ Capabilities?: Capabilities | undefined;
5734
+ }
5735
+ /**
5736
+ * @public
5737
+ */
5738
+ export interface UpdateCustomPermissionsResponse {
5739
+ /**
5740
+ * <p>The HTTP status of the request.</p>
5741
+ * @public
5742
+ */
5743
+ Status?: number | undefined;
5744
+ /**
5745
+ * <p>The Amazon Resource Name (ARN) of the custom permissions profile.</p>
5746
+ * @public
5747
+ */
5748
+ Arn?: string | undefined;
5749
+ /**
5750
+ * <p>The Amazon Web Services request ID for this operation.</p>
5751
+ * @public
5752
+ */
5753
+ RequestId?: string | undefined;
5754
+ }
4437
5755
  /**
4438
5756
  * @public
4439
5757
  */
@@ -6283,6 +7601,46 @@ export interface UpdateUserResponse {
6283
7601
  */
6284
7602
  Status?: number | undefined;
6285
7603
  }
7604
+ /**
7605
+ * @public
7606
+ */
7607
+ export interface UpdateUserCustomPermissionRequest {
7608
+ /**
7609
+ * <p>The username of the user that you want to update custom permissions for.</p>
7610
+ * @public
7611
+ */
7612
+ UserName: string | undefined;
7613
+ /**
7614
+ * <p>The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.</p>
7615
+ * @public
7616
+ */
7617
+ AwsAccountId: string | undefined;
7618
+ /**
7619
+ * <p>The namespace that the user belongs to.</p>
7620
+ * @public
7621
+ */
7622
+ Namespace: string | undefined;
7623
+ /**
7624
+ * <p>The name of the custom permissions that you want to update.</p>
7625
+ * @public
7626
+ */
7627
+ CustomPermissionsName: string | undefined;
7628
+ }
7629
+ /**
7630
+ * @public
7631
+ */
7632
+ export interface UpdateUserCustomPermissionResponse {
7633
+ /**
7634
+ * <p>The Amazon Web Services request ID for this operation.</p>
7635
+ * @public
7636
+ */
7637
+ RequestId?: string | undefined;
7638
+ /**
7639
+ * <p>The HTTP status of the request.</p>
7640
+ * @public
7641
+ */
7642
+ Status?: number | undefined;
7643
+ }
6286
7644
  /**
6287
7645
  * @public
6288
7646
  */
@@ -6514,6 +7872,14 @@ export interface ListTopicReviewedAnswersResponse {
6514
7872
  */
6515
7873
  RequestId?: string | undefined;
6516
7874
  }
7875
+ /**
7876
+ * @internal
7877
+ */
7878
+ export declare const DescribeTemplateDefinitionResponseFilterSensitiveLog: (obj: DescribeTemplateDefinitionResponse) => any;
7879
+ /**
7880
+ * @internal
7881
+ */
7882
+ export declare const DescribeTopicResponseFilterSensitiveLog: (obj: DescribeTopicResponse) => any;
6517
7883
  /**
6518
7884
  * @internal
6519
7885
  */