@aws-sdk/client-quicksight 3.369.0 → 3.376.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/QuickSight.js +6 -0
  3. package/dist-cjs/commands/DescribeDashboardSnapshotJobCommand.js +47 -0
  4. package/dist-cjs/commands/DescribeDashboardSnapshotJobResultCommand.js +47 -0
  5. package/dist-cjs/commands/StartDashboardSnapshotJobCommand.js +47 -0
  6. package/dist-cjs/commands/UpdateDataSetCommand.js +2 -2
  7. package/dist-cjs/commands/UpdateDataSourceCommand.js +2 -2
  8. package/dist-cjs/commands/UpdateTemplateCommand.js +2 -2
  9. package/dist-cjs/commands/index.js +3 -0
  10. package/dist-cjs/models/models_0.js +6 -12
  11. package/dist-cjs/models/models_1.js +35 -26
  12. package/dist-cjs/models/models_2.js +25 -3
  13. package/dist-cjs/models/models_3.js +39 -24
  14. package/dist-cjs/models/models_4.js +26 -1
  15. package/dist-cjs/pagination/ListGroupMembershipsPaginator.js +29 -0
  16. package/dist-cjs/pagination/ListGroupsPaginator.js +29 -0
  17. package/dist-cjs/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListIAMPolicyAssignmentsPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListUserGroupsPaginator.js +29 -0
  20. package/dist-cjs/pagination/ListUsersPaginator.js +29 -0
  21. package/dist-cjs/pagination/SearchGroupsPaginator.js +29 -0
  22. package/dist-cjs/pagination/index.js +7 -0
  23. package/dist-cjs/protocols/Aws_restJson1.js +326 -6
  24. package/dist-es/QuickSight.js +6 -0
  25. package/dist-es/commands/DescribeDashboardSnapshotJobCommand.js +43 -0
  26. package/dist-es/commands/DescribeDashboardSnapshotJobResultCommand.js +43 -0
  27. package/dist-es/commands/StartDashboardSnapshotJobCommand.js +43 -0
  28. package/dist-es/commands/UpdateDataSetCommand.js +1 -1
  29. package/dist-es/commands/UpdateDataSourceCommand.js +1 -1
  30. package/dist-es/commands/UpdateTemplateCommand.js +1 -1
  31. package/dist-es/commands/index.js +3 -0
  32. package/dist-es/models/models_0.js +3 -7
  33. package/dist-es/models/models_1.js +26 -22
  34. package/dist-es/models/models_2.js +22 -0
  35. package/dist-es/models/models_3.js +30 -19
  36. package/dist-es/models/models_4.js +22 -0
  37. package/dist-es/pagination/ListGroupMembershipsPaginator.js +25 -0
  38. package/dist-es/pagination/ListGroupsPaginator.js +25 -0
  39. package/dist-es/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +25 -0
  40. package/dist-es/pagination/ListIAMPolicyAssignmentsPaginator.js +25 -0
  41. package/dist-es/pagination/ListUserGroupsPaginator.js +25 -0
  42. package/dist-es/pagination/ListUsersPaginator.js +25 -0
  43. package/dist-es/pagination/SearchGroupsPaginator.js +25 -0
  44. package/dist-es/pagination/index.js +7 -0
  45. package/dist-es/protocols/Aws_restJson1.js +314 -0
  46. package/dist-types/QuickSight.d.ts +21 -0
  47. package/dist-types/QuickSightClient.d.ts +5 -2
  48. package/dist-types/commands/CreateAnalysisCommand.d.ts +48 -0
  49. package/dist-types/commands/CreateDashboardCommand.d.ts +48 -0
  50. package/dist-types/commands/CreateTemplateCommand.d.ts +48 -0
  51. package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +6 -0
  52. package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
  53. package/dist-types/commands/DeleteAnalysisCommand.d.ts +1 -1
  54. package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
  55. package/dist-types/commands/DeleteDataSetCommand.d.ts +1 -1
  56. package/dist-types/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
  57. package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
  58. package/dist-types/commands/DeleteFolderCommand.d.ts +1 -2
  59. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +48 -0
  60. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +48 -0
  61. package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +179 -0
  62. package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +155 -0
  63. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +48 -0
  64. package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +197 -0
  65. package/dist-types/commands/UpdateAnalysisCommand.d.ts +48 -0
  66. package/dist-types/commands/UpdateDashboardCommand.d.ts +48 -0
  67. package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
  68. package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
  69. package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
  70. package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
  71. package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
  73. package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
  75. package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
  76. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  77. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  78. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  79. package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
  80. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -2
  81. package/dist-types/commands/UpdateTemplateCommand.d.ts +49 -1
  82. package/dist-types/commands/index.d.ts +3 -0
  83. package/dist-types/models/models_0.d.ts +77 -47
  84. package/dist-types/models/models_1.d.ts +208 -213
  85. package/dist-types/models/models_2.d.ts +219 -220
  86. package/dist-types/models/models_3.d.ts +602 -805
  87. package/dist-types/models/models_4.d.ts +770 -2
  88. package/dist-types/pagination/ListGroupMembershipsPaginator.d.ts +7 -0
  89. package/dist-types/pagination/ListGroupsPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListUserGroupsPaginator.d.ts +7 -0
  93. package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
  94. package/dist-types/pagination/SearchGroupsPaginator.d.ts +7 -0
  95. package/dist-types/pagination/index.d.ts +7 -0
  96. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  97. package/dist-types/ts3.4/QuickSight.d.ts +57 -0
  98. package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
  99. package/dist-types/ts3.4/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/DeleteAnalysisCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/DeleteDataSetCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +1 -2
  106. package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobCommand.d.ts +42 -0
  107. package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +42 -0
  108. package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +42 -0
  109. package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
  111. package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
  114. package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
  115. package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
  116. package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
  117. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
  118. package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  119. package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  120. package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  121. package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
  122. package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +4 -2
  123. package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
  124. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  125. package/dist-types/ts3.4/models/models_0.d.ts +21 -17
  126. package/dist-types/ts3.4/models/models_1.d.ts +71 -81
  127. package/dist-types/ts3.4/models/models_2.d.ts +85 -67
  128. package/dist-types/ts3.4/models/models_3.d.ts +176 -222
  129. package/dist-types/ts3.4/models/models_4.d.ts +222 -1
  130. package/dist-types/ts3.4/pagination/ListGroupMembershipsPaginator.d.ts +11 -0
  131. package/dist-types/ts3.4/pagination/ListGroupsPaginator.d.ts +11 -0
  132. package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +11 -0
  133. package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +11 -0
  134. package/dist-types/ts3.4/pagination/ListUserGroupsPaginator.d.ts +11 -0
  135. package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
  136. package/dist-types/ts3.4/pagination/SearchGroupsPaginator.d.ts +11 -0
  137. package/dist-types/ts3.4/pagination/index.d.ts +7 -0
  138. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  139. package/package.json +16 -17
@@ -1,8 +1,227 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { AccountCustomization, AccountInfo, AccountSettings, ActiveIAMPolicyAssignment, Analysis, AnalysisError, Entity, ResourceStatus, Sheet } from "./models_0";
3
- import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, DashboardVisualId, FilterOperator } from "./models_1";
4
- import { _Parameters, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, ColumnGroup, ColumnLevelPermissionRule, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSet, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, DataSourceSearchFilter, DataSourceSummary, FieldFolder, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LogicalTable, MemberType, NamespaceStatus, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
3
+ import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, DashboardVisualId, FilterOperator, SnapshotFile, SnapshotS3DestinationConfiguration } from "./models_1";
4
+ import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSource, AssetBundleImportSourceDescription, AssignmentStatus, BookmarksConfigurations, Dashboard, DashboardError, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSet, DataSetConfiguration, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, MemberType, NamespaceStatus, RefreshSchedule, ResourcePermission, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_2";
5
5
  import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
6
+ /**
7
+ * @public
8
+ */
9
+ export interface DeleteAccountSubscriptionRequest {
10
+ /**
11
+ * <p>The Amazon Web Services account ID of the account that you want to delete.</p>
12
+ */
13
+ AwsAccountId: string | undefined;
14
+ }
15
+ /**
16
+ * @public
17
+ */
18
+ export interface DeleteAccountSubscriptionResponse {
19
+ /**
20
+ * <p>The Amazon Web Services request ID for this operation.</p>
21
+ */
22
+ RequestId?: string;
23
+ /**
24
+ * <p>The HTTP status of the request.</p>
25
+ */
26
+ Status?: number;
27
+ }
28
+ /**
29
+ * @public
30
+ */
31
+ export interface DeleteAnalysisRequest {
32
+ /**
33
+ * <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
34
+ */
35
+ AwsAccountId: string | undefined;
36
+ /**
37
+ * <p>The ID of the analysis that you're deleting.</p>
38
+ */
39
+ AnalysisId: string | undefined;
40
+ /**
41
+ * <p>A value that specifies the number of days that Amazon QuickSight waits before it deletes the
42
+ * analysis. You can't use this parameter with the <code>ForceDeleteWithoutRecovery</code>
43
+ * option in the same API call. The default value is 30.</p>
44
+ */
45
+ RecoveryWindowInDays?: number;
46
+ /**
47
+ * <p>This option defaults to the value <code>NoForceDeleteWithoutRecovery</code>. To
48
+ * immediately delete the analysis, add the <code>ForceDeleteWithoutRecovery</code> option.
49
+ * You can't restore an analysis after it's deleted. </p>
50
+ */
51
+ ForceDeleteWithoutRecovery?: boolean;
52
+ }
53
+ /**
54
+ * @public
55
+ */
56
+ export interface DeleteAnalysisResponse {
57
+ /**
58
+ * <p>The HTTP status of the request.</p>
59
+ */
60
+ Status?: number;
61
+ /**
62
+ * <p>The Amazon Resource Name (ARN) of the deleted analysis.</p>
63
+ */
64
+ Arn?: string;
65
+ /**
66
+ * <p>The ID of the deleted analysis.</p>
67
+ */
68
+ AnalysisId?: string;
69
+ /**
70
+ * <p>The date and time that the analysis is scheduled to be deleted.</p>
71
+ */
72
+ DeletionTime?: Date;
73
+ /**
74
+ * <p>The Amazon Web Services request ID for this operation.</p>
75
+ */
76
+ RequestId?: string;
77
+ }
78
+ /**
79
+ * @public
80
+ */
81
+ export interface DeleteDashboardRequest {
82
+ /**
83
+ * <p>The ID of the Amazon Web Services account that contains the dashboard that you're
84
+ * deleting.</p>
85
+ */
86
+ AwsAccountId: string | undefined;
87
+ /**
88
+ * <p>The ID for the dashboard.</p>
89
+ */
90
+ DashboardId: string | undefined;
91
+ /**
92
+ * <p>The version number of the dashboard. If the version number property is provided, only
93
+ * the specified version of the dashboard is deleted.</p>
94
+ */
95
+ VersionNumber?: number;
96
+ }
97
+ /**
98
+ * @public
99
+ */
100
+ export interface DeleteDashboardResponse {
101
+ /**
102
+ * <p>The HTTP status of the request.</p>
103
+ */
104
+ Status?: number;
105
+ /**
106
+ * <p>The Secure Socket Layer (SSL) properties that apply for the resource.</p>
107
+ */
108
+ Arn?: string;
109
+ /**
110
+ * <p>The ID of the dashboard.</p>
111
+ */
112
+ DashboardId?: string;
113
+ /**
114
+ * <p>The Amazon Web Services request ID for this operation.</p>
115
+ */
116
+ RequestId?: string;
117
+ }
118
+ /**
119
+ * @public
120
+ */
121
+ export interface DeleteDataSetRequest {
122
+ /**
123
+ * <p>The Amazon Web Services account ID.</p>
124
+ */
125
+ AwsAccountId: string | undefined;
126
+ /**
127
+ * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
128
+ */
129
+ DataSetId: string | undefined;
130
+ }
131
+ /**
132
+ * @public
133
+ */
134
+ export interface DeleteDataSetResponse {
135
+ /**
136
+ * <p>The Amazon Resource Name (ARN) of the dataset.</p>
137
+ */
138
+ Arn?: string;
139
+ /**
140
+ * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
141
+ */
142
+ DataSetId?: string;
143
+ /**
144
+ * <p>The Amazon Web Services request ID for this operation.</p>
145
+ */
146
+ RequestId?: string;
147
+ /**
148
+ * <p>The HTTP status of the request.</p>
149
+ */
150
+ Status?: number;
151
+ }
152
+ /**
153
+ * @public
154
+ */
155
+ export interface DeleteDataSetRefreshPropertiesRequest {
156
+ /**
157
+ * <p>The Amazon Web Services account ID.</p>
158
+ */
159
+ AwsAccountId: string | undefined;
160
+ /**
161
+ * <p>The ID of the dataset.</p>
162
+ */
163
+ DataSetId: string | undefined;
164
+ }
165
+ /**
166
+ * @public
167
+ */
168
+ export interface DeleteDataSetRefreshPropertiesResponse {
169
+ /**
170
+ * <p>The Amazon Web Services request ID for this operation.</p>
171
+ */
172
+ RequestId?: string;
173
+ /**
174
+ * <p>The HTTP status of the request.</p>
175
+ */
176
+ Status?: number;
177
+ }
178
+ /**
179
+ * @public
180
+ */
181
+ export interface DeleteDataSourceRequest {
182
+ /**
183
+ * <p>The Amazon Web Services account ID.</p>
184
+ */
185
+ AwsAccountId: string | undefined;
186
+ /**
187
+ * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
188
+ */
189
+ DataSourceId: string | undefined;
190
+ }
191
+ /**
192
+ * @public
193
+ */
194
+ export interface DeleteDataSourceResponse {
195
+ /**
196
+ * <p>The Amazon Resource Name (ARN) of the data source that you deleted.</p>
197
+ */
198
+ Arn?: string;
199
+ /**
200
+ * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
201
+ */
202
+ DataSourceId?: string;
203
+ /**
204
+ * <p>The Amazon Web Services request ID for this operation.</p>
205
+ */
206
+ RequestId?: string;
207
+ /**
208
+ * <p>The HTTP status of the request.</p>
209
+ */
210
+ Status?: number;
211
+ }
212
+ /**
213
+ * @public
214
+ */
215
+ export interface DeleteFolderRequest {
216
+ /**
217
+ * <p>The ID for the Amazon Web Services account that contains the folder.</p>
218
+ */
219
+ AwsAccountId: string | undefined;
220
+ /**
221
+ * <p>The ID of the folder.</p>
222
+ */
223
+ FolderId: string | undefined;
224
+ }
6
225
  /**
7
226
  * @public
8
227
  */
@@ -1262,96 +1481,343 @@ export interface DescribeDashboardPermissionsResponse {
1262
1481
  /**
1263
1482
  * @public
1264
1483
  */
1265
- export interface DescribeDataSetRequest {
1484
+ export interface DescribeDashboardSnapshotJobRequest {
1266
1485
  /**
1267
- * <p>The Amazon Web Services account ID.</p>
1486
+ * <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
1268
1487
  */
1269
1488
  AwsAccountId: string | undefined;
1270
1489
  /**
1271
- * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1490
+ * <p>The ID of the dashboard that you have started a snapshot job for.</p>
1272
1491
  */
1273
- DataSetId: string | undefined;
1492
+ DashboardId: string | undefined;
1493
+ /**
1494
+ * <p>The ID of the job to be described. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
1495
+ */
1496
+ SnapshotJobId: string | undefined;
1274
1497
  }
1275
1498
  /**
1276
1499
  * @public
1500
+ * @enum
1277
1501
  */
1278
- export interface DescribeDataSetResponse {
1279
- /**
1280
- * <p>Information on the dataset.</p>
1281
- */
1282
- DataSet?: DataSet;
1283
- /**
1284
- * <p>The Amazon Web Services request ID for this operation.</p>
1285
- */
1286
- RequestId?: string;
1502
+ export declare const SnapshotJobStatus: {
1503
+ readonly COMPLETED: "COMPLETED";
1504
+ readonly FAILED: "FAILED";
1505
+ readonly QUEUED: "QUEUED";
1506
+ readonly RUNNING: "RUNNING";
1507
+ };
1508
+ /**
1509
+ * @public
1510
+ */
1511
+ export type SnapshotJobStatus = (typeof SnapshotJobStatus)[keyof typeof SnapshotJobStatus];
1512
+ /**
1513
+ * @public
1514
+ * <p>A structure that contains information on the Amazon S3 destinations of the generated snapshot.</p>
1515
+ */
1516
+ export interface SnapshotDestinationConfiguration {
1287
1517
  /**
1288
- * <p>The HTTP status of the request.</p>
1518
+ * <p>
1519
+ * A list of <code>SnapshotS3DestinationConfiguration</code> objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 <code>S3DestinationConfiguration</code>.
1520
+ * </p>
1289
1521
  */
1290
- Status?: number;
1522
+ S3Destinations?: SnapshotS3DestinationConfiguration[];
1291
1523
  }
1292
1524
  /**
1293
1525
  * @public
1526
+ * <p>A structure that contains the information on the snapshot files.</p>
1294
1527
  */
1295
- export interface DescribeDataSetPermissionsRequest {
1528
+ export interface SnapshotFileGroup {
1296
1529
  /**
1297
- * <p>The Amazon Web Services account ID.</p>
1298
- */
1299
- AwsAccountId: string | undefined;
1300
- /**
1301
- * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1530
+ * <p>A list of <code>SnapshotFile</code> objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.</p>
1302
1531
  */
1303
- DataSetId: string | undefined;
1532
+ Files?: SnapshotFile[];
1304
1533
  }
1305
1534
  /**
1306
1535
  * @public
1536
+ * <p>Describes the configuration of the dashboard snapshot.</p>
1307
1537
  */
1308
- export interface DescribeDataSetPermissionsResponse {
1309
- /**
1310
- * <p>The Amazon Resource Name (ARN) of the dataset.</p>
1311
- */
1312
- DataSetArn?: string;
1313
- /**
1314
- * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1315
- */
1316
- DataSetId?: string;
1538
+ export interface SnapshotConfiguration {
1317
1539
  /**
1318
- * <p>A list of resource permissions on the dataset.</p>
1540
+ * <p>A list of <code>SnapshotJobResultFileGroup</code> objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 <code>FileGroup</code> configurations.</p>
1319
1541
  */
1320
- Permissions?: ResourcePermission[];
1542
+ FileGroups: SnapshotFileGroup[] | undefined;
1321
1543
  /**
1322
- * <p>The Amazon Web Services request ID for this operation.</p>
1544
+ * <p>A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.</p>
1323
1545
  */
1324
- RequestId?: string;
1546
+ DestinationConfiguration?: SnapshotDestinationConfiguration;
1325
1547
  /**
1326
- * <p>The HTTP status of the request.</p>
1548
+ * <p>A list of Amazon QuickSight parameters and the list's override values.</p>
1327
1549
  */
1328
- Status?: number;
1550
+ Parameters?: _Parameters;
1329
1551
  }
1330
1552
  /**
1331
1553
  * @public
1554
+ * <p>Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.</p>
1332
1555
  */
1333
- export interface DescribeDataSetRefreshPropertiesRequest {
1556
+ export interface SnapshotAnonymousUserRedacted {
1334
1557
  /**
1335
- * <p>The Amazon Web Services account ID.</p>
1558
+ * <p>The tag keys for the <code>RowLevelPermissionTags</code>.</p>
1336
1559
  */
1337
- AwsAccountId: string | undefined;
1560
+ RowLevelPermissionTagKeys?: string[];
1561
+ }
1562
+ /**
1563
+ * @public
1564
+ * <p>A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.
1565
+ * </p>
1566
+ */
1567
+ export interface SnapshotUserConfigurationRedacted {
1338
1568
  /**
1339
- * <p>The ID of the dataset.</p>
1569
+ * <p>
1570
+ * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.
1571
+ * </p>
1340
1572
  */
1341
- DataSetId: string | undefined;
1573
+ AnonymousUsers?: SnapshotAnonymousUserRedacted[];
1342
1574
  }
1343
1575
  /**
1344
1576
  * @public
1345
1577
  */
1346
- export interface DescribeDataSetRefreshPropertiesResponse {
1578
+ export interface DescribeDashboardSnapshotJobResponse {
1347
1579
  /**
1348
- * <p>The Amazon Web Services request ID for this operation.</p>
1580
+ * <p>
1581
+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
1582
+ * </p>
1349
1583
  */
1350
- RequestId?: string;
1584
+ AwsAccountId?: string;
1351
1585
  /**
1352
- * <p>The HTTP status of the request.</p>
1586
+ * <p>The ID of the dashboard that you have started a snapshot job for.</p>
1353
1587
  */
1354
- Status?: number;
1588
+ DashboardId?: string;
1589
+ /**
1590
+ * <p>The ID of the job to be described. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
1591
+ */
1592
+ SnapshotJobId?: string;
1593
+ /**
1594
+ * <p>The user configuration for the snapshot job. This information is provided when you make a <code>StartDashboardSnapshotJob</code> API call.</p>
1595
+ */
1596
+ UserConfiguration?: SnapshotUserConfigurationRedacted;
1597
+ /**
1598
+ * <p>The snapshot configuration of the job. This information is provided when you make a <code>StartDashboardSnapshotJob</code> API call.</p>
1599
+ */
1600
+ SnapshotConfiguration?: SnapshotConfiguration;
1601
+ /**
1602
+ * <p>The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
1603
+ */
1604
+ Arn?: string;
1605
+ /**
1606
+ * <p>Indicates the status of a job. The status updates as the job executes. This shows one of the following values.</p>
1607
+ * <ul>
1608
+ * <li>
1609
+ * <p>
1610
+ * <code>COMPLETED</code> - The job was completed successfully.</p>
1611
+ * </li>
1612
+ * <li>
1613
+ * <p>
1614
+ * <code>FAILED</code> - The job failed to execute.</p>
1615
+ * </li>
1616
+ * <li>
1617
+ * <p>
1618
+ * <code>QUEUED</code> - The job is queued and hasn't started yet.</p>
1619
+ * </li>
1620
+ * <li>
1621
+ * <p>
1622
+ * <code>RUNNING</code> - The job is still running.</p>
1623
+ * </li>
1624
+ * </ul>
1625
+ */
1626
+ JobStatus?: SnapshotJobStatus | string;
1627
+ /**
1628
+ * <p>
1629
+ * The time that the snapshot job was created.
1630
+ * </p>
1631
+ */
1632
+ CreatedTime?: Date;
1633
+ /**
1634
+ * <p>
1635
+ * The time that the snapshot job status was last updated.
1636
+ * </p>
1637
+ */
1638
+ LastUpdatedTime?: Date;
1639
+ /**
1640
+ * <p>
1641
+ * The Amazon Web Services request ID for this operation.
1642
+ * </p>
1643
+ */
1644
+ RequestId?: string;
1645
+ /**
1646
+ * <p>The HTTP status of the request</p>
1647
+ */
1648
+ Status?: number;
1649
+ }
1650
+ /**
1651
+ * @public
1652
+ */
1653
+ export interface DescribeDashboardSnapshotJobResultRequest {
1654
+ /**
1655
+ * <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
1656
+ */
1657
+ AwsAccountId: string | undefined;
1658
+ /**
1659
+ * <p>The ID of the dashboard that you have started a snapshot job for.</p>
1660
+ */
1661
+ DashboardId: string | undefined;
1662
+ /**
1663
+ * <p>The ID of the job to be described. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
1664
+ */
1665
+ SnapshotJobId: string | undefined;
1666
+ }
1667
+ /**
1668
+ * @public
1669
+ * <p>An object that contains information on the error that caused the snapshot job to fail.</p>
1670
+ */
1671
+ export interface SnapshotJobErrorInfo {
1672
+ /**
1673
+ * <p>The error message.</p>
1674
+ */
1675
+ ErrorMessage?: string;
1676
+ /**
1677
+ * <p>The error type.</p>
1678
+ */
1679
+ ErrorType?: string;
1680
+ }
1681
+ /**
1682
+ * @public
1683
+ * <p>An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.</p>
1684
+ */
1685
+ export interface SnapshotJobResult {
1686
+ /**
1687
+ * <p> A list of <code>AnonymousUserSnapshotJobResult</code> objects that contain information on anonymous users and their user configurations. This data provided by you when you make a <code>StartDashboardSnapshotJob</code> API call.</p>
1688
+ */
1689
+ AnonymousUsers?: AnonymousUserSnapshotJobResult[];
1690
+ }
1691
+ /**
1692
+ * @public
1693
+ */
1694
+ export interface DescribeDashboardSnapshotJobResultResponse {
1695
+ /**
1696
+ * <p>The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
1697
+ */
1698
+ Arn?: string;
1699
+ /**
1700
+ * <p>Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a <code>COMPLETED</code> or <code>FAILED</code> status.</p>
1701
+ */
1702
+ JobStatus?: SnapshotJobStatus | string;
1703
+ /**
1704
+ * <p>The time that a snapshot job was created.</p>
1705
+ */
1706
+ CreatedTime?: Date;
1707
+ /**
1708
+ * <p>The time that a snapshot job status was last updated.</p>
1709
+ */
1710
+ LastUpdatedTime?: Date;
1711
+ /**
1712
+ * <p>The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.</p>
1713
+ */
1714
+ Result?: SnapshotJobResult;
1715
+ /**
1716
+ * <p>Displays information for the error that caused a job to fail.</p>
1717
+ */
1718
+ ErrorInfo?: SnapshotJobErrorInfo;
1719
+ /**
1720
+ * <p>The Amazon Web Services request ID for this operation.</p>
1721
+ */
1722
+ RequestId?: string;
1723
+ /**
1724
+ * <p>The HTTP status of the request</p>
1725
+ */
1726
+ Status?: number;
1727
+ }
1728
+ /**
1729
+ * @public
1730
+ */
1731
+ export interface DescribeDataSetRequest {
1732
+ /**
1733
+ * <p>The Amazon Web Services account ID.</p>
1734
+ */
1735
+ AwsAccountId: string | undefined;
1736
+ /**
1737
+ * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1738
+ */
1739
+ DataSetId: string | undefined;
1740
+ }
1741
+ /**
1742
+ * @public
1743
+ */
1744
+ export interface DescribeDataSetResponse {
1745
+ /**
1746
+ * <p>Information on the dataset.</p>
1747
+ */
1748
+ DataSet?: DataSet;
1749
+ /**
1750
+ * <p>The Amazon Web Services request ID for this operation.</p>
1751
+ */
1752
+ RequestId?: string;
1753
+ /**
1754
+ * <p>The HTTP status of the request.</p>
1755
+ */
1756
+ Status?: number;
1757
+ }
1758
+ /**
1759
+ * @public
1760
+ */
1761
+ export interface DescribeDataSetPermissionsRequest {
1762
+ /**
1763
+ * <p>The Amazon Web Services account ID.</p>
1764
+ */
1765
+ AwsAccountId: string | undefined;
1766
+ /**
1767
+ * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1768
+ */
1769
+ DataSetId: string | undefined;
1770
+ }
1771
+ /**
1772
+ * @public
1773
+ */
1774
+ export interface DescribeDataSetPermissionsResponse {
1775
+ /**
1776
+ * <p>The Amazon Resource Name (ARN) of the dataset.</p>
1777
+ */
1778
+ DataSetArn?: string;
1779
+ /**
1780
+ * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1781
+ */
1782
+ DataSetId?: string;
1783
+ /**
1784
+ * <p>A list of resource permissions on the dataset.</p>
1785
+ */
1786
+ Permissions?: ResourcePermission[];
1787
+ /**
1788
+ * <p>The Amazon Web Services request ID for this operation.</p>
1789
+ */
1790
+ RequestId?: string;
1791
+ /**
1792
+ * <p>The HTTP status of the request.</p>
1793
+ */
1794
+ Status?: number;
1795
+ }
1796
+ /**
1797
+ * @public
1798
+ */
1799
+ export interface DescribeDataSetRefreshPropertiesRequest {
1800
+ /**
1801
+ * <p>The Amazon Web Services account ID.</p>
1802
+ */
1803
+ AwsAccountId: string | undefined;
1804
+ /**
1805
+ * <p>The ID of the dataset.</p>
1806
+ */
1807
+ DataSetId: string | undefined;
1808
+ }
1809
+ /**
1810
+ * @public
1811
+ */
1812
+ export interface DescribeDataSetRefreshPropertiesResponse {
1813
+ /**
1814
+ * <p>The Amazon Web Services request ID for this operation.</p>
1815
+ */
1816
+ RequestId?: string;
1817
+ /**
1818
+ * <p>The HTTP status of the request.</p>
1819
+ */
1820
+ Status?: number;
1355
1821
  /**
1356
1822
  * <p>The dataset refresh properties.</p>
1357
1823
  */
@@ -5952,6 +6418,77 @@ export interface StartAssetBundleImportJobResponse {
5952
6418
  */
5953
6419
  Status?: number;
5954
6420
  }
6421
+ /**
6422
+ * @public
6423
+ * <p>A structure that contains information on the anonymous user configuration.</p>
6424
+ */
6425
+ export interface SnapshotAnonymousUser {
6426
+ /**
6427
+ * <p>The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a <code>DataSet$RowLevelPermissionTagConfiguration</code> API call.</p>
6428
+ * <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, 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>
6429
+ */
6430
+ RowLevelPermissionTags?: SessionTag[];
6431
+ }
6432
+ /**
6433
+ * @public
6434
+ * <p>A structure that contains information about the users that the dashboard snapshot is generated for.</p>
6435
+ */
6436
+ export interface SnapshotUserConfiguration {
6437
+ /**
6438
+ * <p>An array of records that describe the anonymous users that the dashboard snapshot is generated for.</p>
6439
+ */
6440
+ AnonymousUsers?: SnapshotAnonymousUser[];
6441
+ }
6442
+ /**
6443
+ * @public
6444
+ */
6445
+ export interface StartDashboardSnapshotJobRequest {
6446
+ /**
6447
+ * <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
6448
+ */
6449
+ AwsAccountId: string | undefined;
6450
+ /**
6451
+ * <p>The ID of the dashboard that you want to start a snapshot job for.
6452
+ * </p>
6453
+ */
6454
+ DashboardId: string | undefined;
6455
+ /**
6456
+ * <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
6457
+ */
6458
+ SnapshotJobId: string | undefined;
6459
+ /**
6460
+ * <p>
6461
+ * A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.</p>
6462
+ */
6463
+ UserConfiguration: SnapshotUserConfiguration | undefined;
6464
+ /**
6465
+ * <p>A structure that describes the configuration of the dashboard snapshot.</p>
6466
+ */
6467
+ SnapshotConfiguration: SnapshotConfiguration | undefined;
6468
+ }
6469
+ /**
6470
+ * @public
6471
+ */
6472
+ export interface StartDashboardSnapshotJobResponse {
6473
+ /**
6474
+ * <p>The Amazon Resource Name (ARN) for the dashboard snapshot job.</p>
6475
+ */
6476
+ Arn?: string;
6477
+ /**
6478
+ * <p>The ID of the job. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
6479
+ */
6480
+ SnapshotJobId?: string;
6481
+ /**
6482
+ * <p>
6483
+ * The Amazon Web Services request ID for this operation.
6484
+ * </p>
6485
+ */
6486
+ RequestId?: string;
6487
+ /**
6488
+ * <p>The HTTP status of the request</p>
6489
+ */
6490
+ Status?: number;
6491
+ }
5955
6492
  /**
5956
6493
  * @public
5957
6494
  */
@@ -6321,773 +6858,33 @@ export interface UpdateDashboardResponse {
6321
6858
  RequestId?: string;
6322
6859
  }
6323
6860
  /**
6324
- * @public
6861
+ * @internal
6325
6862
  */
6326
- export interface UpdateDashboardPermissionsRequest {
6327
- /**
6328
- * <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
6329
- * updating.</p>
6330
- */
6331
- AwsAccountId: string | undefined;
6332
- /**
6333
- * <p>The ID for the dashboard.</p>
6334
- */
6335
- DashboardId: string | undefined;
6336
- /**
6337
- * <p>The permissions that you want to grant on this resource.</p>
6338
- */
6339
- GrantPermissions?: ResourcePermission[];
6340
- /**
6341
- * <p>The permissions that you want to revoke from this resource.</p>
6342
- */
6343
- RevokePermissions?: ResourcePermission[];
6344
- /**
6345
- * <p>Grants link permissions to all users in a defined namespace.</p>
6346
- */
6347
- GrantLinkPermissions?: ResourcePermission[];
6348
- /**
6349
- * <p>Revokes link permissions from all users in a defined namespace.</p>
6350
- */
6351
- RevokeLinkPermissions?: ResourcePermission[];
6352
- }
6863
+ export declare const DescribeAnalysisDefinitionResponseFilterSensitiveLog: (obj: DescribeAnalysisDefinitionResponse) => any;
6353
6864
  /**
6354
- * @public
6355
- */
6356
- export interface UpdateDashboardPermissionsResponse {
6357
- /**
6358
- * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
6359
- */
6360
- DashboardArn?: string;
6361
- /**
6362
- * <p>The ID for the dashboard.</p>
6363
- */
6364
- DashboardId?: string;
6365
- /**
6366
- * <p>Information about the permissions on the dashboard.</p>
6367
- */
6368
- Permissions?: ResourcePermission[];
6369
- /**
6370
- * <p>The Amazon Web Services request ID for this operation.</p>
6371
- */
6372
- RequestId?: string;
6373
- /**
6374
- * <p>The HTTP status of the request.</p>
6375
- */
6376
- Status?: number;
6377
- /**
6378
- * <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
6379
- */
6380
- LinkSharingConfiguration?: LinkSharingConfiguration;
6381
- }
6382
- /**
6383
- * @public
6384
- */
6385
- export interface UpdateDashboardPublishedVersionRequest {
6386
- /**
6387
- * <p>The ID of the Amazon Web Services account that contains the dashboard that you're
6388
- * updating.</p>
6389
- */
6390
- AwsAccountId: string | undefined;
6391
- /**
6392
- * <p>The ID for the dashboard.</p>
6393
- */
6394
- DashboardId: string | undefined;
6395
- /**
6396
- * <p>The version number of the dashboard.</p>
6397
- */
6398
- VersionNumber: number | undefined;
6399
- }
6400
- /**
6401
- * @public
6402
- */
6403
- export interface UpdateDashboardPublishedVersionResponse {
6404
- /**
6405
- * <p>The ID for the dashboard.</p>
6406
- */
6407
- DashboardId?: string;
6408
- /**
6409
- * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
6410
- */
6411
- DashboardArn?: string;
6412
- /**
6413
- * <p>The HTTP status of the request.</p>
6414
- */
6415
- Status?: number;
6416
- /**
6417
- * <p>The Amazon Web Services request ID for this operation.</p>
6418
- */
6419
- RequestId?: string;
6420
- }
6421
- /**
6422
- * @public
6423
- */
6424
- export interface UpdateDataSetRequest {
6425
- /**
6426
- * <p>The Amazon Web Services account ID.</p>
6427
- */
6428
- AwsAccountId: string | undefined;
6429
- /**
6430
- * <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each
6431
- * Amazon Web Services account.</p>
6432
- */
6433
- DataSetId: string | undefined;
6434
- /**
6435
- * <p>The display name for the dataset.</p>
6436
- */
6437
- Name: string | undefined;
6438
- /**
6439
- * <p>Declares the physical tables that are available in the underlying data sources.</p>
6440
- */
6441
- PhysicalTableMap: Record<string, PhysicalTable> | undefined;
6442
- /**
6443
- * <p>Configures the combination and transformation of the data from the physical tables.</p>
6444
- */
6445
- LogicalTableMap?: Record<string, LogicalTable>;
6446
- /**
6447
- * <p>Indicates whether you want to import the data into SPICE.</p>
6448
- */
6449
- ImportMode: DataSetImportMode | string | undefined;
6450
- /**
6451
- * <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
6452
- */
6453
- ColumnGroups?: ColumnGroup[];
6454
- /**
6455
- * <p>The folder that contains fields and nested subfolders for your dataset.</p>
6456
- */
6457
- FieldFolders?: Record<string, FieldFolder>;
6458
- /**
6459
- * <p>The row-level security configuration for the data you want to create.</p>
6460
- */
6461
- RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
6462
- /**
6463
- * <p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>
6464
- */
6465
- RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
6466
- /**
6467
- * <p>A set of one or more definitions of a <code>
6468
- * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
6469
- * </code>.</p>
6470
- */
6471
- ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
6472
- /**
6473
- * <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
6474
- */
6475
- DataSetUsageConfiguration?: DataSetUsageConfiguration;
6476
- /**
6477
- * <p>The parameter declarations of the dataset.</p>
6478
- */
6479
- DatasetParameters?: DatasetParameter[];
6480
- }
6481
- /**
6482
- * @public
6483
- */
6484
- export interface UpdateDataSetResponse {
6485
- /**
6486
- * <p>The Amazon Resource Name (ARN) of the dataset.</p>
6487
- */
6488
- Arn?: string;
6489
- /**
6490
- * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
6491
- */
6492
- DataSetId?: string;
6493
- /**
6494
- * <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
6495
- * mode is SPICE.</p>
6496
- */
6497
- IngestionArn?: string;
6498
- /**
6499
- * <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
6500
- * mode is SPICE.</p>
6501
- */
6502
- IngestionId?: string;
6503
- /**
6504
- * <p>The Amazon Web Services request ID for this operation.</p>
6505
- */
6506
- RequestId?: string;
6507
- /**
6508
- * <p>The HTTP status of the request.</p>
6509
- */
6510
- Status?: number;
6511
- }
6512
- /**
6513
- * @public
6514
- */
6515
- export interface UpdateDataSetPermissionsRequest {
6516
- /**
6517
- * <p>The Amazon Web Services account ID.</p>
6518
- */
6519
- AwsAccountId: string | undefined;
6520
- /**
6521
- * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
6522
- * Amazon Web Services Region for each Amazon Web Services account.</p>
6523
- */
6524
- DataSetId: string | undefined;
6525
- /**
6526
- * <p>The resource permissions that you want to grant to the dataset.</p>
6527
- */
6528
- GrantPermissions?: ResourcePermission[];
6529
- /**
6530
- * <p>The resource permissions that you want to revoke from the dataset.</p>
6531
- */
6532
- RevokePermissions?: ResourcePermission[];
6533
- }
6534
- /**
6535
- * @public
6536
- */
6537
- export interface UpdateDataSetPermissionsResponse {
6538
- /**
6539
- * <p>The Amazon Resource Name (ARN) of the dataset.</p>
6540
- */
6541
- DataSetArn?: string;
6542
- /**
6543
- * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
6544
- * Amazon Web Services Region for each Amazon Web Services account.</p>
6545
- */
6546
- DataSetId?: string;
6547
- /**
6548
- * <p>The Amazon Web Services request ID for this operation.</p>
6549
- */
6550
- RequestId?: string;
6551
- /**
6552
- * <p>The HTTP status of the request.</p>
6553
- */
6554
- Status?: number;
6555
- }
6556
- /**
6557
- * @public
6558
- */
6559
- export interface UpdateDataSourceRequest {
6560
- /**
6561
- * <p>The Amazon Web Services account ID.</p>
6562
- */
6563
- AwsAccountId: string | undefined;
6564
- /**
6565
- * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
6566
- */
6567
- DataSourceId: string | undefined;
6568
- /**
6569
- * <p>A display name for the data source.</p>
6570
- */
6571
- Name: string | undefined;
6572
- /**
6573
- * <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
6574
- */
6575
- DataSourceParameters?: DataSourceParameters;
6576
- /**
6577
- * <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
6578
- * only credentials based on user name and password are supported.</p>
6579
- */
6580
- Credentials?: DataSourceCredentials;
6581
- /**
6582
- * <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
6583
- * your underlying source.</p>
6584
- */
6585
- VpcConnectionProperties?: VpcConnectionProperties;
6586
- /**
6587
- * <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
6588
- * source.</p>
6589
- */
6590
- SslProperties?: SslProperties;
6591
- }
6592
- /**
6593
- * @public
6594
- */
6595
- export interface UpdateDataSourceResponse {
6596
- /**
6597
- * <p>The Amazon Resource Name (ARN) of the data source.</p>
6598
- */
6599
- Arn?: string;
6600
- /**
6601
- * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
6602
- */
6603
- DataSourceId?: string;
6604
- /**
6605
- * <p>The update status of the data source's last update.</p>
6606
- */
6607
- UpdateStatus?: ResourceStatus | string;
6608
- /**
6609
- * <p>The Amazon Web Services request ID for this operation.</p>
6610
- */
6611
- RequestId?: string;
6612
- /**
6613
- * <p>The HTTP status of the request.</p>
6614
- */
6615
- Status?: number;
6616
- }
6617
- /**
6618
- * @public
6619
- */
6620
- export interface UpdateDataSourcePermissionsRequest {
6621
- /**
6622
- * <p>The Amazon Web Services account ID.</p>
6623
- */
6624
- AwsAccountId: string | undefined;
6625
- /**
6626
- * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
6627
- */
6628
- DataSourceId: string | undefined;
6629
- /**
6630
- * <p>A list of resource permissions that you want to grant on the data source.</p>
6631
- */
6632
- GrantPermissions?: ResourcePermission[];
6633
- /**
6634
- * <p>A list of resource permissions that you want to revoke on the data source.</p>
6635
- */
6636
- RevokePermissions?: ResourcePermission[];
6637
- }
6638
- /**
6639
- * @public
6640
- */
6641
- export interface UpdateDataSourcePermissionsResponse {
6642
- /**
6643
- * <p>The Amazon Resource Name (ARN) of the data source.</p>
6644
- */
6645
- DataSourceArn?: string;
6646
- /**
6647
- * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
6648
- */
6649
- DataSourceId?: string;
6650
- /**
6651
- * <p>The Amazon Web Services request ID for this operation.</p>
6652
- */
6653
- RequestId?: string;
6654
- /**
6655
- * <p>The HTTP status of the request.</p>
6656
- */
6657
- Status?: number;
6658
- }
6659
- /**
6660
- * @public
6661
- */
6662
- export interface UpdateFolderRequest {
6663
- /**
6664
- * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
6665
- */
6666
- AwsAccountId: string | undefined;
6667
- /**
6668
- * <p>The ID of the folder.</p>
6669
- */
6670
- FolderId: string | undefined;
6671
- /**
6672
- * <p>The name of the folder.</p>
6673
- */
6674
- Name: string | undefined;
6675
- }
6676
- /**
6677
- * @public
6678
- */
6679
- export interface UpdateFolderResponse {
6680
- /**
6681
- * <p>The HTTP status of the request.</p>
6682
- */
6683
- Status?: number;
6684
- /**
6685
- * <p>The Amazon Resource Name (ARN) of the folder.</p>
6686
- */
6687
- Arn?: string;
6688
- /**
6689
- * <p>The ID of the folder.</p>
6690
- */
6691
- FolderId?: string;
6692
- /**
6693
- * <p>The Amazon Web Services request ID for this operation.</p>
6694
- */
6695
- RequestId?: string;
6696
- }
6697
- /**
6698
- * @public
6699
- */
6700
- export interface UpdateFolderPermissionsRequest {
6701
- /**
6702
- * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
6703
- */
6704
- AwsAccountId: string | undefined;
6705
- /**
6706
- * <p>The ID of the folder.</p>
6707
- */
6708
- FolderId: string | undefined;
6709
- /**
6710
- * <p>The permissions that you want to grant on a resource.</p>
6711
- */
6712
- GrantPermissions?: ResourcePermission[];
6713
- /**
6714
- * <p>The permissions that you want to revoke from a resource.</p>
6715
- */
6716
- RevokePermissions?: ResourcePermission[];
6717
- }
6718
- /**
6719
- * @public
6720
- */
6721
- export interface UpdateFolderPermissionsResponse {
6722
- /**
6723
- * <p>The HTTP status of the request.</p>
6724
- */
6725
- Status?: number;
6726
- /**
6727
- * <p>The Amazon Resource Name (ARN) of the folder.</p>
6728
- */
6729
- Arn?: string;
6730
- /**
6731
- * <p>The ID of the folder.</p>
6732
- */
6733
- FolderId?: string;
6734
- /**
6735
- * <p>Information about the permissions for the folder.</p>
6736
- */
6737
- Permissions?: ResourcePermission[];
6738
- /**
6739
- * <p>The Amazon Web Services request ID for this operation.</p>
6740
- */
6741
- RequestId?: string;
6742
- }
6743
- /**
6744
- * @public
6745
- */
6746
- export interface UpdateGroupRequest {
6747
- /**
6748
- * <p>The name of the group that you want to update.</p>
6749
- */
6750
- GroupName: string | undefined;
6751
- /**
6752
- * <p>The description for the group that you want to update.</p>
6753
- */
6754
- Description?: string;
6755
- /**
6756
- * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
6757
- * Amazon Web Services account that contains your Amazon QuickSight account.</p>
6758
- */
6759
- AwsAccountId: string | undefined;
6760
- /**
6761
- * <p>The namespace of the group that you want to update.</p>
6762
- */
6763
- Namespace: string | undefined;
6764
- }
6765
- /**
6766
- * @public
6767
- */
6768
- export interface UpdateGroupResponse {
6769
- /**
6770
- * <p>The name of the group.</p>
6771
- */
6772
- Group?: Group;
6773
- /**
6774
- * <p>The Amazon Web Services request ID for this operation.</p>
6775
- */
6776
- RequestId?: string;
6777
- /**
6778
- * <p>The HTTP status of the request.</p>
6779
- */
6780
- Status?: number;
6781
- }
6782
- /**
6783
- * @public
6784
- */
6785
- export interface UpdateIAMPolicyAssignmentRequest {
6786
- /**
6787
- * <p>The ID of the Amazon Web Services account that contains the IAM policy
6788
- * assignment. </p>
6789
- */
6790
- AwsAccountId: string | undefined;
6791
- /**
6792
- * <p>The name of the assignment, also called a rule.
6793
- * The
6794
- * name must be unique within the
6795
- * Amazon Web Services account.</p>
6796
- */
6797
- AssignmentName: string | undefined;
6798
- /**
6799
- * <p>The namespace of the assignment.</p>
6800
- */
6801
- Namespace: string | undefined;
6802
- /**
6803
- * <p>The status of the assignment. Possible values are as follows:</p>
6804
- * <ul>
6805
- * <li>
6806
- * <p>
6807
- * <code>ENABLED</code> - Anything specified in this assignment is used when
6808
- * creating the data source.</p>
6809
- * </li>
6810
- * <li>
6811
- * <p>
6812
- * <code>DISABLED</code> - This assignment isn't used when creating the data
6813
- * source.</p>
6814
- * </li>
6815
- * <li>
6816
- * <p>
6817
- * <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
6818
- * when creating the data source.</p>
6819
- * </li>
6820
- * </ul>
6821
- */
6822
- AssignmentStatus?: AssignmentStatus | string;
6823
- /**
6824
- * <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and
6825
- * groups specified in this assignment.</p>
6826
- */
6827
- PolicyArn?: string;
6828
- /**
6829
- * <p>The Amazon QuickSight users, groups, or both that you want to assign the policy
6830
- * to.</p>
6831
- */
6832
- Identities?: Record<string, string[]>;
6833
- }
6834
- /**
6835
- * @public
6836
- */
6837
- export interface UpdateIAMPolicyAssignmentResponse {
6838
- /**
6839
- * <p>The name of the assignment or rule.</p>
6840
- */
6841
- AssignmentName?: string;
6842
- /**
6843
- * <p>The ID of the assignment.</p>
6844
- */
6845
- AssignmentId?: string;
6846
- /**
6847
- * <p>The ARN for the IAM policy applied to the Amazon QuickSight users and
6848
- * groups specified in this assignment.</p>
6849
- */
6850
- PolicyArn?: string;
6851
- /**
6852
- * <p>The Amazon QuickSight users, groups, or both that the IAM policy is
6853
- * assigned to.</p>
6854
- */
6855
- Identities?: Record<string, string[]>;
6856
- /**
6857
- * <p>The status of the assignment. Possible values are as follows:</p>
6858
- * <ul>
6859
- * <li>
6860
- * <p>
6861
- * <code>ENABLED</code> - Anything specified in this assignment is used when
6862
- * creating the data source.</p>
6863
- * </li>
6864
- * <li>
6865
- * <p>
6866
- * <code>DISABLED</code> - This assignment isn't used when creating the data
6867
- * source.</p>
6868
- * </li>
6869
- * <li>
6870
- * <p>
6871
- * <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
6872
- * when creating the data source.</p>
6873
- * </li>
6874
- * </ul>
6875
- */
6876
- AssignmentStatus?: AssignmentStatus | string;
6877
- /**
6878
- * <p>The Amazon Web Services request ID for this operation.</p>
6879
- */
6880
- RequestId?: string;
6881
- /**
6882
- * <p>The HTTP status of the request.</p>
6883
- */
6884
- Status?: number;
6885
- }
6886
- /**
6887
- * @public
6888
- */
6889
- export interface UpdateIpRestrictionRequest {
6890
- /**
6891
- * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
6892
- */
6893
- AwsAccountId: string | undefined;
6894
- /**
6895
- * <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
6896
- */
6897
- IpRestrictionRuleMap?: Record<string, string>;
6898
- /**
6899
- * <p>A value that specifies whether IP rules are turned on.</p>
6900
- */
6901
- Enabled?: boolean;
6902
- }
6903
- /**
6904
- * @public
6905
- */
6906
- export interface UpdateIpRestrictionResponse {
6907
- /**
6908
- * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
6909
- */
6910
- AwsAccountId?: string;
6911
- /**
6912
- * <p>The Amazon Web Services request ID for this operation.</p>
6913
- */
6914
- RequestId?: string;
6915
- /**
6916
- * <p>The HTTP status of the request. </p>
6917
- */
6918
- Status?: number;
6919
- }
6920
- /**
6921
- * @public
6922
- */
6923
- export interface UpdatePublicSharingSettingsRequest {
6924
- /**
6925
- * <p>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</p>
6926
- */
6927
- AwsAccountId: string | undefined;
6928
- /**
6929
- * <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</p>
6930
- */
6931
- PublicSharingEnabled?: boolean;
6932
- }
6933
- /**
6934
- * @public
6935
- */
6936
- export interface UpdatePublicSharingSettingsResponse {
6937
- /**
6938
- * <p>The Amazon Web Services request ID for this operation.</p>
6939
- */
6940
- RequestId?: string;
6941
- /**
6942
- * <p>The HTTP status of the request.</p>
6943
- */
6944
- Status?: number;
6945
- }
6946
- /**
6947
- * @public
6948
- */
6949
- export interface UpdateRefreshScheduleRequest {
6950
- /**
6951
- * <p>The ID of the dataset.</p>
6952
- */
6953
- DataSetId: string | undefined;
6954
- /**
6955
- * <p>The Amazon Web Services account ID.</p>
6956
- */
6957
- AwsAccountId: string | undefined;
6958
- /**
6959
- * <p>The refresh schedule.</p>
6960
- */
6961
- Schedule: RefreshSchedule | undefined;
6962
- }
6963
- /**
6964
- * @public
6965
- */
6966
- export interface UpdateRefreshScheduleResponse {
6967
- /**
6968
- * <p>The HTTP status of the request.</p>
6969
- */
6970
- Status?: number;
6971
- /**
6972
- * <p>The Amazon Web Services request ID for this operation.</p>
6973
- */
6974
- RequestId?: string;
6975
- /**
6976
- * <p>The ID of the refresh schedule.</p>
6977
- */
6978
- ScheduleId?: string;
6979
- /**
6980
- * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
6981
- */
6982
- Arn?: string;
6983
- }
6984
- /**
6985
- * @public
6865
+ * @internal
6986
6866
  */
6987
- export interface UpdateTemplateRequest {
6988
- /**
6989
- * <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
6990
- */
6991
- AwsAccountId: string | undefined;
6992
- /**
6993
- * <p>The ID for the template.</p>
6994
- */
6995
- TemplateId: string | undefined;
6996
- /**
6997
- * <p>The entity that you are using as a source when you update the template. In
6998
- * <code>SourceEntity</code>, you specify the type of object you're using as source:
6999
- * <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an
7000
- * analysis. Both of these require an Amazon Resource Name (ARN). For
7001
- * <code>SourceTemplate</code>, specify the ARN of the source template. For
7002
- * <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
7003
- * ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
7004
- * <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
7005
- * <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
7006
- * in the original. The schema in each dataset must match its placeholder. </p>
7007
- */
7008
- SourceEntity?: TemplateSourceEntity;
7009
- /**
7010
- * <p>A description of the current template version that is being updated. Every time you call
7011
- * <code>UpdateTemplate</code>, you create a new version of the template. Each version
7012
- * of the template maintains a description of the version in the
7013
- * <code>VersionDescription</code> field.</p>
7014
- */
7015
- VersionDescription?: string;
7016
- /**
7017
- * <p>The name for the template.</p>
7018
- */
7019
- Name?: string;
7020
- /**
7021
- * <p>The definition of a template.</p>
7022
- * <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
7023
- */
7024
- Definition?: TemplateVersionDefinition;
7025
- }
6867
+ export declare const DescribeAssetBundleImportJobResponseFilterSensitiveLog: (obj: DescribeAssetBundleImportJobResponse) => any;
7026
6868
  /**
7027
- * @public
6869
+ * @internal
7028
6870
  */
7029
- export interface UpdateTemplateResponse {
7030
- /**
7031
- * <p>The ID for the template.</p>
7032
- */
7033
- TemplateId?: string;
7034
- /**
7035
- * <p>The Amazon Resource Name (ARN) for the template.</p>
7036
- */
7037
- Arn?: string;
7038
- /**
7039
- * <p>The ARN for the template, including the version information of the first version.</p>
7040
- */
7041
- VersionArn?: string;
7042
- /**
7043
- * <p>The creation status of the template.</p>
7044
- */
7045
- CreationStatus?: ResourceStatus | string;
7046
- /**
7047
- * <p>The HTTP status of the request.</p>
7048
- */
7049
- Status?: number;
7050
- /**
7051
- * <p>The Amazon Web Services request ID for this operation.</p>
7052
- */
7053
- RequestId?: string;
7054
- }
6871
+ export declare const DescribeDashboardDefinitionResponseFilterSensitiveLog: (obj: DescribeDashboardDefinitionResponse) => any;
7055
6872
  /**
7056
- * @public
6873
+ * @internal
7057
6874
  */
7058
- export interface UpdateTemplateAliasRequest {
7059
- /**
7060
- * <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
7061
- */
7062
- AwsAccountId: string | undefined;
7063
- /**
7064
- * <p>The ID for the template.</p>
7065
- */
7066
- TemplateId: string | undefined;
7067
- /**
7068
- * <p>The alias of the template that you want to update. If you name a specific alias, you update
7069
- * the version that the alias points to. You can specify the latest version of the template
7070
- * by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter.
7071
- * The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
7072
- */
7073
- AliasName: string | undefined;
7074
- /**
7075
- * <p>The version number of the template.</p>
7076
- */
7077
- TemplateVersionNumber: number | undefined;
7078
- }
6875
+ export declare const SnapshotConfigurationFilterSensitiveLog: (obj: SnapshotConfiguration) => any;
7079
6876
  /**
7080
6877
  * @internal
7081
6878
  */
7082
- export declare const DescribeAnalysisDefinitionResponseFilterSensitiveLog: (obj: DescribeAnalysisDefinitionResponse) => any;
6879
+ export declare const DescribeDashboardSnapshotJobResponseFilterSensitiveLog: (obj: DescribeDashboardSnapshotJobResponse) => any;
7083
6880
  /**
7084
6881
  * @internal
7085
6882
  */
7086
- export declare const DescribeAssetBundleImportJobResponseFilterSensitiveLog: (obj: DescribeAssetBundleImportJobResponse) => any;
6883
+ export declare const SnapshotJobResultFilterSensitiveLog: (obj: SnapshotJobResult) => any;
7087
6884
  /**
7088
6885
  * @internal
7089
6886
  */
7090
- export declare const DescribeDashboardDefinitionResponseFilterSensitiveLog: (obj: DescribeDashboardDefinitionResponse) => any;
6887
+ export declare const DescribeDashboardSnapshotJobResultResponseFilterSensitiveLog: (obj: DescribeDashboardSnapshotJobResultResponse) => any;
7091
6888
  /**
7092
6889
  * @internal
7093
6890
  */
@@ -7131,20 +6928,20 @@ export declare const StartAssetBundleImportJobRequestFilterSensitiveLog: (obj: S
7131
6928
  /**
7132
6929
  * @internal
7133
6930
  */
7134
- export declare const UpdateAnalysisRequestFilterSensitiveLog: (obj: UpdateAnalysisRequest) => any;
6931
+ export declare const SnapshotAnonymousUserFilterSensitiveLog: (obj: SnapshotAnonymousUser) => any;
7135
6932
  /**
7136
6933
  * @internal
7137
6934
  */
7138
- export declare const UpdateDashboardRequestFilterSensitiveLog: (obj: UpdateDashboardRequest) => any;
6935
+ export declare const SnapshotUserConfigurationFilterSensitiveLog: (obj: SnapshotUserConfiguration) => any;
7139
6936
  /**
7140
6937
  * @internal
7141
6938
  */
7142
- export declare const UpdateDataSetRequestFilterSensitiveLog: (obj: UpdateDataSetRequest) => any;
6939
+ export declare const StartDashboardSnapshotJobRequestFilterSensitiveLog: (obj: StartDashboardSnapshotJobRequest) => any;
7143
6940
  /**
7144
6941
  * @internal
7145
6942
  */
7146
- export declare const UpdateDataSourceRequestFilterSensitiveLog: (obj: UpdateDataSourceRequest) => any;
6943
+ export declare const UpdateAnalysisRequestFilterSensitiveLog: (obj: UpdateAnalysisRequest) => any;
7147
6944
  /**
7148
6945
  * @internal
7149
6946
  */
7150
- export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTemplateRequest) => any;
6947
+ export declare const UpdateDashboardRequestFilterSensitiveLog: (obj: UpdateDashboardRequest) => any;