@aws-sdk/client-quicksight 3.450.0 → 3.453.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.
- package/README.md +48 -0
- package/dist-cjs/QuickSight.js +12 -0
- package/dist-cjs/commands/CreateRoleMembershipCommand.js +51 -0
- package/dist-cjs/commands/CreateTopicCommand.js +2 -2
- package/dist-cjs/commands/DeleteRoleCustomPermissionCommand.js +51 -0
- package/dist-cjs/commands/DeleteRoleMembershipCommand.js +51 -0
- package/dist-cjs/commands/DescribeAssetBundleExportJobCommand.js +2 -1
- package/dist-cjs/commands/DescribeRoleCustomPermissionCommand.js +51 -0
- package/dist-cjs/commands/ListRoleMembershipsCommand.js +51 -0
- package/dist-cjs/commands/UpdateRoleCustomPermissionCommand.js +51 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/models/models_0.js +10 -10
- package/dist-cjs/models/models_2.js +17 -104
- package/dist-cjs/models/models_3.js +112 -1
- package/dist-cjs/pagination/ListRoleMembershipsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +488 -10
- package/dist-es/QuickSight.js +12 -0
- package/dist-es/commands/CreateRoleMembershipCommand.js +47 -0
- package/dist-es/commands/CreateTopicCommand.js +1 -1
- package/dist-es/commands/DeleteRoleCustomPermissionCommand.js +47 -0
- package/dist-es/commands/DeleteRoleMembershipCommand.js +47 -0
- package/dist-es/commands/DescribeAssetBundleExportJobCommand.js +2 -1
- package/dist-es/commands/DescribeRoleCustomPermissionCommand.js +47 -0
- package/dist-es/commands/ListRoleMembershipsCommand.js +47 -0
- package/dist-es/commands/UpdateRoleCustomPermissionCommand.js +47 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +9 -9
- package/dist-es/models/models_2.js +14 -94
- package/dist-es/models/models_3.js +102 -1
- package/dist-es/pagination/ListRoleMembershipsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +469 -3
- package/dist-types/QuickSight.d.ts +42 -0
- package/dist-types/QuickSightClient.d.ts +8 -2
- package/dist-types/commands/CreateDashboardCommand.d.ts +10 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +9 -1
- package/dist-types/commands/CreateRoleMembershipCommand.d.ts +101 -0
- package/dist-types/commands/CreateTopicCommand.d.ts +1 -1
- package/dist-types/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +1 -2
- package/dist-types/commands/DeleteRoleCustomPermissionCommand.d.ts +100 -0
- package/dist-types/commands/DeleteRoleMembershipCommand.d.ts +101 -0
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +0 -4
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +18 -7
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +150 -0
- package/dist-types/commands/DescribeDashboardCommand.d.ts +0 -4
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +9 -1
- package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +101 -0
- package/dist-types/commands/DescribeTemplateCommand.d.ts +0 -4
- package/dist-types/commands/ListAssetBundleExportJobsCommand.d.ts +2 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +9 -1
- package/dist-types/commands/ListRoleMembershipsCommand.d.ts +112 -0
- package/dist-types/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListThemesCommand.d.ts +1 -1
- package/dist-types/commands/ListTopicRefreshSchedulesCommand.d.ts +1 -1
- package/dist-types/commands/ListTopicsCommand.d.ts +1 -1
- package/dist-types/commands/ListUserGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/ListVPCConnectionsCommand.d.ts +1 -1
- package/dist-types/commands/PutDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +1 -1
- package/dist-types/commands/RestoreAnalysisCommand.d.ts +1 -1
- package/dist-types/commands/SearchAnalysesCommand.d.ts +1 -1
- package/dist-types/commands/SearchDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/SearchDataSetsCommand.d.ts +1 -2
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +12 -7
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +150 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +8 -0
- package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +101 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +33 -38
- package/dist-types/models/models_2.d.ts +573 -773
- package/dist-types/models/models_3.d.ts +3973 -4050
- package/dist-types/models/models_4.d.ts +1012 -4
- package/dist-types/pagination/ListRoleMembershipsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
- package/dist-types/ts3.4/QuickSight.d.ts +102 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateRoleMembershipCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateVPCConnectionCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteRoleCustomPermissionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteRoleMembershipCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeRoleCustomPermissionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRoleMembershipsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThemesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTopicRefreshSchedulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTopicsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUserGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListVPCConnectionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RestoreAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchAnalysesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchDashboardsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchDataSetsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateRoleCustomPermissionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +14 -15
- package/dist-types/ts3.4/models/models_2.d.ts +177 -206
- package/dist-types/ts3.4/models/models_3.d.ts +264 -201
- package/dist-types/ts3.4/models/models_4.d.ts +229 -4
- package/dist-types/ts3.4/pagination/ListRoleMembershipsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +35 -35
|
@@ -1,7 +1,944 @@
|
|
|
1
1
|
import { AccountCustomization, ResourceStatus } from "./models_0";
|
|
2
|
-
import { AnalysisDefinition, AnalysisSourceEntity } from "./models_1";
|
|
3
|
-
import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportSource, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration,
|
|
4
|
-
import { DataSetSummary, DataSourceSearchFilter, DataSourceSummary, FolderSearchFilter, FolderSummary, GroupSearchFilter,
|
|
2
|
+
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary } from "./models_1";
|
|
3
|
+
import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ValidationStrategy, VpcConnectionProperties } from "./models_2";
|
|
4
|
+
import { DashboardSearchFilter, DashboardSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSourceSearchFilter, DataSourceSummary, FolderSearchFilter, FolderSummary, GroupSearchFilter, IdentityType, NetworkInterface, SessionTag, SnapshotConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ListThemesRequest {
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
12
|
+
*/
|
|
13
|
+
AwsAccountId: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
17
|
+
*/
|
|
18
|
+
NextToken?: string;
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
22
|
+
*/
|
|
23
|
+
MaxResults?: number;
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>The type of themes that you want to list. Valid options include the following:</p>
|
|
27
|
+
* <ul>
|
|
28
|
+
* <li>
|
|
29
|
+
* <p>
|
|
30
|
+
* <code>ALL (default)</code>- Display all existing themes.</p>
|
|
31
|
+
* </li>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>CUSTOM</code> - Display only the themes created by people using Amazon QuickSight.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>QUICKSIGHT</code> - Display only the starting themes defined by Amazon QuickSight.</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* </ul>
|
|
41
|
+
*/
|
|
42
|
+
Type?: ThemeType;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* @public
|
|
46
|
+
* <p>The theme summary.</p>
|
|
47
|
+
*/
|
|
48
|
+
export interface ThemeSummary {
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
52
|
+
*/
|
|
53
|
+
Arn?: string;
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
* <p>the display name for the theme.</p>
|
|
57
|
+
*/
|
|
58
|
+
Name?: string;
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
62
|
+
*/
|
|
63
|
+
ThemeId?: string;
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
* <p>The latest version number for the theme. </p>
|
|
67
|
+
*/
|
|
68
|
+
LatestVersionNumber?: number;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
* <p>The date and time that this theme was created.</p>
|
|
72
|
+
*/
|
|
73
|
+
CreatedTime?: Date;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* <p>The last date and time that this theme was updated.</p>
|
|
77
|
+
*/
|
|
78
|
+
LastUpdatedTime?: Date;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export interface ListThemesResponse {
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
* <p>Information about the themes in the list.</p>
|
|
87
|
+
*/
|
|
88
|
+
ThemeSummaryList?: ThemeSummary[];
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
92
|
+
*/
|
|
93
|
+
NextToken?: string;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
* <p>The HTTP status of the request.</p>
|
|
97
|
+
*/
|
|
98
|
+
Status?: number;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
102
|
+
*/
|
|
103
|
+
RequestId?: string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export interface ListThemeVersionsRequest {
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
112
|
+
*/
|
|
113
|
+
AwsAccountId: string | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
* <p>The ID for the theme.</p>
|
|
117
|
+
*/
|
|
118
|
+
ThemeId: string | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
122
|
+
*/
|
|
123
|
+
NextToken?: string;
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
127
|
+
*/
|
|
128
|
+
MaxResults?: number;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* @public
|
|
132
|
+
* <p>The theme version.</p>
|
|
133
|
+
*/
|
|
134
|
+
export interface ThemeVersionSummary {
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
* <p>The version number of the theme version.</p>
|
|
138
|
+
*/
|
|
139
|
+
VersionNumber?: number;
|
|
140
|
+
/**
|
|
141
|
+
* @public
|
|
142
|
+
* <p>The Amazon Resource Name (ARN) of the theme version.</p>
|
|
143
|
+
*/
|
|
144
|
+
Arn?: string;
|
|
145
|
+
/**
|
|
146
|
+
* @public
|
|
147
|
+
* <p>The description of the theme version.</p>
|
|
148
|
+
*/
|
|
149
|
+
Description?: string;
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* <p>The date and time that this theme version was created.</p>
|
|
153
|
+
*/
|
|
154
|
+
CreatedTime?: Date;
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
* <p>The status of the theme version.</p>
|
|
158
|
+
*/
|
|
159
|
+
Status?: ResourceStatus;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export interface ListThemeVersionsResponse {
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
* <p>A structure containing a list of all the versions of the specified theme.</p>
|
|
168
|
+
*/
|
|
169
|
+
ThemeVersionSummaryList?: ThemeVersionSummary[];
|
|
170
|
+
/**
|
|
171
|
+
* @public
|
|
172
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
173
|
+
*/
|
|
174
|
+
NextToken?: string;
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
* <p>The HTTP status of the request.</p>
|
|
178
|
+
*/
|
|
179
|
+
Status?: number;
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
183
|
+
*/
|
|
184
|
+
RequestId?: string;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
export interface ListTopicRefreshSchedulesRequest {
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
* <p>The ID of the Amazon Web Services account that contains the topic whose refresh schedule
|
|
193
|
+
* you want described.</p>
|
|
194
|
+
*/
|
|
195
|
+
AwsAccountId: string | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
* <p>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
199
|
+
*/
|
|
200
|
+
TopicId: string | undefined;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* @public
|
|
204
|
+
* <p>A summary of the refresh schedule details for a dataset.</p>
|
|
205
|
+
*/
|
|
206
|
+
export interface TopicRefreshScheduleSummary {
|
|
207
|
+
/**
|
|
208
|
+
* @public
|
|
209
|
+
* <p>The ID of the dataset.</p>
|
|
210
|
+
*/
|
|
211
|
+
DatasetId?: string;
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
215
|
+
*/
|
|
216
|
+
DatasetArn?: string;
|
|
217
|
+
/**
|
|
218
|
+
* @public
|
|
219
|
+
* <p>The name of the dataset.</p>
|
|
220
|
+
*/
|
|
221
|
+
DatasetName?: string;
|
|
222
|
+
/**
|
|
223
|
+
* @public
|
|
224
|
+
* <p>The definition of a refresh schedule.</p>
|
|
225
|
+
*/
|
|
226
|
+
RefreshSchedule?: TopicRefreshSchedule;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
export interface ListTopicRefreshSchedulesResponse {
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
* <p>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
235
|
+
*/
|
|
236
|
+
TopicId?: string;
|
|
237
|
+
/**
|
|
238
|
+
* @public
|
|
239
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
240
|
+
*/
|
|
241
|
+
TopicArn?: string;
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
* <p>The list of topic refresh schedules.</p>
|
|
245
|
+
*/
|
|
246
|
+
RefreshSchedules?: TopicRefreshScheduleSummary[];
|
|
247
|
+
/**
|
|
248
|
+
* @public
|
|
249
|
+
* <p>The HTTP status of the request.</p>
|
|
250
|
+
*/
|
|
251
|
+
Status?: number;
|
|
252
|
+
/**
|
|
253
|
+
* @public
|
|
254
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
255
|
+
*/
|
|
256
|
+
RequestId?: string;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
export interface ListTopicsRequest {
|
|
262
|
+
/**
|
|
263
|
+
* @public
|
|
264
|
+
* <p>The ID of the Amazon Web Services account that contains the topics that you want to
|
|
265
|
+
* list.</p>
|
|
266
|
+
*/
|
|
267
|
+
AwsAccountId: string | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* @public
|
|
270
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
271
|
+
*/
|
|
272
|
+
NextToken?: string;
|
|
273
|
+
/**
|
|
274
|
+
* @public
|
|
275
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
276
|
+
*/
|
|
277
|
+
MaxResults?: number;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* @public
|
|
281
|
+
* <p>A topic summary.</p>
|
|
282
|
+
*/
|
|
283
|
+
export interface TopicSummary {
|
|
284
|
+
/**
|
|
285
|
+
* @public
|
|
286
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
287
|
+
*/
|
|
288
|
+
Arn?: string;
|
|
289
|
+
/**
|
|
290
|
+
* @public
|
|
291
|
+
* <p>The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
292
|
+
*/
|
|
293
|
+
TopicId?: string;
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
* <p>The name of the topic.</p>
|
|
297
|
+
*/
|
|
298
|
+
Name?: string;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
export interface ListTopicsResponse {
|
|
304
|
+
/**
|
|
305
|
+
* @public
|
|
306
|
+
* <p>A list of topic summaries.</p>
|
|
307
|
+
*/
|
|
308
|
+
TopicsSummaries?: TopicSummary[];
|
|
309
|
+
/**
|
|
310
|
+
* @public
|
|
311
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
312
|
+
*/
|
|
313
|
+
NextToken?: string;
|
|
314
|
+
/**
|
|
315
|
+
* @public
|
|
316
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
317
|
+
*/
|
|
318
|
+
RequestId?: string;
|
|
319
|
+
/**
|
|
320
|
+
* @public
|
|
321
|
+
* <p>The HTTP status of the request.</p>
|
|
322
|
+
*/
|
|
323
|
+
Status?: number;
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
export interface ListUserGroupsRequest {
|
|
329
|
+
/**
|
|
330
|
+
* @public
|
|
331
|
+
* <p>The Amazon QuickSight user name that you want to list group memberships for.</p>
|
|
332
|
+
*/
|
|
333
|
+
UserName: string | undefined;
|
|
334
|
+
/**
|
|
335
|
+
* @public
|
|
336
|
+
* <p>The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account
|
|
337
|
+
* that contains your Amazon QuickSight account.</p>
|
|
338
|
+
*/
|
|
339
|
+
AwsAccountId: string | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* @public
|
|
342
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
343
|
+
*/
|
|
344
|
+
Namespace: string | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* @public
|
|
347
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
348
|
+
*/
|
|
349
|
+
NextToken?: string;
|
|
350
|
+
/**
|
|
351
|
+
* @public
|
|
352
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
353
|
+
*/
|
|
354
|
+
MaxResults?: number;
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
export interface ListUserGroupsResponse {
|
|
360
|
+
/**
|
|
361
|
+
* @public
|
|
362
|
+
* <p>The list of groups the user is a member of.</p>
|
|
363
|
+
*/
|
|
364
|
+
GroupList?: Group[];
|
|
365
|
+
/**
|
|
366
|
+
* @public
|
|
367
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
368
|
+
*/
|
|
369
|
+
NextToken?: string;
|
|
370
|
+
/**
|
|
371
|
+
* @public
|
|
372
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
373
|
+
*/
|
|
374
|
+
RequestId?: string;
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
* <p>The HTTP status of the request.</p>
|
|
378
|
+
*/
|
|
379
|
+
Status?: number;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
export interface ListUsersRequest {
|
|
385
|
+
/**
|
|
386
|
+
* @public
|
|
387
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
388
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
389
|
+
*/
|
|
390
|
+
AwsAccountId: string | undefined;
|
|
391
|
+
/**
|
|
392
|
+
* @public
|
|
393
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
394
|
+
*/
|
|
395
|
+
NextToken?: string;
|
|
396
|
+
/**
|
|
397
|
+
* @public
|
|
398
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
399
|
+
*/
|
|
400
|
+
MaxResults?: number;
|
|
401
|
+
/**
|
|
402
|
+
* @public
|
|
403
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
404
|
+
*/
|
|
405
|
+
Namespace: string | undefined;
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
export interface ListUsersResponse {
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
* <p>The list of users.</p>
|
|
414
|
+
*/
|
|
415
|
+
UserList?: User[];
|
|
416
|
+
/**
|
|
417
|
+
* @public
|
|
418
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
419
|
+
*/
|
|
420
|
+
NextToken?: string;
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
424
|
+
*/
|
|
425
|
+
RequestId?: string;
|
|
426
|
+
/**
|
|
427
|
+
* @public
|
|
428
|
+
* <p>The HTTP status of the request.</p>
|
|
429
|
+
*/
|
|
430
|
+
Status?: number;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
export interface ListVPCConnectionsRequest {
|
|
436
|
+
/**
|
|
437
|
+
* @public
|
|
438
|
+
* <p>The Amazon Web Services account ID of the account that contains the VPC connections
|
|
439
|
+
* that you want to list.</p>
|
|
440
|
+
*/
|
|
441
|
+
AwsAccountId: string | undefined;
|
|
442
|
+
/**
|
|
443
|
+
* @public
|
|
444
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
445
|
+
*/
|
|
446
|
+
NextToken?: string;
|
|
447
|
+
/**
|
|
448
|
+
* @public
|
|
449
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
450
|
+
*/
|
|
451
|
+
MaxResults?: number;
|
|
452
|
+
}
|
|
453
|
+
/**
|
|
454
|
+
* @public
|
|
455
|
+
* <p>The summary metadata that describes a VPC connection.</p>
|
|
456
|
+
*/
|
|
457
|
+
export interface VPCConnectionSummary {
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
* <p>The ID of the VPC connection that
|
|
461
|
+
* you're
|
|
462
|
+
* creating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
463
|
+
* Amazon Web Services account.</p>
|
|
464
|
+
*/
|
|
465
|
+
VPCConnectionId?: string;
|
|
466
|
+
/**
|
|
467
|
+
* @public
|
|
468
|
+
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
469
|
+
*/
|
|
470
|
+
Arn?: string;
|
|
471
|
+
/**
|
|
472
|
+
* @public
|
|
473
|
+
* <p>The display name for the VPC connection.</p>
|
|
474
|
+
*/
|
|
475
|
+
Name?: string;
|
|
476
|
+
/**
|
|
477
|
+
* @public
|
|
478
|
+
* <p>The Amazon EC2 VPC ID associated with the VPC connection.</p>
|
|
479
|
+
*/
|
|
480
|
+
VPCId?: string;
|
|
481
|
+
/**
|
|
482
|
+
* @public
|
|
483
|
+
* <p>The Amazon EC2 security group IDs associated with the VPC connection.</p>
|
|
484
|
+
*/
|
|
485
|
+
SecurityGroupIds?: string[];
|
|
486
|
+
/**
|
|
487
|
+
* @public
|
|
488
|
+
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
489
|
+
*/
|
|
490
|
+
DnsResolvers?: string[];
|
|
491
|
+
/**
|
|
492
|
+
* @public
|
|
493
|
+
* <p>The status of the VPC connection.</p>
|
|
494
|
+
*/
|
|
495
|
+
Status?: VPCConnectionResourceStatus;
|
|
496
|
+
/**
|
|
497
|
+
* @public
|
|
498
|
+
* <p>The availability status of the VPC connection.</p>
|
|
499
|
+
*/
|
|
500
|
+
AvailabilityStatus?: VPCConnectionAvailabilityStatus;
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
* <p>A list of network interfaces.</p>
|
|
504
|
+
*/
|
|
505
|
+
NetworkInterfaces?: NetworkInterface[];
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
* <p>The ARN of the IAM role associated
|
|
509
|
+
* with the VPC connection.</p>
|
|
510
|
+
*/
|
|
511
|
+
RoleArn?: string;
|
|
512
|
+
/**
|
|
513
|
+
* @public
|
|
514
|
+
* <p>The time that the VPC connection was created.</p>
|
|
515
|
+
*/
|
|
516
|
+
CreatedTime?: Date;
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
* <p>The time that the VPC connection was last updated.</p>
|
|
520
|
+
*/
|
|
521
|
+
LastUpdatedTime?: Date;
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
export interface ListVPCConnectionsResponse {
|
|
527
|
+
/**
|
|
528
|
+
* @public
|
|
529
|
+
* <p>A <code>VPCConnectionSummaries</code> object that returns a summary of VPC connection
|
|
530
|
+
* objects.</p>
|
|
531
|
+
*/
|
|
532
|
+
VPCConnectionSummaries?: VPCConnectionSummary[];
|
|
533
|
+
/**
|
|
534
|
+
* @public
|
|
535
|
+
* <p>The token for the next set of results, or null if there are no more
|
|
536
|
+
* results.</p>
|
|
537
|
+
*/
|
|
538
|
+
NextToken?: string;
|
|
539
|
+
/**
|
|
540
|
+
* @public
|
|
541
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
542
|
+
*/
|
|
543
|
+
RequestId?: string;
|
|
544
|
+
/**
|
|
545
|
+
* @public
|
|
546
|
+
* <p>The HTTP status of the request.</p>
|
|
547
|
+
*/
|
|
548
|
+
Status?: number;
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
export interface PutDataSetRefreshPropertiesRequest {
|
|
554
|
+
/**
|
|
555
|
+
* @public
|
|
556
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
557
|
+
*/
|
|
558
|
+
AwsAccountId: string | undefined;
|
|
559
|
+
/**
|
|
560
|
+
* @public
|
|
561
|
+
* <p>The ID of the dataset.</p>
|
|
562
|
+
*/
|
|
563
|
+
DataSetId: string | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
* <p>The dataset refresh properties.</p>
|
|
567
|
+
*/
|
|
568
|
+
DataSetRefreshProperties: DataSetRefreshProperties | undefined;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
export interface PutDataSetRefreshPropertiesResponse {
|
|
574
|
+
/**
|
|
575
|
+
* @public
|
|
576
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
577
|
+
*/
|
|
578
|
+
RequestId?: string;
|
|
579
|
+
/**
|
|
580
|
+
* @public
|
|
581
|
+
* <p>The HTTP status of the request.</p>
|
|
582
|
+
*/
|
|
583
|
+
Status?: number;
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* @public
|
|
587
|
+
*/
|
|
588
|
+
export interface RegisterUserRequest {
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
* <p>Amazon QuickSight supports several ways of managing the identity of users. This
|
|
592
|
+
* parameter accepts two values:</p>
|
|
593
|
+
* <ul>
|
|
594
|
+
* <li>
|
|
595
|
+
* <p>
|
|
596
|
+
* <code>IAM</code>: A user whose identity maps to an existing IAM user or role.
|
|
597
|
+
* </p>
|
|
598
|
+
* </li>
|
|
599
|
+
* <li>
|
|
600
|
+
* <p>
|
|
601
|
+
* <code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by
|
|
602
|
+
* Amazon QuickSight. </p>
|
|
603
|
+
* </li>
|
|
604
|
+
* </ul>
|
|
605
|
+
*/
|
|
606
|
+
IdentityType: IdentityType | undefined;
|
|
607
|
+
/**
|
|
608
|
+
* @public
|
|
609
|
+
* <p>The email address of the user that you want to register.</p>
|
|
610
|
+
*/
|
|
611
|
+
Email: string | undefined;
|
|
612
|
+
/**
|
|
613
|
+
* @public
|
|
614
|
+
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
615
|
+
* following:</p>
|
|
616
|
+
* <ul>
|
|
617
|
+
* <li>
|
|
618
|
+
* <p>
|
|
619
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
620
|
+
* </li>
|
|
621
|
+
* <li>
|
|
622
|
+
* <p>
|
|
623
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
|
|
624
|
+
* dashboards.</p>
|
|
625
|
+
* </li>
|
|
626
|
+
* <li>
|
|
627
|
+
* <p>
|
|
628
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight
|
|
629
|
+
* settings.</p>
|
|
630
|
+
* </li>
|
|
631
|
+
* <li>
|
|
632
|
+
* <p>
|
|
633
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
634
|
+
* use.</p>
|
|
635
|
+
* </li>
|
|
636
|
+
* <li>
|
|
637
|
+
* <p>
|
|
638
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
639
|
+
* use.</p>
|
|
640
|
+
* </li>
|
|
641
|
+
* </ul>
|
|
642
|
+
*/
|
|
643
|
+
UserRole: UserRole | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* @public
|
|
646
|
+
* <p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>
|
|
647
|
+
*/
|
|
648
|
+
IamArn?: string;
|
|
649
|
+
/**
|
|
650
|
+
* @public
|
|
651
|
+
* <p>You need to use this parameter only when you register one or more users using an assumed
|
|
652
|
+
* IAM role. You don't need to provide the session name for other scenarios, for example when
|
|
653
|
+
* you are registering an IAM user or an Amazon QuickSight user. You can register multiple
|
|
654
|
+
* users using the same IAM role if each user has a different session name. For more
|
|
655
|
+
* information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
|
|
656
|
+
* <code>assume-role</code>
|
|
657
|
+
* </a> in the <i>CLI Reference.</i>
|
|
658
|
+
* </p>
|
|
659
|
+
*/
|
|
660
|
+
SessionName?: string;
|
|
661
|
+
/**
|
|
662
|
+
* @public
|
|
663
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
664
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
665
|
+
*/
|
|
666
|
+
AwsAccountId: string | undefined;
|
|
667
|
+
/**
|
|
668
|
+
* @public
|
|
669
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
670
|
+
*/
|
|
671
|
+
Namespace: string | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* @public
|
|
674
|
+
* <p>The Amazon QuickSight user name that you want to create for the user you are
|
|
675
|
+
* registering.</p>
|
|
676
|
+
*/
|
|
677
|
+
UserName?: string;
|
|
678
|
+
/**
|
|
679
|
+
* @public
|
|
680
|
+
* <p>(Enterprise edition only) The name of the custom permissions profile that you want to
|
|
681
|
+
* assign to this user. Customized permissions allows you to control a user's access by
|
|
682
|
+
* restricting access the following operations:</p>
|
|
683
|
+
* <ul>
|
|
684
|
+
* <li>
|
|
685
|
+
* <p>Create and update data sources</p>
|
|
686
|
+
* </li>
|
|
687
|
+
* <li>
|
|
688
|
+
* <p>Create and update datasets</p>
|
|
689
|
+
* </li>
|
|
690
|
+
* <li>
|
|
691
|
+
* <p>Create and update email reports</p>
|
|
692
|
+
* </li>
|
|
693
|
+
* <li>
|
|
694
|
+
* <p>Subscribe to email reports</p>
|
|
695
|
+
* </li>
|
|
696
|
+
* </ul>
|
|
697
|
+
* <p>To add custom permissions to an existing user, use <code>
|
|
698
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
699
|
+
* </code> instead.</p>
|
|
700
|
+
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
701
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
702
|
+
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
703
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
704
|
+
* <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
705
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
706
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
707
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
708
|
+
*/
|
|
709
|
+
CustomPermissionsName?: string;
|
|
710
|
+
/**
|
|
711
|
+
* @public
|
|
712
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
713
|
+
* <ul>
|
|
714
|
+
* <li>
|
|
715
|
+
* <p>
|
|
716
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
|
|
717
|
+
* </li>
|
|
718
|
+
* <li>
|
|
719
|
+
* <p>
|
|
720
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
|
|
721
|
+
* </li>
|
|
722
|
+
* </ul>
|
|
723
|
+
*/
|
|
724
|
+
ExternalLoginFederationProviderType?: string;
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
728
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
729
|
+
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
730
|
+
*/
|
|
731
|
+
CustomFederationProviderUrl?: string;
|
|
732
|
+
/**
|
|
733
|
+
* @public
|
|
734
|
+
* <p>The identity ID for a user in the external login provider.</p>
|
|
735
|
+
*/
|
|
736
|
+
ExternalLoginId?: string;
|
|
737
|
+
/**
|
|
738
|
+
* @public
|
|
739
|
+
* <p>The tags to associate with the user.</p>
|
|
740
|
+
*/
|
|
741
|
+
Tags?: Tag[];
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
export interface RegisterUserResponse {
|
|
747
|
+
/**
|
|
748
|
+
* @public
|
|
749
|
+
* <p>The user's user name.</p>
|
|
750
|
+
*/
|
|
751
|
+
User?: User;
|
|
752
|
+
/**
|
|
753
|
+
* @public
|
|
754
|
+
* <p>The URL the user visits to complete registration and provide a password. This is
|
|
755
|
+
* returned only for users with an identity type of <code>QUICKSIGHT</code>.</p>
|
|
756
|
+
*/
|
|
757
|
+
UserInvitationUrl?: string;
|
|
758
|
+
/**
|
|
759
|
+
* @public
|
|
760
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
761
|
+
*/
|
|
762
|
+
RequestId?: string;
|
|
763
|
+
/**
|
|
764
|
+
* @public
|
|
765
|
+
* <p>The HTTP status of the request.</p>
|
|
766
|
+
*/
|
|
767
|
+
Status?: number;
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
export interface RestoreAnalysisRequest {
|
|
773
|
+
/**
|
|
774
|
+
* @public
|
|
775
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis.</p>
|
|
776
|
+
*/
|
|
777
|
+
AwsAccountId: string | undefined;
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
* <p>The ID of the analysis that you're restoring.</p>
|
|
781
|
+
*/
|
|
782
|
+
AnalysisId: string | undefined;
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
export interface RestoreAnalysisResponse {
|
|
788
|
+
/**
|
|
789
|
+
* @public
|
|
790
|
+
* <p>The HTTP status of the request.</p>
|
|
791
|
+
*/
|
|
792
|
+
Status?: number;
|
|
793
|
+
/**
|
|
794
|
+
* @public
|
|
795
|
+
* <p>The Amazon Resource Name (ARN) of the analysis that you're restoring.</p>
|
|
796
|
+
*/
|
|
797
|
+
Arn?: string;
|
|
798
|
+
/**
|
|
799
|
+
* @public
|
|
800
|
+
* <p>The ID of the analysis that you're restoring.
|
|
801
|
+
* </p>
|
|
802
|
+
*/
|
|
803
|
+
AnalysisId?: string;
|
|
804
|
+
/**
|
|
805
|
+
* @public
|
|
806
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
807
|
+
*/
|
|
808
|
+
RequestId?: string;
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
export interface SearchAnalysesRequest {
|
|
814
|
+
/**
|
|
815
|
+
* @public
|
|
816
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses that you're searching
|
|
817
|
+
* for.</p>
|
|
818
|
+
*/
|
|
819
|
+
AwsAccountId: string | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* @public
|
|
822
|
+
* <p>The structure for the search filters that you want to apply to your search. </p>
|
|
823
|
+
*/
|
|
824
|
+
Filters: AnalysisSearchFilter[] | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* @public
|
|
827
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
828
|
+
*/
|
|
829
|
+
NextToken?: string;
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
* <p>The maximum number of results to return.</p>
|
|
833
|
+
*/
|
|
834
|
+
MaxResults?: number;
|
|
835
|
+
}
|
|
836
|
+
/**
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
export interface SearchAnalysesResponse {
|
|
840
|
+
/**
|
|
841
|
+
* @public
|
|
842
|
+
* <p>Metadata describing the analyses that you searched for.</p>
|
|
843
|
+
*/
|
|
844
|
+
AnalysisSummaryList?: AnalysisSummary[];
|
|
845
|
+
/**
|
|
846
|
+
* @public
|
|
847
|
+
* <p>A pagination token that can be used in a subsequent request.
|
|
848
|
+
* </p>
|
|
849
|
+
*/
|
|
850
|
+
NextToken?: string;
|
|
851
|
+
/**
|
|
852
|
+
* @public
|
|
853
|
+
* <p>The HTTP status of the request.</p>
|
|
854
|
+
*/
|
|
855
|
+
Status?: number;
|
|
856
|
+
/**
|
|
857
|
+
* @public
|
|
858
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
859
|
+
*/
|
|
860
|
+
RequestId?: string;
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export interface SearchDashboardsRequest {
|
|
866
|
+
/**
|
|
867
|
+
* @public
|
|
868
|
+
* <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching
|
|
869
|
+
* for. </p>
|
|
870
|
+
*/
|
|
871
|
+
AwsAccountId: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* @public
|
|
874
|
+
* <p>The filters to apply to the search. Currently, you can search only by user name, for
|
|
875
|
+
* example, <code>"Filters": [ \{ "Name": "QUICKSIGHT_USER", "Operator": "StringEquals",
|
|
876
|
+
* "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]</code>
|
|
877
|
+
* </p>
|
|
878
|
+
*/
|
|
879
|
+
Filters: DashboardSearchFilter[] | undefined;
|
|
880
|
+
/**
|
|
881
|
+
* @public
|
|
882
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
883
|
+
*/
|
|
884
|
+
NextToken?: string;
|
|
885
|
+
/**
|
|
886
|
+
* @public
|
|
887
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
888
|
+
*/
|
|
889
|
+
MaxResults?: number;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
* @public
|
|
893
|
+
*/
|
|
894
|
+
export interface SearchDashboardsResponse {
|
|
895
|
+
/**
|
|
896
|
+
* @public
|
|
897
|
+
* <p>The list of dashboards owned by the user specified in <code>Filters</code> in your
|
|
898
|
+
* request.</p>
|
|
899
|
+
*/
|
|
900
|
+
DashboardSummaryList?: DashboardSummary[];
|
|
901
|
+
/**
|
|
902
|
+
* @public
|
|
903
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
904
|
+
*/
|
|
905
|
+
NextToken?: string;
|
|
906
|
+
/**
|
|
907
|
+
* @public
|
|
908
|
+
* <p>The HTTP status of the request.</p>
|
|
909
|
+
*/
|
|
910
|
+
Status?: number;
|
|
911
|
+
/**
|
|
912
|
+
* @public
|
|
913
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
914
|
+
*/
|
|
915
|
+
RequestId?: string;
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
920
|
+
export interface SearchDataSetsRequest {
|
|
921
|
+
/**
|
|
922
|
+
* @public
|
|
923
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
924
|
+
*/
|
|
925
|
+
AwsAccountId: string | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* @public
|
|
928
|
+
* <p>The filters to apply to the search.</p>
|
|
929
|
+
*/
|
|
930
|
+
Filters: DataSetSearchFilter[] | undefined;
|
|
931
|
+
/**
|
|
932
|
+
* @public
|
|
933
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
934
|
+
*/
|
|
935
|
+
NextToken?: string;
|
|
936
|
+
/**
|
|
937
|
+
* @public
|
|
938
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
939
|
+
*/
|
|
940
|
+
MaxResults?: number;
|
|
941
|
+
}
|
|
5
942
|
/**
|
|
6
943
|
* @public
|
|
7
944
|
*/
|
|
@@ -260,6 +1197,22 @@ export interface StartAssetBundleExportJobRequest {
|
|
|
260
1197
|
* <p>Use this field if the <code>ExportFormat</code> field of a <code>StartAssetBundleExportJobRequest</code> API call is set to <code>CLOUDFORMATION_JSON</code>.</p>
|
|
261
1198
|
*/
|
|
262
1199
|
CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration;
|
|
1200
|
+
/**
|
|
1201
|
+
* @public
|
|
1202
|
+
* <p>A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set <code>IncludePermissions</code> to <code>TRUE</code>, any permissions associated with each resource are exported.
|
|
1203
|
+
* </p>
|
|
1204
|
+
*/
|
|
1205
|
+
IncludePermissions?: boolean;
|
|
1206
|
+
/**
|
|
1207
|
+
* @public
|
|
1208
|
+
* <p> A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set <code>IncludeTags</code> to <code>TRUE</code>, any tags associated with each resource are exported.</p>
|
|
1209
|
+
*/
|
|
1210
|
+
IncludeTags?: boolean;
|
|
1211
|
+
/**
|
|
1212
|
+
* @public
|
|
1213
|
+
* <p>An optional parameter that determines which validation strategy to use for the export job. If <code>StrictModeForAllResources</code> is set to <code>TRUE</code>, strict validation for every error is enforced. If it is set to <code>FALSE</code>, validation is skipped for specific UI errors that are shown as warnings. The default value for <code>StrictModeForAllResources</code> is <code>FALSE</code>.</p>
|
|
1214
|
+
*/
|
|
1215
|
+
ValidationStrategy?: AssetBundleExportJobValidationStrategy;
|
|
263
1216
|
}
|
|
264
1217
|
/**
|
|
265
1218
|
* @public
|
|
@@ -308,7 +1261,7 @@ export interface StartAssetBundleImportJobRequest {
|
|
|
308
1261
|
AssetBundleImportSource: AssetBundleImportSource | undefined;
|
|
309
1262
|
/**
|
|
310
1263
|
* @public
|
|
311
|
-
* <p>Optional overrides
|
|
1264
|
+
* <p>Optional overrides that are applied to the resource configuration before import.</p>
|
|
312
1265
|
*/
|
|
313
1266
|
OverrideParameters?: AssetBundleImportJobOverrideParameters;
|
|
314
1267
|
/**
|
|
@@ -319,6 +1272,21 @@ export interface StartAssetBundleImportJobRequest {
|
|
|
319
1272
|
* any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.</p>
|
|
320
1273
|
*/
|
|
321
1274
|
FailureAction?: AssetBundleImportFailureAction;
|
|
1275
|
+
/**
|
|
1276
|
+
* @public
|
|
1277
|
+
* <p>Optional permission overrides that are applied to the resource configuration before import.</p>
|
|
1278
|
+
*/
|
|
1279
|
+
OverridePermissions?: AssetBundleImportJobOverridePermissions;
|
|
1280
|
+
/**
|
|
1281
|
+
* @public
|
|
1282
|
+
* <p>Optional tag overrides that are applied to the resource configuration before import.</p>
|
|
1283
|
+
*/
|
|
1284
|
+
OverrideTags?: AssetBundleImportJobOverrideTags;
|
|
1285
|
+
/**
|
|
1286
|
+
* @public
|
|
1287
|
+
* <p>An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import. </p>
|
|
1288
|
+
*/
|
|
1289
|
+
OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy;
|
|
322
1290
|
}
|
|
323
1291
|
/**
|
|
324
1292
|
* @public
|
|
@@ -1644,6 +2612,46 @@ export interface UpdateRefreshScheduleResponse {
|
|
|
1644
2612
|
*/
|
|
1645
2613
|
Arn?: string;
|
|
1646
2614
|
}
|
|
2615
|
+
/**
|
|
2616
|
+
* @public
|
|
2617
|
+
*/
|
|
2618
|
+
export interface UpdateRoleCustomPermissionRequest {
|
|
2619
|
+
/**
|
|
2620
|
+
* @public
|
|
2621
|
+
* <p>The name of the custom permission that you want to update the role with.</p>
|
|
2622
|
+
*/
|
|
2623
|
+
CustomPermissionsName: string | undefined;
|
|
2624
|
+
/**
|
|
2625
|
+
* @public
|
|
2626
|
+
* <p>The name of role tht you want to update.</p>
|
|
2627
|
+
*/
|
|
2628
|
+
Role: Role | undefined;
|
|
2629
|
+
/**
|
|
2630
|
+
* @public
|
|
2631
|
+
* <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>
|
|
2632
|
+
*/
|
|
2633
|
+
AwsAccountId: string | undefined;
|
|
2634
|
+
/**
|
|
2635
|
+
* @public
|
|
2636
|
+
* <p>The namespace that contains the role that you want to update.</p>
|
|
2637
|
+
*/
|
|
2638
|
+
Namespace: string | undefined;
|
|
2639
|
+
}
|
|
2640
|
+
/**
|
|
2641
|
+
* @public
|
|
2642
|
+
*/
|
|
2643
|
+
export interface UpdateRoleCustomPermissionResponse {
|
|
2644
|
+
/**
|
|
2645
|
+
* @public
|
|
2646
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2647
|
+
*/
|
|
2648
|
+
RequestId?: string;
|
|
2649
|
+
/**
|
|
2650
|
+
* @public
|
|
2651
|
+
* <p>The HTTP status of the request.</p>
|
|
2652
|
+
*/
|
|
2653
|
+
Status?: number;
|
|
2654
|
+
}
|
|
1647
2655
|
/**
|
|
1648
2656
|
* @public
|
|
1649
2657
|
*/
|