UNPKG

157 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class QuickSight extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: QuickSight.Types.ClientConfiguration)
13 config: Config & QuickSight.Types.ClientConfiguration;
14 /**
15 * Cancels an ongoing ingestion of data into SPICE.
16 */
17 cancelIngestion(params: QuickSight.Types.CancelIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
18 /**
19 * Cancels an ongoing ingestion of data into SPICE.
20 */
21 cancelIngestion(callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
22 /**
23 * Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
24 */
25 createDashboard(params: QuickSight.Types.CreateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
26 /**
27 * Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
28 */
29 createDashboard(callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
30 /**
31 * Creates a dataset.
32 */
33 createDataSet(params: QuickSight.Types.CreateDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDataSetResponse) => void): Request<QuickSight.Types.CreateDataSetResponse, AWSError>;
34 /**
35 * Creates a dataset.
36 */
37 createDataSet(callback?: (err: AWSError, data: QuickSight.Types.CreateDataSetResponse) => void): Request<QuickSight.Types.CreateDataSetResponse, AWSError>;
38 /**
39 * Creates a data source.
40 */
41 createDataSource(params: QuickSight.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDataSourceResponse) => void): Request<QuickSight.Types.CreateDataSourceResponse, AWSError>;
42 /**
43 * Creates a data source.
44 */
45 createDataSource(callback?: (err: AWSError, data: QuickSight.Types.CreateDataSourceResponse) => void): Request<QuickSight.Types.CreateDataSourceResponse, AWSError>;
46 /**
47 * Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:&lt;relevant-aws-account-id&gt;:group/default/&lt;group-name&gt; . The response is a group object.
48 */
49 createGroup(params: QuickSight.Types.CreateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
50 /**
51 * Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:&lt;relevant-aws-account-id&gt;:group/default/&lt;group-name&gt; . The response is a group object.
52 */
53 createGroup(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
54 /**
55 * Adds an Amazon QuickSight user to an Amazon QuickSight group.
56 */
57 createGroupMembership(params: QuickSight.Types.CreateGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
58 /**
59 * Adds an Amazon QuickSight user to an Amazon QuickSight group.
60 */
61 createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
62 /**
63 * Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
64 */
65 createIAMPolicyAssignment(params: QuickSight.Types.CreateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
66 /**
67 * Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
68 */
69 createIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
70 /**
71 * Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
72 */
73 createIngestion(params: QuickSight.Types.CreateIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
74 /**
75 * Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
76 */
77 createIngestion(callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
78 /**
79 * Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
80 */
81 createTemplate(params: QuickSight.Types.CreateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
82 /**
83 * Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
84 */
85 createTemplate(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
86 /**
87 * Creates a template alias for a template.
88 */
89 createTemplateAlias(params: QuickSight.Types.CreateTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateAliasResponse) => void): Request<QuickSight.Types.CreateTemplateAliasResponse, AWSError>;
90 /**
91 * Creates a template alias for a template.
92 */
93 createTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateAliasResponse) => void): Request<QuickSight.Types.CreateTemplateAliasResponse, AWSError>;
94 /**
95 * Deletes a dashboard.
96 */
97 deleteDashboard(params: QuickSight.Types.DeleteDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDashboardResponse) => void): Request<QuickSight.Types.DeleteDashboardResponse, AWSError>;
98 /**
99 * Deletes a dashboard.
100 */
101 deleteDashboard(callback?: (err: AWSError, data: QuickSight.Types.DeleteDashboardResponse) => void): Request<QuickSight.Types.DeleteDashboardResponse, AWSError>;
102 /**
103 * Deletes a dataset.
104 */
105 deleteDataSet(params: QuickSight.Types.DeleteDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetResponse) => void): Request<QuickSight.Types.DeleteDataSetResponse, AWSError>;
106 /**
107 * Deletes a dataset.
108 */
109 deleteDataSet(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetResponse) => void): Request<QuickSight.Types.DeleteDataSetResponse, AWSError>;
110 /**
111 * Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
112 */
113 deleteDataSource(params: QuickSight.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSourceResponse) => void): Request<QuickSight.Types.DeleteDataSourceResponse, AWSError>;
114 /**
115 * Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
116 */
117 deleteDataSource(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSourceResponse) => void): Request<QuickSight.Types.DeleteDataSourceResponse, AWSError>;
118 /**
119 * Removes a user group from Amazon QuickSight.
120 */
121 deleteGroup(params: QuickSight.Types.DeleteGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
122 /**
123 * Removes a user group from Amazon QuickSight.
124 */
125 deleteGroup(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
126 /**
127 * Removes a user from a group so that the user is no longer a member of the group.
128 */
129 deleteGroupMembership(params: QuickSight.Types.DeleteGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
130 /**
131 * Removes a user from a group so that the user is no longer a member of the group.
132 */
133 deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
134 /**
135 * Deletes an existing IAM policy assignment.
136 */
137 deleteIAMPolicyAssignment(params: QuickSight.Types.DeleteIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
138 /**
139 * Deletes an existing IAM policy assignment.
140 */
141 deleteIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
142 /**
143 * Deletes a template.
144 */
145 deleteTemplate(params: QuickSight.Types.DeleteTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
146 /**
147 * Deletes a template.
148 */
149 deleteTemplate(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
150 /**
151 * Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
152 */
153 deleteTemplateAlias(params: QuickSight.Types.DeleteTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
154 /**
155 * Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
156 */
157 deleteTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
158 /**
159 * Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
160 */
161 deleteUser(params: QuickSight.Types.DeleteUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
162 /**
163 * Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
164 */
165 deleteUser(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
166 /**
167 * Deletes a user identified by its principal ID.
168 */
169 deleteUserByPrincipalId(params: QuickSight.Types.DeleteUserByPrincipalIdRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
170 /**
171 * Deletes a user identified by its principal ID.
172 */
173 deleteUserByPrincipalId(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
174 /**
175 * Provides a summary for a dashboard.
176 */
177 describeDashboard(params: QuickSight.Types.DescribeDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
178 /**
179 * Provides a summary for a dashboard.
180 */
181 describeDashboard(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
182 /**
183 * Describes read and write permissions for a dashboard.
184 */
185 describeDashboardPermissions(params: QuickSight.Types.DescribeDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
186 /**
187 * Describes read and write permissions for a dashboard.
188 */
189 describeDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
190 /**
191 * Describes a dataset.
192 */
193 describeDataSet(params: QuickSight.Types.DescribeDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetResponse) => void): Request<QuickSight.Types.DescribeDataSetResponse, AWSError>;
194 /**
195 * Describes a dataset.
196 */
197 describeDataSet(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetResponse) => void): Request<QuickSight.Types.DescribeDataSetResponse, AWSError>;
198 /**
199 * Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
200 */
201 describeDataSetPermissions(params: QuickSight.Types.DescribeDataSetPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetPermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSetPermissionsResponse, AWSError>;
202 /**
203 * Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
204 */
205 describeDataSetPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetPermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSetPermissionsResponse, AWSError>;
206 /**
207 * Describes a data source.
208 */
209 describeDataSource(params: QuickSight.Types.DescribeDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourceResponse) => void): Request<QuickSight.Types.DescribeDataSourceResponse, AWSError>;
210 /**
211 * Describes a data source.
212 */
213 describeDataSource(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourceResponse) => void): Request<QuickSight.Types.DescribeDataSourceResponse, AWSError>;
214 /**
215 * Describes the resource permissions for a data source.
216 */
217 describeDataSourcePermissions(params: QuickSight.Types.DescribeDataSourcePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourcePermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSourcePermissionsResponse, AWSError>;
218 /**
219 * Describes the resource permissions for a data source.
220 */
221 describeDataSourcePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourcePermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSourcePermissionsResponse, AWSError>;
222 /**
223 * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
224 */
225 describeGroup(params: QuickSight.Types.DescribeGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
226 /**
227 * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
228 */
229 describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
230 /**
231 * Describes an existing IAM policy assignment, as specified by the assignment name.
232 */
233 describeIAMPolicyAssignment(params: QuickSight.Types.DescribeIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
234 /**
235 * Describes an existing IAM policy assignment, as specified by the assignment name.
236 */
237 describeIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
238 /**
239 * Describes a SPICE ingestion.
240 */
241 describeIngestion(params: QuickSight.Types.DescribeIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIngestionResponse) => void): Request<QuickSight.Types.DescribeIngestionResponse, AWSError>;
242 /**
243 * Describes a SPICE ingestion.
244 */
245 describeIngestion(callback?: (err: AWSError, data: QuickSight.Types.DescribeIngestionResponse) => void): Request<QuickSight.Types.DescribeIngestionResponse, AWSError>;
246 /**
247 * Describes a template's metadata.
248 */
249 describeTemplate(params: QuickSight.Types.DescribeTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
250 /**
251 * Describes a template's metadata.
252 */
253 describeTemplate(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
254 /**
255 * Describes the template alias for a template.
256 */
257 describeTemplateAlias(params: QuickSight.Types.DescribeTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
258 /**
259 * Describes the template alias for a template.
260 */
261 describeTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
262 /**
263 * Describes read and write permissions on a template.
264 */
265 describeTemplatePermissions(params: QuickSight.Types.DescribeTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplatePermissionsResponse) => void): Request<QuickSight.Types.DescribeTemplatePermissionsResponse, AWSError>;
266 /**
267 * Describes read and write permissions on a template.
268 */
269 describeTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplatePermissionsResponse) => void): Request<QuickSight.Types.DescribeTemplatePermissionsResponse, AWSError>;
270 /**
271 * Returns information about a user, given the user name.
272 */
273 describeUser(params: QuickSight.Types.DescribeUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
274 /**
275 * Returns information about a user, given the user name.
276 */
277 describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
278 /**
279 * Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
280 */
281 getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
282 /**
283 * Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
284 */
285 getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
286 /**
287 * Lists all the versions of the dashboards in the QuickSight subscription.
288 */
289 listDashboardVersions(params: QuickSight.Types.ListDashboardVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
290 /**
291 * Lists all the versions of the dashboards in the QuickSight subscription.
292 */
293 listDashboardVersions(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
294 /**
295 * Lists dashboards in an AWS account.
296 */
297 listDashboards(params: QuickSight.Types.ListDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
298 /**
299 * Lists dashboards in an AWS account.
300 */
301 listDashboards(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
302 /**
303 * Lists all of the datasets belonging to the current AWS account in an AWS Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
304 */
305 listDataSets(params: QuickSight.Types.ListDataSetsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
306 /**
307 * Lists all of the datasets belonging to the current AWS account in an AWS Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
308 */
309 listDataSets(callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
310 /**
311 * Lists data sources in current AWS Region that belong to this AWS account.
312 */
313 listDataSources(params: QuickSight.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
314 /**
315 * Lists data sources in current AWS Region that belong to this AWS account.
316 */
317 listDataSources(callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
318 /**
319 * Lists member users in a group.
320 */
321 listGroupMemberships(params: QuickSight.Types.ListGroupMembershipsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
322 /**
323 * Lists member users in a group.
324 */
325 listGroupMemberships(callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
326 /**
327 * Lists all user groups in Amazon QuickSight.
328 */
329 listGroups(params: QuickSight.Types.ListGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
330 /**
331 * Lists all user groups in Amazon QuickSight.
332 */
333 listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
334 /**
335 * Lists IAM policy assignments in the current Amazon QuickSight account.
336 */
337 listIAMPolicyAssignments(params: QuickSight.Types.ListIAMPolicyAssignmentsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
338 /**
339 * Lists IAM policy assignments in the current Amazon QuickSight account.
340 */
341 listIAMPolicyAssignments(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
342 /**
343 * Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
344 */
345 listIAMPolicyAssignmentsForUser(params: QuickSight.Types.ListIAMPolicyAssignmentsForUserRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
346 /**
347 * Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
348 */
349 listIAMPolicyAssignmentsForUser(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
350 /**
351 * Lists the history of SPICE ingestions for a dataset.
352 */
353 listIngestions(params: QuickSight.Types.ListIngestionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
354 /**
355 * Lists the history of SPICE ingestions for a dataset.
356 */
357 listIngestions(callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
358 /**
359 * Lists the tags assigned to a resource.
360 */
361 listTagsForResource(params: QuickSight.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTagsForResourceResponse) => void): Request<QuickSight.Types.ListTagsForResourceResponse, AWSError>;
362 /**
363 * Lists the tags assigned to a resource.
364 */
365 listTagsForResource(callback?: (err: AWSError, data: QuickSight.Types.ListTagsForResourceResponse) => void): Request<QuickSight.Types.ListTagsForResourceResponse, AWSError>;
366 /**
367 * Lists all the aliases of a template.
368 */
369 listTemplateAliases(params: QuickSight.Types.ListTemplateAliasesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
370 /**
371 * Lists all the aliases of a template.
372 */
373 listTemplateAliases(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
374 /**
375 * Lists all the versions of the templates in the current Amazon QuickSight account.
376 */
377 listTemplateVersions(params: QuickSight.Types.ListTemplateVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
378 /**
379 * Lists all the versions of the templates in the current Amazon QuickSight account.
380 */
381 listTemplateVersions(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
382 /**
383 * Lists all the templates in the current Amazon QuickSight account.
384 */
385 listTemplates(params: QuickSight.Types.ListTemplatesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
386 /**
387 * Lists all the templates in the current Amazon QuickSight account.
388 */
389 listTemplates(callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
390 /**
391 * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
392 */
393 listUserGroups(params: QuickSight.Types.ListUserGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
394 /**
395 * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
396 */
397 listUserGroups(callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
398 /**
399 * Returns a list of all of the Amazon QuickSight users belonging to this account.
400 */
401 listUsers(params: QuickSight.Types.ListUsersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
402 /**
403 * Returns a list of all of the Amazon QuickSight users belonging to this account.
404 */
405 listUsers(callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
406 /**
407 * Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
408 */
409 registerUser(params: QuickSight.Types.RegisterUserRequest, callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
410 /**
411 * Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
412 */
413 registerUser(callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
414 /**
415 * Searchs for dashboards that belong to a user.
416 */
417 searchDashboards(params: QuickSight.Types.SearchDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchDashboardsResponse) => void): Request<QuickSight.Types.SearchDashboardsResponse, AWSError>;
418 /**
419 * Searchs for dashboards that belong to a user.
420 */
421 searchDashboards(callback?: (err: AWSError, data: QuickSight.Types.SearchDashboardsResponse) => void): Request<QuickSight.Types.SearchDashboardsResponse, AWSError>;
422 /**
423 * Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following: You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources. QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
424 */
425 tagResource(params: QuickSight.Types.TagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
426 /**
427 * Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following: You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources. QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
428 */
429 tagResource(callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
430 /**
431 * Removes a tag or tags from a resource.
432 */
433 untagResource(params: QuickSight.Types.UntagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
434 /**
435 * Removes a tag or tags from a resource.
436 */
437 untagResource(callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
438 /**
439 * Updates a dashboard in an AWS account.
440 */
441 updateDashboard(params: QuickSight.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
442 /**
443 * Updates a dashboard in an AWS account.
444 */
445 updateDashboard(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
446 /**
447 * Updates read and write permissions on a dashboard.
448 */
449 updateDashboardPermissions(params: QuickSight.Types.UpdateDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPermissionsResponse) => void): Request<QuickSight.Types.UpdateDashboardPermissionsResponse, AWSError>;
450 /**
451 * Updates read and write permissions on a dashboard.
452 */
453 updateDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPermissionsResponse) => void): Request<QuickSight.Types.UpdateDashboardPermissionsResponse, AWSError>;
454 /**
455 * Updates the published version of a dashboard.
456 */
457 updateDashboardPublishedVersion(params: QuickSight.Types.UpdateDashboardPublishedVersionRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPublishedVersionResponse) => void): Request<QuickSight.Types.UpdateDashboardPublishedVersionResponse, AWSError>;
458 /**
459 * Updates the published version of a dashboard.
460 */
461 updateDashboardPublishedVersion(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPublishedVersionResponse) => void): Request<QuickSight.Types.UpdateDashboardPublishedVersionResponse, AWSError>;
462 /**
463 * Updates a dataset.
464 */
465 updateDataSet(params: QuickSight.Types.UpdateDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetResponse) => void): Request<QuickSight.Types.UpdateDataSetResponse, AWSError>;
466 /**
467 * Updates a dataset.
468 */
469 updateDataSet(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetResponse) => void): Request<QuickSight.Types.UpdateDataSetResponse, AWSError>;
470 /**
471 * Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
472 */
473 updateDataSetPermissions(params: QuickSight.Types.UpdateDataSetPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetPermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSetPermissionsResponse, AWSError>;
474 /**
475 * Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
476 */
477 updateDataSetPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetPermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSetPermissionsResponse, AWSError>;
478 /**
479 * Updates a data source.
480 */
481 updateDataSource(params: QuickSight.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourceResponse) => void): Request<QuickSight.Types.UpdateDataSourceResponse, AWSError>;
482 /**
483 * Updates a data source.
484 */
485 updateDataSource(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourceResponse) => void): Request<QuickSight.Types.UpdateDataSourceResponse, AWSError>;
486 /**
487 * Updates the permissions to a data source.
488 */
489 updateDataSourcePermissions(params: QuickSight.Types.UpdateDataSourcePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourcePermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSourcePermissionsResponse, AWSError>;
490 /**
491 * Updates the permissions to a data source.
492 */
493 updateDataSourcePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourcePermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSourcePermissionsResponse, AWSError>;
494 /**
495 * Changes a group description.
496 */
497 updateGroup(params: QuickSight.Types.UpdateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
498 /**
499 * Changes a group description.
500 */
501 updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
502 /**
503 * Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
504 */
505 updateIAMPolicyAssignment(params: QuickSight.Types.UpdateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
506 /**
507 * Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
508 */
509 updateIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
510 /**
511 * Updates a template from an existing Amazon QuickSight analysis or another template.
512 */
513 updateTemplate(params: QuickSight.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
514 /**
515 * Updates a template from an existing Amazon QuickSight analysis or another template.
516 */
517 updateTemplate(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
518 /**
519 * Updates the template alias of a template.
520 */
521 updateTemplateAlias(params: QuickSight.Types.UpdateTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
522 /**
523 * Updates the template alias of a template.
524 */
525 updateTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
526 /**
527 * Updates the resource permissions for a template.
528 */
529 updateTemplatePermissions(params: QuickSight.Types.UpdateTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
530 /**
531 * Updates the resource permissions for a template.
532 */
533 updateTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
534 /**
535 * Updates an Amazon QuickSight user.
536 */
537 updateUser(params: QuickSight.Types.UpdateUserRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
538 /**
539 * Updates an Amazon QuickSight user.
540 */
541 updateUser(callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
542}
543declare namespace QuickSight {
544 export type ActionList = String[];
545 export interface ActiveIAMPolicyAssignment {
546 /**
547 * A name for the IAM policy assignment.
548 */
549 AssignmentName?: IAMPolicyAssignmentName;
550 /**
551 * The Amazon Resource Name (ARN) of the resource.
552 */
553 PolicyArn?: Arn;
554 }
555 export type ActiveIAMPolicyAssignmentList = ActiveIAMPolicyAssignment[];
556 export interface AdHocFilteringOption {
557 /**
558 * Availability status.
559 */
560 AvailabilityStatus?: DashboardBehavior;
561 }
562 export type AliasName = string;
563 export interface AmazonElasticsearchParameters {
564 /**
565 * The Amazon Elasticsearch Service domain.
566 */
567 Domain: Domain;
568 }
569 export type Arn = string;
570 export type AssignmentStatus = "ENABLED"|"DRAFT"|"DISABLED"|string;
571 export interface AthenaParameters {
572 /**
573 * The workgroup that Amazon Athena uses.
574 */
575 WorkGroup?: WorkGroup;
576 }
577 export interface AuroraParameters {
578 /**
579 * Host.
580 */
581 Host: Host;
582 /**
583 * Port.
584 */
585 Port: Port;
586 /**
587 * Database.
588 */
589 Database: Database;
590 }
591 export interface AuroraPostgreSqlParameters {
592 /**
593 * Host.
594 */
595 Host: Host;
596 /**
597 * Port.
598 */
599 Port: Port;
600 /**
601 * Database.
602 */
603 Database: Database;
604 }
605 export type AwsAccountId = string;
606 export interface AwsIotAnalyticsParameters {
607 /**
608 * Dataset name.
609 */
610 DataSetName: DataSetName;
611 }
612 export type Boolean = boolean;
613 export interface CalculatedColumn {
614 /**
615 * Column name.
616 */
617 ColumnName: ColumnName;
618 /**
619 * A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
620 */
621 ColumnId: ColumnId;
622 /**
623 * An expression that defines the calculated column.
624 */
625 Expression: Expression;
626 }
627 export type CalculatedColumnList = CalculatedColumn[];
628 export interface CancelIngestionRequest {
629 /**
630 * The AWS account ID.
631 */
632 AwsAccountId: AwsAccountId;
633 /**
634 * The ID of the dataset used in the ingestion.
635 */
636 DataSetId: string;
637 /**
638 * An ID for the ingestion.
639 */
640 IngestionId: IngestionId;
641 }
642 export interface CancelIngestionResponse {
643 /**
644 * The Amazon Resource Name (ARN) for the data ingestion.
645 */
646 Arn?: Arn;
647 /**
648 * An ID for the ingestion.
649 */
650 IngestionId?: IngestionId;
651 /**
652 * The AWS request ID for this operation.
653 */
654 RequestId?: string;
655 /**
656 * The HTTP status of the request.
657 */
658 Status?: StatusCode;
659 }
660 export interface CastColumnTypeOperation {
661 /**
662 * Column name.
663 */
664 ColumnName: ColumnName;
665 /**
666 * New column data type.
667 */
668 NewColumnType: ColumnDataType;
669 /**
670 * When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
671 */
672 Format?: TypeCastFormat;
673 }
674 export type Catalog = string;
675 export type ClusterId = string;
676 export type ColumnDataType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|string;
677 export interface ColumnGroup {
678 /**
679 * Geospatial column group that denotes a hierarchy.
680 */
681 GeoSpatialColumnGroup?: GeoSpatialColumnGroup;
682 }
683 export interface ColumnGroupColumnSchema {
684 /**
685 * The name of the column group's column schema.
686 */
687 Name?: String;
688 }
689 export type ColumnGroupColumnSchemaList = ColumnGroupColumnSchema[];
690 export type ColumnGroupList = ColumnGroup[];
691 export type ColumnGroupName = string;
692 export interface ColumnGroupSchema {
693 /**
694 * The name of the column group schema.
695 */
696 Name?: String;
697 /**
698 * A structure containing the list of schemas for column group columns.
699 */
700 ColumnGroupColumnSchemaList?: ColumnGroupColumnSchemaList;
701 }
702 export type ColumnGroupSchemaList = ColumnGroupSchema[];
703 export type ColumnId = string;
704 export type ColumnList = ColumnName[];
705 export type ColumnName = string;
706 export interface ColumnSchema {
707 /**
708 * The name of the column schema.
709 */
710 Name?: String;
711 /**
712 * The data type of the column schema.
713 */
714 DataType?: String;
715 /**
716 * The geographic role of the column schema.
717 */
718 GeographicRole?: String;
719 }
720 export type ColumnSchemaList = ColumnSchema[];
721 export interface ColumnTag {
722 /**
723 * A geospatial role for a column.
724 */
725 ColumnGeographicRole?: GeoSpatialDataRole;
726 }
727 export type ColumnTagList = ColumnTag[];
728 export interface CreateColumnsOperation {
729 /**
730 * Calculated columns to create.
731 */
732 Columns: CalculatedColumnList;
733 }
734 export interface CreateDashboardRequest {
735 /**
736 * The ID of the AWS account where you want to create the dashboard.
737 */
738 AwsAccountId: AwsAccountId;
739 /**
740 * The ID for the dashboard, also added to the IAM policy.
741 */
742 DashboardId: RestrictiveResourceId;
743 /**
744 * The display name of the dashboard.
745 */
746 Name: DashboardName;
747 /**
748 * A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values. You can use the dashboard permissions structure described following to override two string parameters that accept multiple values.
749 */
750 Parameters?: Parameters;
751 /**
752 * A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
753 */
754 Permissions?: ResourcePermissionList;
755 /**
756 * The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template. If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.
757 */
758 SourceEntity: DashboardSourceEntity;
759 /**
760 * Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
761 */
762 Tags?: TagList;
763 /**
764 * A description for the first version of the dashboard being created.
765 */
766 VersionDescription?: VersionDescription;
767 /**
768 * Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.
769 */
770 DashboardPublishOptions?: DashboardPublishOptions;
771 }
772 export interface CreateDashboardResponse {
773 /**
774 * The Amazon Resource Name (ARN) of the dashboard.
775 */
776 Arn?: Arn;
777 /**
778 * The ARN of the dashboard, including the version number of the first version that is created.
779 */
780 VersionArn?: Arn;
781 /**
782 * The ID for the dashboard.
783 */
784 DashboardId?: RestrictiveResourceId;
785 /**
786 * The status of the dashboard creation request.
787 */
788 CreationStatus?: ResourceStatus;
789 /**
790 * The HTTP status of the request.
791 */
792 Status?: StatusCode;
793 /**
794 * The AWS request ID for this operation.
795 */
796 RequestId?: String;
797 }
798 export interface CreateDataSetRequest {
799 /**
800 * The AWS account ID.
801 */
802 AwsAccountId: AwsAccountId;
803 /**
804 * An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
805 */
806 DataSetId: ResourceId;
807 /**
808 * The display name for the dataset.
809 */
810 Name: ResourceName;
811 /**
812 * Declares the physical tables that are available in the underlying data sources.
813 */
814 PhysicalTableMap: PhysicalTableMap;
815 /**
816 * Configures the combination and transformation of the data from the physical tables.
817 */
818 LogicalTableMap?: LogicalTableMap;
819 /**
820 * Indicates whether you want to import the data into SPICE.
821 */
822 ImportMode: DataSetImportMode;
823 /**
824 * Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
825 */
826 ColumnGroups?: ColumnGroupList;
827 /**
828 * A list of resource permissions on the dataset.
829 */
830 Permissions?: ResourcePermissionList;
831 /**
832 * The row-level security configuration for the data that you want to create.
833 */
834 RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
835 /**
836 * Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
837 */
838 Tags?: TagList;
839 }
840 export interface CreateDataSetResponse {
841 /**
842 * The Amazon Resource Name (ARN) of the dataset.
843 */
844 Arn?: Arn;
845 /**
846 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
847 */
848 DataSetId?: ResourceId;
849 /**
850 * The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
851 */
852 IngestionArn?: Arn;
853 /**
854 * The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
855 */
856 IngestionId?: ResourceId;
857 /**
858 * The AWS request ID for this operation.
859 */
860 RequestId?: String;
861 /**
862 * The HTTP status of the request.
863 */
864 Status?: StatusCode;
865 }
866 export interface CreateDataSourceRequest {
867 /**
868 * The AWS account ID.
869 */
870 AwsAccountId: AwsAccountId;
871 /**
872 * An ID for the data source. This ID is unique per AWS Region for each AWS account.
873 */
874 DataSourceId: ResourceId;
875 /**
876 * A display name for the data source.
877 */
878 Name: ResourceName;
879 /**
880 * The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to return a list of all data sources.
881 */
882 Type: DataSourceType;
883 /**
884 * The parameters that QuickSight uses to connect to your underlying source.
885 */
886 DataSourceParameters?: DataSourceParameters;
887 /**
888 * The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
889 */
890 Credentials?: DataSourceCredentials;
891 /**
892 * A list of resource permissions on the data source.
893 */
894 Permissions?: ResourcePermissionList;
895 /**
896 * Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
897 */
898 VpcConnectionProperties?: VpcConnectionProperties;
899 /**
900 * Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
901 */
902 SslProperties?: SslProperties;
903 /**
904 * Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
905 */
906 Tags?: TagList;
907 }
908 export interface CreateDataSourceResponse {
909 /**
910 * The Amazon Resource Name (ARN) of the data source.
911 */
912 Arn?: Arn;
913 /**
914 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
915 */
916 DataSourceId?: ResourceId;
917 /**
918 * The status of creating the data source.
919 */
920 CreationStatus?: ResourceStatus;
921 /**
922 * The AWS request ID for this operation.
923 */
924 RequestId?: String;
925 /**
926 * The HTTP status of the request.
927 */
928 Status?: StatusCode;
929 }
930 export interface CreateGroupMembershipRequest {
931 /**
932 * The name of the user that you want to add to the group membership.
933 */
934 MemberName: GroupMemberName;
935 /**
936 * The name of the group that you want to add the user to.
937 */
938 GroupName: GroupName;
939 /**
940 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
941 */
942 AwsAccountId: AwsAccountId;
943 /**
944 * The namespace. Currently, you should set this to default.
945 */
946 Namespace: Namespace;
947 }
948 export interface CreateGroupMembershipResponse {
949 /**
950 * The group member.
951 */
952 GroupMember?: GroupMember;
953 /**
954 * The AWS request ID for this operation.
955 */
956 RequestId?: String;
957 /**
958 * The HTTP status of the request.
959 */
960 Status?: StatusCode;
961 }
962 export interface CreateGroupRequest {
963 /**
964 * A name for the group that you want to create.
965 */
966 GroupName: GroupName;
967 /**
968 * A description for the group that you want to create.
969 */
970 Description?: GroupDescription;
971 /**
972 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
973 */
974 AwsAccountId: AwsAccountId;
975 /**
976 * The namespace. Currently, you should set this to default.
977 */
978 Namespace: Namespace;
979 }
980 export interface CreateGroupResponse {
981 /**
982 * The name of the group.
983 */
984 Group?: Group;
985 /**
986 * The AWS request ID for this operation.
987 */
988 RequestId?: String;
989 /**
990 * The HTTP status of the request.
991 */
992 Status?: StatusCode;
993 }
994 export interface CreateIAMPolicyAssignmentRequest {
995 /**
996 * The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
997 */
998 AwsAccountId: AwsAccountId;
999 /**
1000 * The name of the assignment. It must be unique within an AWS account.
1001 */
1002 AssignmentName: IAMPolicyAssignmentName;
1003 /**
1004 * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
1005 */
1006 AssignmentStatus: AssignmentStatus;
1007 /**
1008 * The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
1009 */
1010 PolicyArn?: Arn;
1011 /**
1012 * The QuickSight users, groups, or both that you want to assign the policy to.
1013 */
1014 Identities?: IdentityMap;
1015 /**
1016 * The namespace that contains the assignment.
1017 */
1018 Namespace: Namespace;
1019 }
1020 export interface CreateIAMPolicyAssignmentResponse {
1021 /**
1022 * The name of the assignment. This name must be unique within the AWS account.
1023 */
1024 AssignmentName?: IAMPolicyAssignmentName;
1025 /**
1026 * The ID for the assignment.
1027 */
1028 AssignmentId?: String;
1029 /**
1030 * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
1031 */
1032 AssignmentStatus?: AssignmentStatus;
1033 /**
1034 * The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
1035 */
1036 PolicyArn?: Arn;
1037 /**
1038 * The QuickSight users, groups, or both that the IAM policy is assigned to.
1039 */
1040 Identities?: IdentityMap;
1041 /**
1042 * The AWS request ID for this operation.
1043 */
1044 RequestId?: String;
1045 /**
1046 * The HTTP status of the request.
1047 */
1048 Status?: StatusCode;
1049 }
1050 export interface CreateIngestionRequest {
1051 /**
1052 * The ID of the dataset used in the ingestion.
1053 */
1054 DataSetId: string;
1055 /**
1056 * An ID for the ingestion.
1057 */
1058 IngestionId: IngestionId;
1059 /**
1060 * The AWS account ID.
1061 */
1062 AwsAccountId: AwsAccountId;
1063 }
1064 export interface CreateIngestionResponse {
1065 /**
1066 * The Amazon Resource Name (ARN) for the data ingestion.
1067 */
1068 Arn?: Arn;
1069 /**
1070 * An ID for the ingestion.
1071 */
1072 IngestionId?: IngestionId;
1073 /**
1074 * The ingestion status.
1075 */
1076 IngestionStatus?: IngestionStatus;
1077 /**
1078 * The AWS request ID for this operation.
1079 */
1080 RequestId?: string;
1081 /**
1082 * The HTTP status of the request.
1083 */
1084 Status?: StatusCode;
1085 }
1086 export interface CreateTemplateAliasRequest {
1087 /**
1088 * The ID of the AWS account that contains the template that you creating an alias for.
1089 */
1090 AwsAccountId: AwsAccountId;
1091 /**
1092 * An ID for the template.
1093 */
1094 TemplateId: RestrictiveResourceId;
1095 /**
1096 * The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by QuickSight.
1097 */
1098 AliasName: AliasName;
1099 /**
1100 * The version number of the template.
1101 */
1102 TemplateVersionNumber: VersionNumber;
1103 }
1104 export interface CreateTemplateAliasResponse {
1105 /**
1106 * Information about the template alias.
1107 */
1108 TemplateAlias?: TemplateAlias;
1109 /**
1110 * The HTTP status of the request.
1111 */
1112 Status?: StatusCode;
1113 /**
1114 * The AWS request ID for this operation.
1115 */
1116 RequestId?: String;
1117 }
1118 export interface CreateTemplateRequest {
1119 /**
1120 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
1121 */
1122 AwsAccountId: AwsAccountId;
1123 /**
1124 * An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
1125 */
1126 TemplateId: RestrictiveResourceId;
1127 /**
1128 * A display name for the template.
1129 */
1130 Name?: TemplateName;
1131 /**
1132 * A list of resource permissions to be set on the template.
1133 */
1134 Permissions?: ResourcePermissionList;
1135 /**
1136 * The Amazon Resource Name (ARN) of the source entity from which this template is being created. Currently, you can create a template from an analysis or another template. If the ARN is for an analysis, include its dataset references.
1137 */
1138 SourceEntity: TemplateSourceEntity;
1139 /**
1140 * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
1141 */
1142 Tags?: TagList;
1143 /**
1144 * A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
1145 */
1146 VersionDescription?: VersionDescription;
1147 }
1148 export interface CreateTemplateResponse {
1149 /**
1150 * The ARN for the template.
1151 */
1152 Arn?: Arn;
1153 /**
1154 * The ARN for the template, including the version information of the first version.
1155 */
1156 VersionArn?: Arn;
1157 /**
1158 * The ID of the template.
1159 */
1160 TemplateId?: RestrictiveResourceId;
1161 /**
1162 * The template creation status.
1163 */
1164 CreationStatus?: ResourceStatus;
1165 /**
1166 * The HTTP status of the request.
1167 */
1168 Status?: StatusCode;
1169 /**
1170 * The AWS request ID for this operation.
1171 */
1172 RequestId?: String;
1173 }
1174 export interface CredentialPair {
1175 /**
1176 * User name.
1177 */
1178 Username: Username;
1179 /**
1180 * Password.
1181 */
1182 Password: Password;
1183 }
1184 export interface CustomSql {
1185 /**
1186 * The Amazon Resource Name (ARN) of the data source.
1187 */
1188 DataSourceArn: Arn;
1189 /**
1190 * A display name for the SQL query result.
1191 */
1192 Name: CustomSqlName;
1193 /**
1194 * The SQL query.
1195 */
1196 SqlQuery: SqlQuery;
1197 /**
1198 * The column schema from the SQL query result set.
1199 */
1200 Columns?: InputColumnList;
1201 }
1202 export type CustomSqlName = string;
1203 export interface Dashboard {
1204 /**
1205 * Dashboard ID.
1206 */
1207 DashboardId?: RestrictiveResourceId;
1208 /**
1209 * The Amazon Resource Name (ARN) of the resource.
1210 */
1211 Arn?: Arn;
1212 /**
1213 * A display name for the dataset.
1214 */
1215 Name?: DashboardName;
1216 /**
1217 * Version.
1218 */
1219 Version?: DashboardVersion;
1220 /**
1221 * The time that this dataset was created.
1222 */
1223 CreatedTime?: Timestamp;
1224 /**
1225 * The last time that this dataset was published.
1226 */
1227 LastPublishedTime?: Timestamp;
1228 /**
1229 * The last time that this dataset was updated.
1230 */
1231 LastUpdatedTime?: Timestamp;
1232 }
1233 export type DashboardBehavior = "ENABLED"|"DISABLED"|string;
1234 export interface DashboardError {
1235 /**
1236 * Type.
1237 */
1238 Type?: DashboardErrorType;
1239 /**
1240 * Message.
1241 */
1242 Message?: NonEmptyString;
1243 }
1244 export type DashboardErrorList = DashboardError[];
1245 export type DashboardErrorType = "DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"PARAMETER_VALUE_INCOMPATIBLE"|"PARAMETER_TYPE_INVALID"|"PARAMETER_NOT_FOUND"|"COLUMN_TYPE_MISMATCH"|"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"|"COLUMN_REPLACEMENT_MISSING"|string;
1246 export type DashboardFilterAttribute = "QUICKSIGHT_USER"|string;
1247 export type DashboardName = string;
1248 export interface DashboardPublishOptions {
1249 /**
1250 * Ad hoc (one-time) filtering option.
1251 */
1252 AdHocFilteringOption?: AdHocFilteringOption;
1253 /**
1254 * Export to .csv option.
1255 */
1256 ExportToCSVOption?: ExportToCSVOption;
1257 /**
1258 * Sheet controls option.
1259 */
1260 SheetControlsOption?: SheetControlsOption;
1261 }
1262 export interface DashboardSearchFilter {
1263 /**
1264 * The comparison operator that you want to use as a filter. For example, "Operator": "StringEquals".
1265 */
1266 Operator: FilterOperator;
1267 /**
1268 * The name of the value that you want to use as a filter. For example, "Name": "QUICKSIGHT_USER".
1269 */
1270 Name?: DashboardFilterAttribute;
1271 /**
1272 * The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
1273 */
1274 Value?: String;
1275 }
1276 export type DashboardSearchFilterList = DashboardSearchFilter[];
1277 export interface DashboardSourceEntity {
1278 /**
1279 * Source template.
1280 */
1281 SourceTemplate?: DashboardSourceTemplate;
1282 }
1283 export interface DashboardSourceTemplate {
1284 /**
1285 * Dataset references.
1286 */
1287 DataSetReferences: DataSetReferenceList;
1288 /**
1289 * The Amazon Resource Name (ARN) of the resource.
1290 */
1291 Arn: Arn;
1292 }
1293 export interface DashboardSummary {
1294 /**
1295 * The Amazon Resource Name (ARN) of the resource.
1296 */
1297 Arn?: Arn;
1298 /**
1299 * Dashboard ID.
1300 */
1301 DashboardId?: RestrictiveResourceId;
1302 /**
1303 * A display name for the dashboard.
1304 */
1305 Name?: DashboardName;
1306 /**
1307 * The time that this dashboard was created.
1308 */
1309 CreatedTime?: Timestamp;
1310 /**
1311 * The last time that this dashboard was updated.
1312 */
1313 LastUpdatedTime?: Timestamp;
1314 /**
1315 * Published version number.
1316 */
1317 PublishedVersionNumber?: VersionNumber;
1318 /**
1319 * The last time that this dashboard was published.
1320 */
1321 LastPublishedTime?: Timestamp;
1322 }
1323 export type DashboardSummaryList = DashboardSummary[];
1324 export type DashboardUIState = "EXPANDED"|"COLLAPSED"|string;
1325 export interface DashboardVersion {
1326 /**
1327 * The time that this dashboard version was created.
1328 */
1329 CreatedTime?: Timestamp;
1330 /**
1331 * Errors.
1332 */
1333 Errors?: DashboardErrorList;
1334 /**
1335 * Version number.
1336 */
1337 VersionNumber?: VersionNumber;
1338 /**
1339 * The HTTP status of the request.
1340 */
1341 Status?: ResourceStatus;
1342 /**
1343 * The Amazon Resource Name (ARN) of the resource.
1344 */
1345 Arn?: Arn;
1346 /**
1347 * Source entity ARN.
1348 */
1349 SourceEntityArn?: Arn;
1350 /**
1351 * Description.
1352 */
1353 Description?: VersionDescription;
1354 }
1355 export interface DashboardVersionSummary {
1356 /**
1357 * The Amazon Resource Name (ARN) of the resource.
1358 */
1359 Arn?: Arn;
1360 /**
1361 * The time that this dashboard version was created.
1362 */
1363 CreatedTime?: Timestamp;
1364 /**
1365 * Version number.
1366 */
1367 VersionNumber?: VersionNumber;
1368 /**
1369 * The HTTP status of the request.
1370 */
1371 Status?: ResourceStatus;
1372 /**
1373 * Source entity ARN.
1374 */
1375 SourceEntityArn?: Arn;
1376 /**
1377 * Description.
1378 */
1379 Description?: VersionDescription;
1380 }
1381 export type DashboardVersionSummaryList = DashboardVersionSummary[];
1382 export interface DataSet {
1383 /**
1384 * The Amazon Resource Name (ARN) of the resource.
1385 */
1386 Arn?: Arn;
1387 /**
1388 * The ID of the dataset.
1389 */
1390 DataSetId?: ResourceId;
1391 /**
1392 * A display name for the dataset.
1393 */
1394 Name?: ResourceName;
1395 /**
1396 * The time that this dataset was created.
1397 */
1398 CreatedTime?: Timestamp;
1399 /**
1400 * The last time that this dataset was updated.
1401 */
1402 LastUpdatedTime?: Timestamp;
1403 /**
1404 * Declares the physical tables that are available in the underlying data sources.
1405 */
1406 PhysicalTableMap?: PhysicalTableMap;
1407 /**
1408 * Configures the combination and transformation of the data from the physical tables.
1409 */
1410 LogicalTableMap?: LogicalTableMap;
1411 /**
1412 * The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
1413 */
1414 OutputColumns?: OutputColumnList;
1415 /**
1416 * Indicates whether you want to import the data into SPICE.
1417 */
1418 ImportMode?: DataSetImportMode;
1419 /**
1420 * The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
1421 */
1422 ConsumedSpiceCapacityInBytes?: Long;
1423 /**
1424 * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
1425 */
1426 ColumnGroups?: ColumnGroupList;
1427 /**
1428 * The row-level security configuration for the dataset.
1429 */
1430 RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
1431 }
1432 export interface DataSetConfiguration {
1433 /**
1434 * Placeholder.
1435 */
1436 Placeholder?: String;
1437 /**
1438 * Dataset schema.
1439 */
1440 DataSetSchema?: DataSetSchema;
1441 /**
1442 * A structure containing the list of column group schemas.
1443 */
1444 ColumnGroupSchemaList?: ColumnGroupSchemaList;
1445 }
1446 export type DataSetConfigurationList = DataSetConfiguration[];
1447 export type DataSetImportMode = "SPICE"|"DIRECT_QUERY"|string;
1448 export type DataSetName = string;
1449 export interface DataSetReference {
1450 /**
1451 * Dataset placeholder.
1452 */
1453 DataSetPlaceholder: NonEmptyString;
1454 /**
1455 * Dataset Amazon Resource Name (ARN).
1456 */
1457 DataSetArn: Arn;
1458 }
1459 export type DataSetReferenceList = DataSetReference[];
1460 export interface DataSetSchema {
1461 /**
1462 * A structure containing the list of column schemas.
1463 */
1464 ColumnSchemaList?: ColumnSchemaList;
1465 }
1466 export interface DataSetSummary {
1467 /**
1468 * The Amazon Resource Name (ARN) of the dataset.
1469 */
1470 Arn?: Arn;
1471 /**
1472 * The ID of the dataset.
1473 */
1474 DataSetId?: ResourceId;
1475 /**
1476 * A display name for the dataset.
1477 */
1478 Name?: ResourceName;
1479 /**
1480 * The time that this dataset was created.
1481 */
1482 CreatedTime?: Timestamp;
1483 /**
1484 * The last time that this dataset was updated.
1485 */
1486 LastUpdatedTime?: Timestamp;
1487 /**
1488 * Indicates whether you want to import the data into SPICE.
1489 */
1490 ImportMode?: DataSetImportMode;
1491 /**
1492 * The row-level security configuration for the dataset.
1493 */
1494 RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
1495 }
1496 export type DataSetSummaryList = DataSetSummary[];
1497 export interface DataSource {
1498 /**
1499 * The Amazon Resource Name (ARN) of the data source.
1500 */
1501 Arn?: Arn;
1502 /**
1503 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
1504 */
1505 DataSourceId?: ResourceId;
1506 /**
1507 * A display name for the data source.
1508 */
1509 Name?: ResourceName;
1510 /**
1511 * The type of the data source. This type indicates which database engine the data source connects to.
1512 */
1513 Type?: DataSourceType;
1514 /**
1515 * The HTTP status of the request.
1516 */
1517 Status?: ResourceStatus;
1518 /**
1519 * The time that this data source was created.
1520 */
1521 CreatedTime?: Timestamp;
1522 /**
1523 * The last time that this data source was updated.
1524 */
1525 LastUpdatedTime?: Timestamp;
1526 /**
1527 * The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
1528 */
1529 DataSourceParameters?: DataSourceParameters;
1530 /**
1531 * The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
1532 */
1533 VpcConnectionProperties?: VpcConnectionProperties;
1534 /**
1535 * Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
1536 */
1537 SslProperties?: SslProperties;
1538 /**
1539 * Error information from the last update or the creation of the data source.
1540 */
1541 ErrorInfo?: DataSourceErrorInfo;
1542 }
1543 export interface DataSourceCredentials {
1544 /**
1545 * Credential pair.
1546 */
1547 CredentialPair?: CredentialPair;
1548 }
1549 export interface DataSourceErrorInfo {
1550 /**
1551 * Error type.
1552 */
1553 Type?: DataSourceErrorInfoType;
1554 /**
1555 * Error message.
1556 */
1557 Message?: String;
1558 }
1559 export type DataSourceErrorInfoType = "TIMEOUT"|"ENGINE_VERSION_NOT_SUPPORTED"|"UNKNOWN_HOST"|"GENERIC_SQL_FAILURE"|"CONFLICT"|"UNKNOWN"|string;
1560 export type DataSourceList = DataSource[];
1561 export interface DataSourceParameters {
1562 /**
1563 * Amazon Elasticsearch Service parameters.
1564 */
1565 AmazonElasticsearchParameters?: AmazonElasticsearchParameters;
1566 /**
1567 * Amazon Athena parameters.
1568 */
1569 AthenaParameters?: AthenaParameters;
1570 /**
1571 * Amazon Aurora MySQL parameters.
1572 */
1573 AuroraParameters?: AuroraParameters;
1574 /**
1575 * Aurora PostgreSQL parameters.
1576 */
1577 AuroraPostgreSqlParameters?: AuroraPostgreSqlParameters;
1578 /**
1579 * AWS IoT Analytics parameters.
1580 */
1581 AwsIotAnalyticsParameters?: AwsIotAnalyticsParameters;
1582 /**
1583 * Jira parameters.
1584 */
1585 JiraParameters?: JiraParameters;
1586 /**
1587 * MariaDB parameters.
1588 */
1589 MariaDbParameters?: MariaDbParameters;
1590 /**
1591 * MySQL parameters.
1592 */
1593 MySqlParameters?: MySqlParameters;
1594 /**
1595 * PostgreSQL parameters.
1596 */
1597 PostgreSqlParameters?: PostgreSqlParameters;
1598 /**
1599 * Presto parameters.
1600 */
1601 PrestoParameters?: PrestoParameters;
1602 /**
1603 * Amazon RDS parameters.
1604 */
1605 RdsParameters?: RdsParameters;
1606 /**
1607 * Amazon Redshift parameters.
1608 */
1609 RedshiftParameters?: RedshiftParameters;
1610 /**
1611 * S3 parameters.
1612 */
1613 S3Parameters?: S3Parameters;
1614 /**
1615 * ServiceNow parameters.
1616 */
1617 ServiceNowParameters?: ServiceNowParameters;
1618 /**
1619 * Snowflake parameters.
1620 */
1621 SnowflakeParameters?: SnowflakeParameters;
1622 /**
1623 * Spark parameters.
1624 */
1625 SparkParameters?: SparkParameters;
1626 /**
1627 * SQL Server parameters.
1628 */
1629 SqlServerParameters?: SqlServerParameters;
1630 /**
1631 * Teradata parameters.
1632 */
1633 TeradataParameters?: TeradataParameters;
1634 /**
1635 * Twitter parameters.
1636 */
1637 TwitterParameters?: TwitterParameters;
1638 }
1639 export type DataSourceType = "ADOBE_ANALYTICS"|"AMAZON_ELASTICSEARCH"|"ATHENA"|"AURORA"|"AURORA_POSTGRESQL"|"AWS_IOT_ANALYTICS"|"GITHUB"|"JIRA"|"MARIADB"|"MYSQL"|"POSTGRESQL"|"PRESTO"|"REDSHIFT"|"S3"|"SALESFORCE"|"SERVICENOW"|"SNOWFLAKE"|"SPARK"|"SQLSERVER"|"TERADATA"|"TWITTER"|string;
1640 export type Database = string;
1641 export interface DateTimeParameter {
1642 /**
1643 * A display name for the dataset.
1644 */
1645 Name: NonEmptyString;
1646 /**
1647 * Values.
1648 */
1649 Values: TimestampList;
1650 }
1651 export type DateTimeParameterList = DateTimeParameter[];
1652 export interface DecimalParameter {
1653 /**
1654 * A display name for the dataset.
1655 */
1656 Name: NonEmptyString;
1657 /**
1658 * Values.
1659 */
1660 Values: DoubleList;
1661 }
1662 export type DecimalParameterList = DecimalParameter[];
1663 export interface DeleteDashboardRequest {
1664 /**
1665 * The ID of the AWS account that contains the dashboard that you're deleting.
1666 */
1667 AwsAccountId: AwsAccountId;
1668 /**
1669 * The ID for the dashboard.
1670 */
1671 DashboardId: RestrictiveResourceId;
1672 /**
1673 * The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
1674 */
1675 VersionNumber?: VersionNumber;
1676 }
1677 export interface DeleteDashboardResponse {
1678 /**
1679 * The HTTP status of the request.
1680 */
1681 Status?: StatusCode;
1682 /**
1683 * The Secure Socket Layer (SSL) properties that apply for the resource.
1684 */
1685 Arn?: Arn;
1686 /**
1687 * The ID of the dashboard.
1688 */
1689 DashboardId?: RestrictiveResourceId;
1690 /**
1691 * The AWS request ID for this operation.
1692 */
1693 RequestId?: String;
1694 }
1695 export interface DeleteDataSetRequest {
1696 /**
1697 * The AWS account ID.
1698 */
1699 AwsAccountId: AwsAccountId;
1700 /**
1701 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
1702 */
1703 DataSetId: ResourceId;
1704 }
1705 export interface DeleteDataSetResponse {
1706 /**
1707 * The Amazon Resource Name (ARN) of the dataset.
1708 */
1709 Arn?: Arn;
1710 /**
1711 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
1712 */
1713 DataSetId?: ResourceId;
1714 /**
1715 * The AWS request ID for this operation.
1716 */
1717 RequestId?: String;
1718 /**
1719 * The HTTP status of the request.
1720 */
1721 Status?: StatusCode;
1722 }
1723 export interface DeleteDataSourceRequest {
1724 /**
1725 * The AWS account ID.
1726 */
1727 AwsAccountId: AwsAccountId;
1728 /**
1729 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
1730 */
1731 DataSourceId: ResourceId;
1732 }
1733 export interface DeleteDataSourceResponse {
1734 /**
1735 * The Amazon Resource Name (ARN) of the data source that you deleted.
1736 */
1737 Arn?: Arn;
1738 /**
1739 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
1740 */
1741 DataSourceId?: ResourceId;
1742 /**
1743 * The AWS request ID for this operation.
1744 */
1745 RequestId?: String;
1746 /**
1747 * The HTTP status of the request.
1748 */
1749 Status?: StatusCode;
1750 }
1751 export interface DeleteGroupMembershipRequest {
1752 /**
1753 * The name of the user that you want to delete from the group membership.
1754 */
1755 MemberName: GroupMemberName;
1756 /**
1757 * The name of the group that you want to delete the user from.
1758 */
1759 GroupName: GroupName;
1760 /**
1761 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
1762 */
1763 AwsAccountId: AwsAccountId;
1764 /**
1765 * The namespace. Currently, you should set this to default.
1766 */
1767 Namespace: Namespace;
1768 }
1769 export interface DeleteGroupMembershipResponse {
1770 /**
1771 * The AWS request ID for this operation.
1772 */
1773 RequestId?: String;
1774 /**
1775 * The HTTP status of the request.
1776 */
1777 Status?: StatusCode;
1778 }
1779 export interface DeleteGroupRequest {
1780 /**
1781 * The name of the group that you want to delete.
1782 */
1783 GroupName: GroupName;
1784 /**
1785 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
1786 */
1787 AwsAccountId: AwsAccountId;
1788 /**
1789 * The namespace. Currently, you should set this to default.
1790 */
1791 Namespace: Namespace;
1792 }
1793 export interface DeleteGroupResponse {
1794 /**
1795 * The AWS request ID for this operation.
1796 */
1797 RequestId?: String;
1798 /**
1799 * The HTTP status of the request.
1800 */
1801 Status?: StatusCode;
1802 }
1803 export interface DeleteIAMPolicyAssignmentRequest {
1804 /**
1805 * The AWS account ID where you want to delete the IAM policy assignment.
1806 */
1807 AwsAccountId: AwsAccountId;
1808 /**
1809 * The name of the assignment.
1810 */
1811 AssignmentName: IAMPolicyAssignmentName;
1812 /**
1813 * The namespace that contains the assignment.
1814 */
1815 Namespace: Namespace;
1816 }
1817 export interface DeleteIAMPolicyAssignmentResponse {
1818 /**
1819 * The name of the assignment.
1820 */
1821 AssignmentName?: IAMPolicyAssignmentName;
1822 /**
1823 * The AWS request ID for this operation.
1824 */
1825 RequestId?: String;
1826 /**
1827 * The HTTP status of the request.
1828 */
1829 Status?: StatusCode;
1830 }
1831 export interface DeleteTemplateAliasRequest {
1832 /**
1833 * The ID of the AWS account that contains the item to delete.
1834 */
1835 AwsAccountId: AwsAccountId;
1836 /**
1837 * The ID for the template that the specified alias is for.
1838 */
1839 TemplateId: RestrictiveResourceId;
1840 /**
1841 * The name for the template alias. If you name a specific alias, you delete the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.
1842 */
1843 AliasName: AliasName;
1844 }
1845 export interface DeleteTemplateAliasResponse {
1846 /**
1847 * The HTTP status of the request.
1848 */
1849 Status?: StatusCode;
1850 /**
1851 * An ID for the template associated with the deletion.
1852 */
1853 TemplateId?: RestrictiveResourceId;
1854 /**
1855 * The name for the template alias.
1856 */
1857 AliasName?: AliasName;
1858 /**
1859 * The Amazon Resource Name (ARN) of the resource.
1860 */
1861 Arn?: Arn;
1862 /**
1863 * The AWS request ID for this operation.
1864 */
1865 RequestId?: String;
1866 }
1867 export interface DeleteTemplateRequest {
1868 /**
1869 * The ID of the AWS account that contains the template that you're deleting.
1870 */
1871 AwsAccountId: AwsAccountId;
1872 /**
1873 * An ID for the template you want to delete.
1874 */
1875 TemplateId: RestrictiveResourceId;
1876 /**
1877 * Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.
1878 */
1879 VersionNumber?: VersionNumber;
1880 }
1881 export interface DeleteTemplateResponse {
1882 /**
1883 * The AWS request ID for this operation.
1884 */
1885 RequestId?: String;
1886 /**
1887 * The Amazon Resource Name (ARN) of the resource.
1888 */
1889 Arn?: Arn;
1890 /**
1891 * An ID for the template.
1892 */
1893 TemplateId?: RestrictiveResourceId;
1894 /**
1895 * The HTTP status of the request.
1896 */
1897 Status?: StatusCode;
1898 }
1899 export interface DeleteUserByPrincipalIdRequest {
1900 /**
1901 * The principal ID of the user.
1902 */
1903 PrincipalId: String;
1904 /**
1905 * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
1906 */
1907 AwsAccountId: AwsAccountId;
1908 /**
1909 * The namespace. Currently, you should set this to default.
1910 */
1911 Namespace: Namespace;
1912 }
1913 export interface DeleteUserByPrincipalIdResponse {
1914 /**
1915 * The AWS request ID for this operation.
1916 */
1917 RequestId?: String;
1918 /**
1919 * The HTTP status of the request.
1920 */
1921 Status?: StatusCode;
1922 }
1923 export interface DeleteUserRequest {
1924 /**
1925 * The name of the user that you want to delete.
1926 */
1927 UserName: UserName;
1928 /**
1929 * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
1930 */
1931 AwsAccountId: AwsAccountId;
1932 /**
1933 * The namespace. Currently, you should set this to default.
1934 */
1935 Namespace: Namespace;
1936 }
1937 export interface DeleteUserResponse {
1938 /**
1939 * The AWS request ID for this operation.
1940 */
1941 RequestId?: String;
1942 /**
1943 * The HTTP status of the request.
1944 */
1945 Status?: StatusCode;
1946 }
1947 export type Delimiter = string;
1948 export interface DescribeDashboardPermissionsRequest {
1949 /**
1950 * The ID of the AWS account that contains the dashboard that you're describing permissions for.
1951 */
1952 AwsAccountId: AwsAccountId;
1953 /**
1954 * The ID for the dashboard, also added to the IAM policy.
1955 */
1956 DashboardId: RestrictiveResourceId;
1957 }
1958 export interface DescribeDashboardPermissionsResponse {
1959 /**
1960 * The ID for the dashboard.
1961 */
1962 DashboardId?: RestrictiveResourceId;
1963 /**
1964 * The Amazon Resource Name (ARN) of the dashboard.
1965 */
1966 DashboardArn?: Arn;
1967 /**
1968 * A structure that contains the permissions for the dashboard.
1969 */
1970 Permissions?: ResourcePermissionList;
1971 /**
1972 * The HTTP status of the request.
1973 */
1974 Status?: StatusCode;
1975 /**
1976 * The AWS request ID for this operation.
1977 */
1978 RequestId?: String;
1979 }
1980 export interface DescribeDashboardRequest {
1981 /**
1982 * The ID of the AWS account that contains the dashboard that you're describing.
1983 */
1984 AwsAccountId: AwsAccountId;
1985 /**
1986 * The ID for the dashboard.
1987 */
1988 DashboardId: RestrictiveResourceId;
1989 /**
1990 * The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
1991 */
1992 VersionNumber?: VersionNumber;
1993 /**
1994 * The alias name.
1995 */
1996 AliasName?: AliasName;
1997 }
1998 export interface DescribeDashboardResponse {
1999 /**
2000 * Information about the dashboard.
2001 */
2002 Dashboard?: Dashboard;
2003 /**
2004 * The HTTP status of this request.
2005 */
2006 Status?: StatusCode;
2007 /**
2008 * The AWS request ID for this operation.
2009 */
2010 RequestId?: String;
2011 }
2012 export interface DescribeDataSetPermissionsRequest {
2013 /**
2014 * The AWS account ID.
2015 */
2016 AwsAccountId: AwsAccountId;
2017 /**
2018 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
2019 */
2020 DataSetId: ResourceId;
2021 }
2022 export interface DescribeDataSetPermissionsResponse {
2023 /**
2024 * The Amazon Resource Name (ARN) of the dataset.
2025 */
2026 DataSetArn?: Arn;
2027 /**
2028 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
2029 */
2030 DataSetId?: ResourceId;
2031 /**
2032 * A list of resource permissions on the dataset.
2033 */
2034 Permissions?: ResourcePermissionList;
2035 /**
2036 * The AWS request ID for this operation.
2037 */
2038 RequestId?: String;
2039 /**
2040 * The HTTP status of the request.
2041 */
2042 Status?: StatusCode;
2043 }
2044 export interface DescribeDataSetRequest {
2045 /**
2046 * The AWS account ID.
2047 */
2048 AwsAccountId: AwsAccountId;
2049 /**
2050 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
2051 */
2052 DataSetId: ResourceId;
2053 }
2054 export interface DescribeDataSetResponse {
2055 /**
2056 * Information on the dataset.
2057 */
2058 DataSet?: DataSet;
2059 /**
2060 * The AWS request ID for this operation.
2061 */
2062 RequestId?: String;
2063 /**
2064 * The HTTP status of the request.
2065 */
2066 Status?: StatusCode;
2067 }
2068 export interface DescribeDataSourcePermissionsRequest {
2069 /**
2070 * The AWS account ID.
2071 */
2072 AwsAccountId: AwsAccountId;
2073 /**
2074 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
2075 */
2076 DataSourceId: ResourceId;
2077 }
2078 export interface DescribeDataSourcePermissionsResponse {
2079 /**
2080 * The Amazon Resource Name (ARN) of the data source.
2081 */
2082 DataSourceArn?: Arn;
2083 /**
2084 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
2085 */
2086 DataSourceId?: ResourceId;
2087 /**
2088 * A list of resource permissions on the data source.
2089 */
2090 Permissions?: ResourcePermissionList;
2091 /**
2092 * The AWS request ID for this operation.
2093 */
2094 RequestId?: String;
2095 /**
2096 * The HTTP status of the request.
2097 */
2098 Status?: StatusCode;
2099 }
2100 export interface DescribeDataSourceRequest {
2101 /**
2102 * The AWS account ID.
2103 */
2104 AwsAccountId: AwsAccountId;
2105 /**
2106 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
2107 */
2108 DataSourceId: ResourceId;
2109 }
2110 export interface DescribeDataSourceResponse {
2111 /**
2112 * The information on the data source.
2113 */
2114 DataSource?: DataSource;
2115 /**
2116 * The AWS request ID for this operation.
2117 */
2118 RequestId?: String;
2119 /**
2120 * The HTTP status of the request.
2121 */
2122 Status?: StatusCode;
2123 }
2124 export interface DescribeGroupRequest {
2125 /**
2126 * The name of the group that you want to describe.
2127 */
2128 GroupName: GroupName;
2129 /**
2130 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
2131 */
2132 AwsAccountId: AwsAccountId;
2133 /**
2134 * The namespace. Currently, you should set this to default.
2135 */
2136 Namespace: Namespace;
2137 }
2138 export interface DescribeGroupResponse {
2139 /**
2140 * The name of the group.
2141 */
2142 Group?: Group;
2143 /**
2144 * The AWS request ID for this operation.
2145 */
2146 RequestId?: String;
2147 /**
2148 * The HTTP status of the request.
2149 */
2150 Status?: StatusCode;
2151 }
2152 export interface DescribeIAMPolicyAssignmentRequest {
2153 /**
2154 * The ID of the AWS account that contains the assignment that you want to describe.
2155 */
2156 AwsAccountId: AwsAccountId;
2157 /**
2158 * The name of the assignment.
2159 */
2160 AssignmentName: IAMPolicyAssignmentName;
2161 /**
2162 * The namespace that contains the assignment.
2163 */
2164 Namespace: Namespace;
2165 }
2166 export interface DescribeIAMPolicyAssignmentResponse {
2167 /**
2168 * Information describing the IAM policy assignment.
2169 */
2170 IAMPolicyAssignment?: IAMPolicyAssignment;
2171 /**
2172 * The AWS request ID for this operation.
2173 */
2174 RequestId?: String;
2175 /**
2176 * The HTTP status of the request.
2177 */
2178 Status?: StatusCode;
2179 }
2180 export interface DescribeIngestionRequest {
2181 /**
2182 * The AWS account ID.
2183 */
2184 AwsAccountId: AwsAccountId;
2185 /**
2186 * The ID of the dataset used in the ingestion.
2187 */
2188 DataSetId: string;
2189 /**
2190 * An ID for the ingestion.
2191 */
2192 IngestionId: IngestionId;
2193 }
2194 export interface DescribeIngestionResponse {
2195 /**
2196 * Information about the ingestion.
2197 */
2198 Ingestion?: Ingestion;
2199 /**
2200 * The AWS request ID for this operation.
2201 */
2202 RequestId?: string;
2203 /**
2204 * The HTTP status of the request.
2205 */
2206 Status?: StatusCode;
2207 }
2208 export interface DescribeTemplateAliasRequest {
2209 /**
2210 * The ID of the AWS account that contains the template alias that you're describing.
2211 */
2212 AwsAccountId: AwsAccountId;
2213 /**
2214 * The ID for the template.
2215 */
2216 TemplateId: RestrictiveResourceId;
2217 /**
2218 * The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
2219 */
2220 AliasName: AliasName;
2221 }
2222 export interface DescribeTemplateAliasResponse {
2223 /**
2224 * Information about the template alias.
2225 */
2226 TemplateAlias?: TemplateAlias;
2227 /**
2228 * The HTTP status of the request.
2229 */
2230 Status?: StatusCode;
2231 /**
2232 * The AWS request ID for this operation.
2233 */
2234 RequestId?: String;
2235 }
2236 export interface DescribeTemplatePermissionsRequest {
2237 /**
2238 * The ID of the AWS account that contains the template that you're describing.
2239 */
2240 AwsAccountId: AwsAccountId;
2241 /**
2242 * The ID for the template.
2243 */
2244 TemplateId: RestrictiveResourceId;
2245 }
2246 export interface DescribeTemplatePermissionsResponse {
2247 /**
2248 * The ID for the template.
2249 */
2250 TemplateId?: RestrictiveResourceId;
2251 /**
2252 * The Amazon Resource Name (ARN) of the template.
2253 */
2254 TemplateArn?: Arn;
2255 /**
2256 * A list of resource permissions to be set on the template.
2257 */
2258 Permissions?: ResourcePermissionList;
2259 /**
2260 * The AWS request ID for this operation.
2261 */
2262 RequestId?: String;
2263 /**
2264 * The HTTP status of the request.
2265 */
2266 Status?: StatusCode;
2267 }
2268 export interface DescribeTemplateRequest {
2269 /**
2270 * The ID of the AWS account that contains the template that you're describing.
2271 */
2272 AwsAccountId: AwsAccountId;
2273 /**
2274 * The ID for the template.
2275 */
2276 TemplateId: RestrictiveResourceId;
2277 /**
2278 * (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
2279 */
2280 VersionNumber?: VersionNumber;
2281 /**
2282 * The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
2283 */
2284 AliasName?: AliasName;
2285 }
2286 export interface DescribeTemplateResponse {
2287 /**
2288 * The template structure for the object you want to describe.
2289 */
2290 Template?: Template;
2291 /**
2292 * The HTTP status of the request.
2293 */
2294 Status?: StatusCode;
2295 }
2296 export interface DescribeUserRequest {
2297 /**
2298 * The name of the user that you want to describe.
2299 */
2300 UserName: UserName;
2301 /**
2302 * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
2303 */
2304 AwsAccountId: AwsAccountId;
2305 /**
2306 * The namespace. Currently, you should set this to default.
2307 */
2308 Namespace: Namespace;
2309 }
2310 export interface DescribeUserResponse {
2311 /**
2312 * The user name.
2313 */
2314 User?: User;
2315 /**
2316 * The AWS request ID for this operation.
2317 */
2318 RequestId?: String;
2319 /**
2320 * The HTTP status of the request.
2321 */
2322 Status?: StatusCode;
2323 }
2324 export type Domain = string;
2325 export type Double = number;
2326 export type DoubleList = Double[];
2327 export type EmbeddingUrl = string;
2328 export interface ErrorInfo {
2329 /**
2330 * Error type.
2331 */
2332 Type?: IngestionErrorType;
2333 /**
2334 * Error message.
2335 */
2336 Message?: string;
2337 }
2338 export interface ExportToCSVOption {
2339 /**
2340 * Availability status.
2341 */
2342 AvailabilityStatus?: DashboardBehavior;
2343 }
2344 export type Expression = string;
2345 export type FileFormat = "CSV"|"TSV"|"CLF"|"ELF"|"XLSX"|"JSON"|string;
2346 export interface FilterOperation {
2347 /**
2348 * An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
2349 */
2350 ConditionExpression: Expression;
2351 }
2352 export type FilterOperator = "StringEquals"|string;
2353 export interface GeoSpatialColumnGroup {
2354 /**
2355 * A display name for the hierarchy.
2356 */
2357 Name: ColumnGroupName;
2358 /**
2359 * Country code.
2360 */
2361 CountryCode: GeoSpatialCountryCode;
2362 /**
2363 * Columns in this hierarchy.
2364 */
2365 Columns: ColumnList;
2366 }
2367 export type GeoSpatialCountryCode = "US"|string;
2368 export type GeoSpatialDataRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"|string;
2369 export interface GetDashboardEmbedUrlRequest {
2370 /**
2371 * The ID for the AWS account that contains the dashboard that you're embedding.
2372 */
2373 AwsAccountId: AwsAccountId;
2374 /**
2375 * The ID for the dashboard, also added to the IAM policy.
2376 */
2377 DashboardId: RestrictiveResourceId;
2378 /**
2379 * The authentication method that the user uses to sign in.
2380 */
2381 IdentityType: IdentityType;
2382 /**
2383 * How many minutes the session is valid. The session lifetime must be 15-600 minutes.
2384 */
2385 SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
2386 /**
2387 * Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
2388 */
2389 UndoRedoDisabled?: boolean;
2390 /**
2391 * Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
2392 */
2393 ResetDisabled?: boolean;
2394 /**
2395 * The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
2396 */
2397 UserArn?: Arn;
2398 }
2399 export interface GetDashboardEmbedUrlResponse {
2400 /**
2401 * An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code value that enables a single sign-on session.
2402 */
2403 EmbedUrl?: EmbeddingUrl;
2404 /**
2405 * The HTTP status of the request.
2406 */
2407 Status?: StatusCode;
2408 /**
2409 * The AWS request ID for this operation.
2410 */
2411 RequestId?: String;
2412 }
2413 export interface Group {
2414 /**
2415 * The Amazon Resource Name (ARN) for the group.
2416 */
2417 Arn?: Arn;
2418 /**
2419 * The name of the group.
2420 */
2421 GroupName?: GroupName;
2422 /**
2423 * The group description.
2424 */
2425 Description?: GroupDescription;
2426 /**
2427 * The principal ID of the group.
2428 */
2429 PrincipalId?: String;
2430 }
2431 export type GroupDescription = string;
2432 export type GroupList = Group[];
2433 export interface GroupMember {
2434 /**
2435 * The Amazon Resource Name (ARN) for the group member (user).
2436 */
2437 Arn?: Arn;
2438 /**
2439 * The name of the group member (user).
2440 */
2441 MemberName?: GroupMemberName;
2442 }
2443 export type GroupMemberList = GroupMember[];
2444 export type GroupMemberName = string;
2445 export type GroupName = string;
2446 export type Host = string;
2447 export interface IAMPolicyAssignment {
2448 /**
2449 * The AWS account ID.
2450 */
2451 AwsAccountId?: AwsAccountId;
2452 /**
2453 * Assignment ID.
2454 */
2455 AssignmentId?: String;
2456 /**
2457 * Assignment name.
2458 */
2459 AssignmentName?: IAMPolicyAssignmentName;
2460 /**
2461 * The Amazon Resource Name (ARN) for the IAM policy.
2462 */
2463 PolicyArn?: Arn;
2464 /**
2465 * Identities.
2466 */
2467 Identities?: IdentityMap;
2468 /**
2469 * Assignment status.
2470 */
2471 AssignmentStatus?: AssignmentStatus;
2472 }
2473 export type IAMPolicyAssignmentName = string;
2474 export interface IAMPolicyAssignmentSummary {
2475 /**
2476 * Assignment name.
2477 */
2478 AssignmentName?: IAMPolicyAssignmentName;
2479 /**
2480 * Assignment status.
2481 */
2482 AssignmentStatus?: AssignmentStatus;
2483 }
2484 export type IAMPolicyAssignmentSummaryList = IAMPolicyAssignmentSummary[];
2485 export type IdentityMap = {[key: string]: IdentityNameList};
2486 export type IdentityName = string;
2487 export type IdentityNameList = IdentityName[];
2488 export type IdentityType = "IAM"|"QUICKSIGHT"|string;
2489 export interface Ingestion {
2490 /**
2491 * The Amazon Resource Name (ARN) of the resource.
2492 */
2493 Arn: Arn;
2494 /**
2495 * Ingestion ID.
2496 */
2497 IngestionId?: IngestionId;
2498 /**
2499 * Ingestion status.
2500 */
2501 IngestionStatus: IngestionStatus;
2502 /**
2503 * Error information for this ingestion.
2504 */
2505 ErrorInfo?: ErrorInfo;
2506 RowInfo?: RowInfo;
2507 QueueInfo?: QueueInfo;
2508 /**
2509 * The time that this ingestion started.
2510 */
2511 CreatedTime: timestamp;
2512 /**
2513 * The time that this ingestion took, measured in seconds.
2514 */
2515 IngestionTimeInSeconds?: long;
2516 /**
2517 * The size of the data ingested, in bytes.
2518 */
2519 IngestionSizeInBytes?: long;
2520 /**
2521 * Event source for this ingestion.
2522 */
2523 RequestSource?: IngestionRequestSource;
2524 /**
2525 * Type of this ingestion.
2526 */
2527 RequestType?: IngestionRequestType;
2528 }
2529 export type IngestionErrorType = "FAILURE_TO_ASSUME_ROLE"|"INGESTION_SUPERSEDED"|"INGESTION_CANCELED"|"DATA_SET_DELETED"|"DATA_SET_NOT_SPICE"|"S3_UPLOADED_FILE_DELETED"|"S3_MANIFEST_ERROR"|"DATA_TOLERANCE_EXCEPTION"|"SPICE_TABLE_NOT_FOUND"|"DATA_SET_SIZE_LIMIT_EXCEEDED"|"ROW_SIZE_LIMIT_EXCEEDED"|"ACCOUNT_CAPACITY_LIMIT_EXCEEDED"|"CUSTOMER_ERROR"|"DATA_SOURCE_NOT_FOUND"|"IAM_ROLE_NOT_AVAILABLE"|"CONNECTION_FAILURE"|"SQL_TABLE_NOT_FOUND"|"PERMISSION_DENIED"|"SSL_CERTIFICATE_VALIDATION_FAILURE"|"OAUTH_TOKEN_FAILURE"|"SOURCE_API_LIMIT_EXCEEDED_FAILURE"|"PASSWORD_AUTHENTICATION_FAILURE"|"SQL_SCHEMA_MISMATCH_ERROR"|"INVALID_DATE_FORMAT"|"INVALID_DATAPREP_SYNTAX"|"SOURCE_RESOURCE_LIMIT_EXCEEDED"|"SQL_INVALID_PARAMETER_VALUE"|"QUERY_TIMEOUT"|"SQL_NUMERIC_OVERFLOW"|"UNRESOLVABLE_HOST"|"UNROUTABLE_HOST"|"SQL_EXCEPTION"|"S3_FILE_INACCESSIBLE"|"IOT_FILE_NOT_FOUND"|"IOT_DATA_SET_FILE_EMPTY"|"INVALID_DATA_SOURCE_CONFIG"|"DATA_SOURCE_AUTH_FAILED"|"DATA_SOURCE_CONNECTION_FAILED"|"FAILURE_TO_PROCESS_JSON_FILE"|"INTERNAL_SERVICE_ERROR"|string;
2530 export type IngestionId = string;
2531 export type IngestionMaxResults = number;
2532 export type IngestionRequestSource = "MANUAL"|"SCHEDULED"|string;
2533 export type IngestionRequestType = "INITIAL_INGESTION"|"EDIT"|"INCREMENTAL_REFRESH"|"FULL_REFRESH"|string;
2534 export type IngestionStatus = "INITIALIZED"|"QUEUED"|"RUNNING"|"FAILED"|"COMPLETED"|"CANCELLED"|string;
2535 export type Ingestions = Ingestion[];
2536 export interface InputColumn {
2537 /**
2538 * The name of this column in the underlying data source.
2539 */
2540 Name: ColumnName;
2541 /**
2542 * The data type of the column.
2543 */
2544 Type: InputColumnDataType;
2545 }
2546 export type InputColumnDataType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|string;
2547 export type InputColumnList = InputColumn[];
2548 export type InstanceId = string;
2549 export interface IntegerParameter {
2550 /**
2551 * A display name for the dataset.
2552 */
2553 Name: NonEmptyString;
2554 /**
2555 * Values.
2556 */
2557 Values: LongList;
2558 }
2559 export type IntegerParameterList = IntegerParameter[];
2560 export interface JiraParameters {
2561 /**
2562 * The base URL of the Jira site.
2563 */
2564 SiteBaseUrl: SiteBaseUrl;
2565 }
2566 export interface JoinInstruction {
2567 /**
2568 * Left operand.
2569 */
2570 LeftOperand: LogicalTableId;
2571 /**
2572 * Right operand.
2573 */
2574 RightOperand: LogicalTableId;
2575 /**
2576 * Type.
2577 */
2578 Type: JoinType;
2579 /**
2580 * On Clause.
2581 */
2582 OnClause: OnClause;
2583 }
2584 export type JoinType = "INNER"|"OUTER"|"LEFT"|"RIGHT"|string;
2585 export interface ListDashboardVersionsRequest {
2586 /**
2587 * The ID of the AWS account that contains the dashboard that you're listing versions for.
2588 */
2589 AwsAccountId: AwsAccountId;
2590 /**
2591 * The ID for the dashboard.
2592 */
2593 DashboardId: RestrictiveResourceId;
2594 /**
2595 * The token for the next set of results, or null if there are no more results.
2596 */
2597 NextToken?: String;
2598 /**
2599 * The maximum number of results to be returned per request.
2600 */
2601 MaxResults?: MaxResults;
2602 }
2603 export interface ListDashboardVersionsResponse {
2604 /**
2605 * A structure that contains information about each version of the dashboard.
2606 */
2607 DashboardVersionSummaryList?: DashboardVersionSummaryList;
2608 /**
2609 * The token for the next set of results, or null if there are no more results.
2610 */
2611 NextToken?: String;
2612 /**
2613 * The HTTP status of the request.
2614 */
2615 Status?: StatusCode;
2616 /**
2617 * The AWS request ID for this operation.
2618 */
2619 RequestId?: String;
2620 }
2621 export interface ListDashboardsRequest {
2622 /**
2623 * The ID of the AWS account that contains the dashboards that you're listing.
2624 */
2625 AwsAccountId: AwsAccountId;
2626 /**
2627 * The token for the next set of results, or null if there are no more results.
2628 */
2629 NextToken?: String;
2630 /**
2631 * The maximum number of results to be returned per request.
2632 */
2633 MaxResults?: MaxResults;
2634 }
2635 export interface ListDashboardsResponse {
2636 /**
2637 * A structure that contains all of the dashboards shared with the user. This structure provides basic information about the dashboards.
2638 */
2639 DashboardSummaryList?: DashboardSummaryList;
2640 /**
2641 * The token for the next set of results, or null if there are no more results.
2642 */
2643 NextToken?: String;
2644 /**
2645 * The HTTP status of the request.
2646 */
2647 Status?: StatusCode;
2648 /**
2649 * The AWS request ID for this operation.
2650 */
2651 RequestId?: String;
2652 }
2653 export interface ListDataSetsRequest {
2654 /**
2655 * The AWS account ID.
2656 */
2657 AwsAccountId: AwsAccountId;
2658 /**
2659 * The token for the next set of results, or null if there are no more results.
2660 */
2661 NextToken?: String;
2662 /**
2663 * The maximum number of results to be returned per request.
2664 */
2665 MaxResults?: MaxResults;
2666 }
2667 export interface ListDataSetsResponse {
2668 /**
2669 * The list of dataset summaries.
2670 */
2671 DataSetSummaries?: DataSetSummaryList;
2672 /**
2673 * The token for the next set of results, or null if there are no more results.
2674 */
2675 NextToken?: String;
2676 /**
2677 * The AWS request ID for this operation.
2678 */
2679 RequestId?: String;
2680 /**
2681 * The HTTP status of the request.
2682 */
2683 Status?: StatusCode;
2684 }
2685 export interface ListDataSourcesRequest {
2686 /**
2687 * The AWS account ID.
2688 */
2689 AwsAccountId: AwsAccountId;
2690 /**
2691 * The token for the next set of results, or null if there are no more results.
2692 */
2693 NextToken?: String;
2694 /**
2695 * The maximum number of results to be returned per request.
2696 */
2697 MaxResults?: MaxResults;
2698 }
2699 export interface ListDataSourcesResponse {
2700 /**
2701 * A list of data sources.
2702 */
2703 DataSources?: DataSourceList;
2704 /**
2705 * The token for the next set of results, or null if there are no more results.
2706 */
2707 NextToken?: String;
2708 /**
2709 * The AWS request ID for this operation.
2710 */
2711 RequestId?: String;
2712 /**
2713 * The HTTP status of the request.
2714 */
2715 Status?: StatusCode;
2716 }
2717 export interface ListGroupMembershipsRequest {
2718 /**
2719 * The name of the group that you want to see a membership list of.
2720 */
2721 GroupName: GroupName;
2722 /**
2723 * A pagination token that can be used in a subsequent request.
2724 */
2725 NextToken?: String;
2726 /**
2727 * The maximum number of results to return from this request.
2728 */
2729 MaxResults?: MaxResults;
2730 /**
2731 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
2732 */
2733 AwsAccountId: AwsAccountId;
2734 /**
2735 * The namespace. Currently, you should set this to default.
2736 */
2737 Namespace: Namespace;
2738 }
2739 export interface ListGroupMembershipsResponse {
2740 /**
2741 * The list of the members of the group.
2742 */
2743 GroupMemberList?: GroupMemberList;
2744 /**
2745 * A pagination token that can be used in a subsequent request.
2746 */
2747 NextToken?: String;
2748 /**
2749 * The AWS request ID for this operation.
2750 */
2751 RequestId?: String;
2752 /**
2753 * The HTTP status of the request.
2754 */
2755 Status?: StatusCode;
2756 }
2757 export interface ListGroupsRequest {
2758 /**
2759 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
2760 */
2761 AwsAccountId: AwsAccountId;
2762 /**
2763 * A pagination token that can be used in a subsequent request.
2764 */
2765 NextToken?: String;
2766 /**
2767 * The maximum number of results to return.
2768 */
2769 MaxResults?: MaxResults;
2770 /**
2771 * The namespace. Currently, you should set this to default.
2772 */
2773 Namespace: Namespace;
2774 }
2775 export interface ListGroupsResponse {
2776 /**
2777 * The list of the groups.
2778 */
2779 GroupList?: GroupList;
2780 /**
2781 * A pagination token that can be used in a subsequent request.
2782 */
2783 NextToken?: String;
2784 /**
2785 * The AWS request ID for this operation.
2786 */
2787 RequestId?: String;
2788 /**
2789 * The HTTP status of the request.
2790 */
2791 Status?: StatusCode;
2792 }
2793 export interface ListIAMPolicyAssignmentsForUserRequest {
2794 /**
2795 * The ID of the AWS account that contains the assignments.
2796 */
2797 AwsAccountId: AwsAccountId;
2798 /**
2799 * The name of the user.
2800 */
2801 UserName: UserName;
2802 /**
2803 * The token for the next set of results, or null if there are no more results.
2804 */
2805 NextToken?: String;
2806 /**
2807 * The maximum number of results to be returned per request.
2808 */
2809 MaxResults?: MaxResults;
2810 /**
2811 * The namespace of the assignment.
2812 */
2813 Namespace: Namespace;
2814 }
2815 export interface ListIAMPolicyAssignmentsForUserResponse {
2816 /**
2817 * The active assignments for this user.
2818 */
2819 ActiveAssignments?: ActiveIAMPolicyAssignmentList;
2820 /**
2821 * The AWS request ID for this operation.
2822 */
2823 RequestId?: String;
2824 /**
2825 * The token for the next set of results, or null if there are no more results.
2826 */
2827 NextToken?: String;
2828 /**
2829 * The HTTP status of the request.
2830 */
2831 Status?: StatusCode;
2832 }
2833 export interface ListIAMPolicyAssignmentsRequest {
2834 /**
2835 * The ID of the AWS account that contains these IAM policy assignments.
2836 */
2837 AwsAccountId: AwsAccountId;
2838 /**
2839 * The status of the assignments.
2840 */
2841 AssignmentStatus?: AssignmentStatus;
2842 /**
2843 * The namespace for the assignments.
2844 */
2845 Namespace: Namespace;
2846 /**
2847 * The token for the next set of results, or null if there are no more results.
2848 */
2849 NextToken?: String;
2850 /**
2851 * The maximum number of results to be returned per request.
2852 */
2853 MaxResults?: MaxResults;
2854 }
2855 export interface ListIAMPolicyAssignmentsResponse {
2856 /**
2857 * Information describing the IAM policy assignments.
2858 */
2859 IAMPolicyAssignments?: IAMPolicyAssignmentSummaryList;
2860 /**
2861 * The token for the next set of results, or null if there are no more results.
2862 */
2863 NextToken?: String;
2864 /**
2865 * The AWS request ID for this operation.
2866 */
2867 RequestId?: String;
2868 /**
2869 * The HTTP status of the request.
2870 */
2871 Status?: StatusCode;
2872 }
2873 export interface ListIngestionsRequest {
2874 /**
2875 * The ID of the dataset used in the ingestion.
2876 */
2877 DataSetId: string;
2878 /**
2879 * The token for the next set of results, or null if there are no more results.
2880 */
2881 NextToken?: string;
2882 /**
2883 * The AWS account ID.
2884 */
2885 AwsAccountId: AwsAccountId;
2886 /**
2887 * The maximum number of results to be returned per request.
2888 */
2889 MaxResults?: IngestionMaxResults;
2890 }
2891 export interface ListIngestionsResponse {
2892 /**
2893 * A list of the ingestions.
2894 */
2895 Ingestions?: Ingestions;
2896 /**
2897 * The token for the next set of results, or null if there are no more results.
2898 */
2899 NextToken?: string;
2900 /**
2901 * The AWS request ID for this operation.
2902 */
2903 RequestId?: string;
2904 /**
2905 * The HTTP status of the request.
2906 */
2907 Status?: StatusCode;
2908 }
2909 export interface ListTagsForResourceRequest {
2910 /**
2911 * The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
2912 */
2913 ResourceArn: Arn;
2914 }
2915 export interface ListTagsForResourceResponse {
2916 /**
2917 * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
2918 */
2919 Tags?: TagList;
2920 /**
2921 * The AWS request ID for this operation.
2922 */
2923 RequestId?: String;
2924 /**
2925 * The HTTP status of the request.
2926 */
2927 Status?: StatusCode;
2928 }
2929 export interface ListTemplateAliasesRequest {
2930 /**
2931 * The ID of the AWS account that contains the template aliases that you're listing.
2932 */
2933 AwsAccountId: AwsAccountId;
2934 /**
2935 * The ID for the template.
2936 */
2937 TemplateId: RestrictiveResourceId;
2938 /**
2939 * The token for the next set of results, or null if there are no more results.
2940 */
2941 NextToken?: String;
2942 /**
2943 * The maximum number of results to be returned per request.
2944 */
2945 MaxResults?: MaxResults;
2946 }
2947 export interface ListTemplateAliasesResponse {
2948 /**
2949 * A structure containing the list of the template's aliases.
2950 */
2951 TemplateAliasList?: TemplateAliasList;
2952 /**
2953 * The HTTP status of the request.
2954 */
2955 Status?: StatusCode;
2956 /**
2957 * The AWS request ID for this operation.
2958 */
2959 RequestId?: String;
2960 /**
2961 * The token for the next set of results, or null if there are no more results.
2962 */
2963 NextToken?: String;
2964 }
2965 export interface ListTemplateVersionsRequest {
2966 /**
2967 * The ID of the AWS account that contains the templates that you're listing.
2968 */
2969 AwsAccountId: AwsAccountId;
2970 /**
2971 * The ID for the template.
2972 */
2973 TemplateId: RestrictiveResourceId;
2974 /**
2975 * The token for the next set of results, or null if there are no more results.
2976 */
2977 NextToken?: String;
2978 /**
2979 * The maximum number of results to be returned per request.
2980 */
2981 MaxResults?: MaxResults;
2982 }
2983 export interface ListTemplateVersionsResponse {
2984 /**
2985 * A structure containing a list of all the versions of the specified template.
2986 */
2987 TemplateVersionSummaryList?: TemplateVersionSummaryList;
2988 /**
2989 * The token for the next set of results, or null if there are no more results.
2990 */
2991 NextToken?: String;
2992 /**
2993 * The HTTP status of the request.
2994 */
2995 Status?: StatusCode;
2996 /**
2997 * The AWS request ID for this operation.
2998 */
2999 RequestId?: String;
3000 }
3001 export interface ListTemplatesRequest {
3002 /**
3003 * The ID of the AWS account that contains the templates that you're listing.
3004 */
3005 AwsAccountId: AwsAccountId;
3006 /**
3007 * The token for the next set of results, or null if there are no more results.
3008 */
3009 NextToken?: String;
3010 /**
3011 * The maximum number of results to be returned per request.
3012 */
3013 MaxResults?: MaxResults;
3014 }
3015 export interface ListTemplatesResponse {
3016 /**
3017 * A structure containing information about the templates in the list.
3018 */
3019 TemplateSummaryList?: TemplateSummaryList;
3020 /**
3021 * The token for the next set of results, or null if there are no more results.
3022 */
3023 NextToken?: String;
3024 /**
3025 * The HTTP status of the request.
3026 */
3027 Status?: StatusCode;
3028 /**
3029 * The AWS request ID for this operation.
3030 */
3031 RequestId?: String;
3032 }
3033 export interface ListUserGroupsRequest {
3034 /**
3035 * The Amazon QuickSight user name that you want to list group memberships for.
3036 */
3037 UserName: UserName;
3038 /**
3039 * The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
3040 */
3041 AwsAccountId: AwsAccountId;
3042 /**
3043 * The namespace. Currently, you should set this to default.
3044 */
3045 Namespace: Namespace;
3046 /**
3047 * A pagination token that can be used in a subsequent request.
3048 */
3049 NextToken?: String;
3050 /**
3051 * The maximum number of results to return from this request.
3052 */
3053 MaxResults?: MaxResults;
3054 }
3055 export interface ListUserGroupsResponse {
3056 /**
3057 * The list of groups the user is a member of.
3058 */
3059 GroupList?: GroupList;
3060 /**
3061 * A pagination token that can be used in a subsequent request.
3062 */
3063 NextToken?: String;
3064 /**
3065 * The AWS request ID for this operation.
3066 */
3067 RequestId?: String;
3068 /**
3069 * The HTTP status of the request.
3070 */
3071 Status?: StatusCode;
3072 }
3073 export interface ListUsersRequest {
3074 /**
3075 * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
3076 */
3077 AwsAccountId: AwsAccountId;
3078 /**
3079 * A pagination token that can be used in a subsequent request.
3080 */
3081 NextToken?: String;
3082 /**
3083 * The maximum number of results to return from this request.
3084 */
3085 MaxResults?: MaxResults;
3086 /**
3087 * The namespace. Currently, you should set this to default.
3088 */
3089 Namespace: Namespace;
3090 }
3091 export interface ListUsersResponse {
3092 /**
3093 * The list of users.
3094 */
3095 UserList?: UserList;
3096 /**
3097 * A pagination token that can be used in a subsequent request.
3098 */
3099 NextToken?: String;
3100 /**
3101 * The AWS request ID for this operation.
3102 */
3103 RequestId?: String;
3104 /**
3105 * The HTTP status of the request.
3106 */
3107 Status?: StatusCode;
3108 }
3109 export interface LogicalTable {
3110 /**
3111 * A display name for the logical table.
3112 */
3113 Alias: LogicalTableAlias;
3114 /**
3115 * Transform operations that act on this logical table.
3116 */
3117 DataTransforms?: TransformOperationList;
3118 /**
3119 * Source of this logical table.
3120 */
3121 Source: LogicalTableSource;
3122 }
3123 export type LogicalTableAlias = string;
3124 export type LogicalTableId = string;
3125 export type LogicalTableMap = {[key: string]: LogicalTable};
3126 export interface LogicalTableSource {
3127 /**
3128 * Specifies the result of a join of two logical tables.
3129 */
3130 JoinInstruction?: JoinInstruction;
3131 /**
3132 * Physical table ID.
3133 */
3134 PhysicalTableId?: PhysicalTableId;
3135 }
3136 export type Long = number;
3137 export type LongList = Long[];
3138 export interface ManifestFileLocation {
3139 /**
3140 * Amazon S3 bucket.
3141 */
3142 Bucket: S3Bucket;
3143 /**
3144 * Amazon S3 key that identifies an object.
3145 */
3146 Key: S3Key;
3147 }
3148 export interface MariaDbParameters {
3149 /**
3150 * Host.
3151 */
3152 Host: Host;
3153 /**
3154 * Port.
3155 */
3156 Port: Port;
3157 /**
3158 * Database.
3159 */
3160 Database: Database;
3161 }
3162 export type MaxResults = number;
3163 export interface MySqlParameters {
3164 /**
3165 * Host.
3166 */
3167 Host: Host;
3168 /**
3169 * Port.
3170 */
3171 Port: Port;
3172 /**
3173 * Database.
3174 */
3175 Database: Database;
3176 }
3177 export type Namespace = string;
3178 export type NonEmptyString = string;
3179 export type OnClause = string;
3180 export type OptionalPort = number;
3181 export interface OutputColumn {
3182 /**
3183 * A display name for the dataset.
3184 */
3185 Name?: ColumnName;
3186 /**
3187 * Type.
3188 */
3189 Type?: ColumnDataType;
3190 }
3191 export type OutputColumnList = OutputColumn[];
3192 export interface Parameters {
3193 /**
3194 * String parameters.
3195 */
3196 StringParameters?: StringParameterList;
3197 /**
3198 * Integer parameters.
3199 */
3200 IntegerParameters?: IntegerParameterList;
3201 /**
3202 * Decimal parameters.
3203 */
3204 DecimalParameters?: DecimalParameterList;
3205 /**
3206 * DateTime parameters.
3207 */
3208 DateTimeParameters?: DateTimeParameterList;
3209 }
3210 export type Password = string;
3211 export interface PhysicalTable {
3212 /**
3213 * A physical table type for relational data sources.
3214 */
3215 RelationalTable?: RelationalTable;
3216 /**
3217 * A physical table type built from the results of the custom SQL query.
3218 */
3219 CustomSql?: CustomSql;
3220 /**
3221 * A physical table type for as S3 data source.
3222 */
3223 S3Source?: S3Source;
3224 }
3225 export type PhysicalTableId = string;
3226 export type PhysicalTableMap = {[key: string]: PhysicalTable};
3227 export type Port = number;
3228 export type PositiveInteger = number;
3229 export interface PostgreSqlParameters {
3230 /**
3231 * Host.
3232 */
3233 Host: Host;
3234 /**
3235 * Port.
3236 */
3237 Port: Port;
3238 /**
3239 * Database.
3240 */
3241 Database: Database;
3242 }
3243 export interface PrestoParameters {
3244 /**
3245 * Host.
3246 */
3247 Host: Host;
3248 /**
3249 * Port.
3250 */
3251 Port: Port;
3252 /**
3253 * Catalog.
3254 */
3255 Catalog: Catalog;
3256 }
3257 export type Principal = string;
3258 export interface ProjectOperation {
3259 /**
3260 * Projected columns.
3261 */
3262 ProjectedColumns: ProjectedColumnList;
3263 }
3264 export type ProjectedColumnList = String[];
3265 export type Query = string;
3266 export interface QueueInfo {
3267 /**
3268 * The ID of the queued ingestion.
3269 */
3270 WaitingOnIngestion: string;
3271 /**
3272 * The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
3273 */
3274 QueuedIngestion: string;
3275 }
3276 export interface RdsParameters {
3277 /**
3278 * Instance ID.
3279 */
3280 InstanceId: InstanceId;
3281 /**
3282 * Database.
3283 */
3284 Database: Database;
3285 }
3286 export interface RedshiftParameters {
3287 /**
3288 * Host. This field can be blank if ClusterId is provided.
3289 */
3290 Host?: Host;
3291 /**
3292 * Port. This field can be blank if the ClusterId is provided.
3293 */
3294 Port?: OptionalPort;
3295 /**
3296 * Database.
3297 */
3298 Database: Database;
3299 /**
3300 * Cluster ID. This field can be blank if the Host and Port are provided.
3301 */
3302 ClusterId?: ClusterId;
3303 }
3304 export interface RegisterUserRequest {
3305 /**
3306 * Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values: IAM: A user whose identity maps to an existing IAM user or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
3307 */
3308 IdentityType: IdentityType;
3309 /**
3310 * The email address of the user that you want to register.
3311 */
3312 Email: String;
3313 /**
3314 * The Amazon QuickSight role for the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This role isn't currently available for use.
3315 */
3316 UserRole: UserRole;
3317 /**
3318 * The ARN of the IAM user or role that you are registering with Amazon QuickSight.
3319 */
3320 IamArn?: String;
3321 /**
3322 * You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
3323 */
3324 SessionName?: RoleSessionName;
3325 /**
3326 * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
3327 */
3328 AwsAccountId: AwsAccountId;
3329 /**
3330 * The namespace. Currently, you should set this to default.
3331 */
3332 Namespace: Namespace;
3333 /**
3334 * The Amazon QuickSight user name that you want to create for the user you are registering.
3335 */
3336 UserName?: UserName;
3337 }
3338 export interface RegisterUserResponse {
3339 /**
3340 * The user name.
3341 */
3342 User?: User;
3343 /**
3344 * The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
3345 */
3346 UserInvitationUrl?: String;
3347 /**
3348 * The AWS request ID for this operation.
3349 */
3350 RequestId?: String;
3351 /**
3352 * The HTTP status of the request.
3353 */
3354 Status?: StatusCode;
3355 }
3356 export interface RelationalTable {
3357 /**
3358 * The Amazon Resource Name (ARN) for the data source.
3359 */
3360 DataSourceArn: Arn;
3361 /**
3362 * The schema name. This name applies to certain relational database engines.
3363 */
3364 Schema?: RelationalTableSchema;
3365 /**
3366 * The name of the relational table.
3367 */
3368 Name: RelationalTableName;
3369 /**
3370 * The column schema of the table.
3371 */
3372 InputColumns: InputColumnList;
3373 }
3374 export type RelationalTableName = string;
3375 export type RelationalTableSchema = string;
3376 export interface RenameColumnOperation {
3377 /**
3378 * The name of the column to be renamed.
3379 */
3380 ColumnName: ColumnName;
3381 /**
3382 * The new name for the column.
3383 */
3384 NewColumnName: ColumnName;
3385 }
3386 export type ResourceId = string;
3387 export type ResourceName = string;
3388 export interface ResourcePermission {
3389 /**
3390 * The Amazon Resource Name (ARN) of an Amazon QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .
3391 */
3392 Principal: Principal;
3393 /**
3394 * The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
3395 */
3396 Actions: ActionList;
3397 }
3398 export type ResourcePermissionList = ResourcePermission[];
3399 export type ResourceStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|string;
3400 export type RestrictiveResourceId = string;
3401 export type RoleSessionName = string;
3402 export interface RowInfo {
3403 /**
3404 * The number of rows that were ingested.
3405 */
3406 RowsIngested?: long;
3407 /**
3408 * The number of rows that were not ingested.
3409 */
3410 RowsDropped?: long;
3411 }
3412 export interface RowLevelPermissionDataSet {
3413 /**
3414 * The Amazon Resource Name (ARN) of the permission dataset.
3415 */
3416 Arn: Arn;
3417 /**
3418 * Permission policy.
3419 */
3420 PermissionPolicy: RowLevelPermissionPolicy;
3421 }
3422 export type RowLevelPermissionPolicy = "GRANT_ACCESS"|"DENY_ACCESS"|string;
3423 export type S3Bucket = string;
3424 export type S3Key = string;
3425 export interface S3Parameters {
3426 /**
3427 * Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
3428 */
3429 ManifestFileLocation: ManifestFileLocation;
3430 }
3431 export interface S3Source {
3432 /**
3433 * The amazon Resource Name (ARN) for the data source.
3434 */
3435 DataSourceArn: Arn;
3436 /**
3437 * Information about the format for the S3 source file or files.
3438 */
3439 UploadSettings?: UploadSettings;
3440 /**
3441 * A physical table type for as S3 data source.
3442 */
3443 InputColumns: InputColumnList;
3444 }
3445 export interface SearchDashboardsRequest {
3446 /**
3447 * The ID of the AWS account that contains the user whose dashboards you're searching for.
3448 */
3449 AwsAccountId: AwsAccountId;
3450 /**
3451 * The filters to apply to the search. Currently, you can search only by user name. For example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
3452 */
3453 Filters: DashboardSearchFilterList;
3454 /**
3455 * The token for the next set of results, or null if there are no more results.
3456 */
3457 NextToken?: String;
3458 /**
3459 * The maximum number of results to be returned per request.
3460 */
3461 MaxResults?: MaxResults;
3462 }
3463 export interface SearchDashboardsResponse {
3464 /**
3465 * The list of dashboards owned by the user specified in Filters in your request.
3466 */
3467 DashboardSummaryList?: DashboardSummaryList;
3468 /**
3469 * The token for the next set of results, or null if there are no more results.
3470 */
3471 NextToken?: String;
3472 /**
3473 * The HTTP status of the request.
3474 */
3475 Status?: StatusCode;
3476 /**
3477 * The AWS request ID for this operation.
3478 */
3479 RequestId?: String;
3480 }
3481 export interface ServiceNowParameters {
3482 /**
3483 * URL of the base site.
3484 */
3485 SiteBaseUrl: SiteBaseUrl;
3486 }
3487 export type SessionLifetimeInMinutes = number;
3488 export interface SheetControlsOption {
3489 /**
3490 * Visibility state.
3491 */
3492 VisibilityState?: DashboardUIState;
3493 }
3494 export type SiteBaseUrl = string;
3495 export interface SnowflakeParameters {
3496 /**
3497 * Host.
3498 */
3499 Host: Host;
3500 /**
3501 * Database.
3502 */
3503 Database: Database;
3504 /**
3505 * Warehouse.
3506 */
3507 Warehouse: Warehouse;
3508 }
3509 export interface SparkParameters {
3510 /**
3511 * Host.
3512 */
3513 Host: Host;
3514 /**
3515 * Port.
3516 */
3517 Port: Port;
3518 }
3519 export type SqlQuery = string;
3520 export interface SqlServerParameters {
3521 /**
3522 * Host.
3523 */
3524 Host: Host;
3525 /**
3526 * Port.
3527 */
3528 Port: Port;
3529 /**
3530 * Database.
3531 */
3532 Database: Database;
3533 }
3534 export interface SslProperties {
3535 /**
3536 * A Boolean option to control whether SSL should be disabled.
3537 */
3538 DisableSsl?: Boolean;
3539 }
3540 export type StatusCode = number;
3541 export type String = string;
3542 export type StringList = String[];
3543 export interface StringParameter {
3544 /**
3545 * A display name for the dataset.
3546 */
3547 Name: NonEmptyString;
3548 /**
3549 * Values.
3550 */
3551 Values: StringList;
3552 }
3553 export type StringParameterList = StringParameter[];
3554 export interface Tag {
3555 /**
3556 * Tag key.
3557 */
3558 Key: TagKey;
3559 /**
3560 * Tag value.
3561 */
3562 Value: TagValue;
3563 }
3564 export interface TagColumnOperation {
3565 /**
3566 * The column that this operation acts on.
3567 */
3568 ColumnName: ColumnName;
3569 /**
3570 * The dataset column tag, currently only used for geospatial type tagging. . This is not tags for the AWS tagging feature. .
3571 */
3572 Tags: ColumnTagList;
3573 }
3574 export type TagKey = string;
3575 export type TagKeyList = TagKey[];
3576 export type TagList = Tag[];
3577 export interface TagResourceRequest {
3578 /**
3579 * The Amazon Resource Name (ARN) of the resource that you want to tag.
3580 */
3581 ResourceArn: Arn;
3582 /**
3583 * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
3584 */
3585 Tags: TagList;
3586 }
3587 export interface TagResourceResponse {
3588 /**
3589 * The AWS request ID for this operation.
3590 */
3591 RequestId?: String;
3592 /**
3593 * The HTTP status of the request.
3594 */
3595 Status?: StatusCode;
3596 }
3597 export type TagValue = string;
3598 export interface Template {
3599 /**
3600 * The Amazon Resource Name (ARN) of the template.
3601 */
3602 Arn?: Arn;
3603 /**
3604 * The display name of the template.
3605 */
3606 Name?: TemplateName;
3607 /**
3608 * A structure describing the versions of the template.
3609 */
3610 Version?: TemplateVersion;
3611 /**
3612 * The ID for the template. This is unique per AWS Region for each AWS account.
3613 */
3614 TemplateId?: RestrictiveResourceId;
3615 /**
3616 * Time when this was last updated.
3617 */
3618 LastUpdatedTime?: Timestamp;
3619 /**
3620 * Time when this was created.
3621 */
3622 CreatedTime?: Timestamp;
3623 }
3624 export interface TemplateAlias {
3625 /**
3626 * The display name of the template alias.
3627 */
3628 AliasName?: AliasName;
3629 /**
3630 * The Amazon Resource Name (ARN) of the template alias.
3631 */
3632 Arn?: Arn;
3633 /**
3634 * The version number of the template alias.
3635 */
3636 TemplateVersionNumber?: VersionNumber;
3637 }
3638 export type TemplateAliasList = TemplateAlias[];
3639 export interface TemplateError {
3640 /**
3641 * Type of error.
3642 */
3643 Type?: TemplateErrorType;
3644 /**
3645 * Description of the error type.
3646 */
3647 Message?: NonEmptyString;
3648 }
3649 export type TemplateErrorList = TemplateError[];
3650 export type TemplateErrorType = "DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|string;
3651 export type TemplateName = string;
3652 export interface TemplateSourceAnalysis {
3653 /**
3654 * The Amazon Resource Name (ARN) of the resource.
3655 */
3656 Arn: Arn;
3657 /**
3658 * A structure containing information about the dataset references used as placeholders in the template.
3659 */
3660 DataSetReferences: DataSetReferenceList;
3661 }
3662 export interface TemplateSourceEntity {
3663 /**
3664 * The source analysis, if it is based on an analysis.
3665 */
3666 SourceAnalysis?: TemplateSourceAnalysis;
3667 /**
3668 * The source template, if it is based on an template.
3669 */
3670 SourceTemplate?: TemplateSourceTemplate;
3671 }
3672 export interface TemplateSourceTemplate {
3673 /**
3674 * The Amazon Resource Name (ARN) of the resource.
3675 */
3676 Arn: Arn;
3677 }
3678 export interface TemplateSummary {
3679 /**
3680 * A summary of a template.
3681 */
3682 Arn?: Arn;
3683 /**
3684 * The ID of the template. This ID is unique per AWS Region for each AWS account.
3685 */
3686 TemplateId?: RestrictiveResourceId;
3687 /**
3688 * A display name for the template.
3689 */
3690 Name?: TemplateName;
3691 /**
3692 * A structure containing a list of version numbers for the template summary.
3693 */
3694 LatestVersionNumber?: VersionNumber;
3695 /**
3696 * The last time that this template was created.
3697 */
3698 CreatedTime?: Timestamp;
3699 /**
3700 * The last time that this template was updated.
3701 */
3702 LastUpdatedTime?: Timestamp;
3703 }
3704 export type TemplateSummaryList = TemplateSummary[];
3705 export interface TemplateVersion {
3706 /**
3707 * The time that this template version was created.
3708 */
3709 CreatedTime?: Timestamp;
3710 /**
3711 * Errors associated with the template.
3712 */
3713 Errors?: TemplateErrorList;
3714 /**
3715 * The version number of the template.
3716 */
3717 VersionNumber?: VersionNumber;
3718 /**
3719 * The HTTP status of the request.
3720 */
3721 Status?: ResourceStatus;
3722 /**
3723 * Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .
3724 */
3725 DataSetConfigurations?: DataSetConfigurationList;
3726 /**
3727 * The description of the template.
3728 */
3729 Description?: VersionDescription;
3730 /**
3731 * The Amazon Resource Name (ARN) of the analysis or template which was used to create this template.
3732 */
3733 SourceEntityArn?: Arn;
3734 }
3735 export interface TemplateVersionSummary {
3736 /**
3737 * The ARN of the template version.
3738 */
3739 Arn?: Arn;
3740 /**
3741 * The version number of the template version.
3742 */
3743 VersionNumber?: VersionNumber;
3744 /**
3745 * The time that this template version was created.
3746 */
3747 CreatedTime?: Timestamp;
3748 /**
3749 * The status of the template version.
3750 */
3751 Status?: ResourceStatus;
3752 /**
3753 * The description of the template version.
3754 */
3755 Description?: VersionDescription;
3756 }
3757 export type TemplateVersionSummaryList = TemplateVersionSummary[];
3758 export interface TeradataParameters {
3759 /**
3760 * Host.
3761 */
3762 Host: Host;
3763 /**
3764 * Port.
3765 */
3766 Port: Port;
3767 /**
3768 * Database.
3769 */
3770 Database: Database;
3771 }
3772 export type TextQualifier = "DOUBLE_QUOTE"|"SINGLE_QUOTE"|string;
3773 export type Timestamp = Date;
3774 export type TimestampList = Timestamp[];
3775 export interface TransformOperation {
3776 /**
3777 * An operation that projects columns. Operations that come after a projection can only refer to projected columns.
3778 */
3779 ProjectOperation?: ProjectOperation;
3780 /**
3781 * An operation that filters rows based on some condition.
3782 */
3783 FilterOperation?: FilterOperation;
3784 /**
3785 * An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
3786 */
3787 CreateColumnsOperation?: CreateColumnsOperation;
3788 /**
3789 * An operation that renames a column.
3790 */
3791 RenameColumnOperation?: RenameColumnOperation;
3792 /**
3793 * A transform operation that casts a column to a different type.
3794 */
3795 CastColumnTypeOperation?: CastColumnTypeOperation;
3796 /**
3797 * An operation that tags a column with additional information.
3798 */
3799 TagColumnOperation?: TagColumnOperation;
3800 }
3801 export type TransformOperationList = TransformOperation[];
3802 export interface TwitterParameters {
3803 /**
3804 * Twitter query string.
3805 */
3806 Query: Query;
3807 /**
3808 * Maximum number of rows to query Twitter.
3809 */
3810 MaxRows: PositiveInteger;
3811 }
3812 export type TypeCastFormat = string;
3813 export interface UntagResourceRequest {
3814 /**
3815 * The Amazon Resource Name (ARN) of the resource that you want to untag.
3816 */
3817 ResourceArn: Arn;
3818 /**
3819 * The keys of the key-value pairs for the resource tag or tags assigned to the resource.
3820 */
3821 TagKeys: TagKeyList;
3822 }
3823 export interface UntagResourceResponse {
3824 /**
3825 * The AWS request ID for this operation.
3826 */
3827 RequestId?: String;
3828 /**
3829 * The HTTP status of the request.
3830 */
3831 Status?: StatusCode;
3832 }
3833 export interface UpdateDashboardPermissionsRequest {
3834 /**
3835 * The ID of the AWS account that contains the dashboard whose permissions you're updating.
3836 */
3837 AwsAccountId: AwsAccountId;
3838 /**
3839 * The ID for the dashboard.
3840 */
3841 DashboardId: RestrictiveResourceId;
3842 /**
3843 * The permissions that you want to grant on this resource.
3844 */
3845 GrantPermissions?: UpdateResourcePermissionList;
3846 /**
3847 * The permissions that you want to revoke from this resource.
3848 */
3849 RevokePermissions?: UpdateResourcePermissionList;
3850 }
3851 export interface UpdateDashboardPermissionsResponse {
3852 /**
3853 * The Amazon Resource Name (ARN) of the dashboard.
3854 */
3855 DashboardArn?: Arn;
3856 /**
3857 * The ID for the dashboard.
3858 */
3859 DashboardId?: RestrictiveResourceId;
3860 /**
3861 * Information about the permissions on the dashboard.
3862 */
3863 Permissions?: ResourcePermissionList;
3864 /**
3865 * The AWS request ID for this operation.
3866 */
3867 RequestId?: String;
3868 /**
3869 * The HTTP status of the request.
3870 */
3871 Status?: StatusCode;
3872 }
3873 export interface UpdateDashboardPublishedVersionRequest {
3874 /**
3875 * The ID of the AWS account that contains the dashboard that you're updating.
3876 */
3877 AwsAccountId: AwsAccountId;
3878 /**
3879 * The ID for the dashboard.
3880 */
3881 DashboardId: RestrictiveResourceId;
3882 /**
3883 * The version number of the dashboard.
3884 */
3885 VersionNumber: VersionNumber;
3886 }
3887 export interface UpdateDashboardPublishedVersionResponse {
3888 /**
3889 * The ID for the dashboard.
3890 */
3891 DashboardId?: RestrictiveResourceId;
3892 /**
3893 * The Amazon Resource Name (ARN) of the dashboard.
3894 */
3895 DashboardArn?: Arn;
3896 /**
3897 * The HTTP status of the request.
3898 */
3899 Status?: StatusCode;
3900 /**
3901 * The AWS request ID for this operation.
3902 */
3903 RequestId?: String;
3904 }
3905 export interface UpdateDashboardRequest {
3906 /**
3907 * The ID of the AWS account that contains the dashboard that you're updating.
3908 */
3909 AwsAccountId: AwsAccountId;
3910 /**
3911 * The ID for the dashboard.
3912 */
3913 DashboardId: RestrictiveResourceId;
3914 /**
3915 * The display name of the dashboard.
3916 */
3917 Name: DashboardName;
3918 /**
3919 * The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.
3920 */
3921 SourceEntity: DashboardSourceEntity;
3922 /**
3923 * A structure that contains the parameters of the dashboard.
3924 */
3925 Parameters?: Parameters;
3926 /**
3927 * A description for the first version of the dashboard being created.
3928 */
3929 VersionDescription?: VersionDescription;
3930 /**
3931 * Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.
3932 */
3933 DashboardPublishOptions?: DashboardPublishOptions;
3934 }
3935 export interface UpdateDashboardResponse {
3936 /**
3937 * The Amazon Resource Name (ARN) of the resource.
3938 */
3939 Arn?: Arn;
3940 /**
3941 * The ARN of the dashboard, including the version number.
3942 */
3943 VersionArn?: Arn;
3944 /**
3945 * The ID for the dashboard.
3946 */
3947 DashboardId?: RestrictiveResourceId;
3948 /**
3949 * The creation status of the request.
3950 */
3951 CreationStatus?: ResourceStatus;
3952 /**
3953 * The HTTP status of the request.
3954 */
3955 Status?: StatusCode;
3956 /**
3957 * The AWS request ID for this operation.
3958 */
3959 RequestId?: String;
3960 }
3961 export interface UpdateDataSetPermissionsRequest {
3962 /**
3963 * The AWS account ID.
3964 */
3965 AwsAccountId: AwsAccountId;
3966 /**
3967 * The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
3968 */
3969 DataSetId: ResourceId;
3970 /**
3971 * The resource permissions that you want to grant to the dataset.
3972 */
3973 GrantPermissions?: ResourcePermissionList;
3974 /**
3975 * The resource permissions that you want to revoke from the dataset.
3976 */
3977 RevokePermissions?: ResourcePermissionList;
3978 }
3979 export interface UpdateDataSetPermissionsResponse {
3980 /**
3981 * The Amazon Resource Name (ARN) of the dataset.
3982 */
3983 DataSetArn?: Arn;
3984 /**
3985 * The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
3986 */
3987 DataSetId?: ResourceId;
3988 /**
3989 * The AWS request ID for this operation.
3990 */
3991 RequestId?: String;
3992 /**
3993 * The HTTP status of the request.
3994 */
3995 Status?: StatusCode;
3996 }
3997 export interface UpdateDataSetRequest {
3998 /**
3999 * The AWS account ID.
4000 */
4001 AwsAccountId: AwsAccountId;
4002 /**
4003 * The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
4004 */
4005 DataSetId: ResourceId;
4006 /**
4007 * The display name for the dataset.
4008 */
4009 Name: ResourceName;
4010 /**
4011 * Declares the physical tables that are available in the underlying data sources.
4012 */
4013 PhysicalTableMap: PhysicalTableMap;
4014 /**
4015 * Configures the combination and transformation of the data from the physical tables.
4016 */
4017 LogicalTableMap?: LogicalTableMap;
4018 /**
4019 * Indicates whether you want to import the data into SPICE.
4020 */
4021 ImportMode: DataSetImportMode;
4022 /**
4023 * Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
4024 */
4025 ColumnGroups?: ColumnGroupList;
4026 /**
4027 * The row-level security configuration for the data you want to create.
4028 */
4029 RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
4030 }
4031 export interface UpdateDataSetResponse {
4032 /**
4033 * The Amazon Resource Name (ARN) of the dataset.
4034 */
4035 Arn?: Arn;
4036 /**
4037 * The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
4038 */
4039 DataSetId?: ResourceId;
4040 /**
4041 * The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
4042 */
4043 IngestionArn?: Arn;
4044 /**
4045 * The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
4046 */
4047 IngestionId?: ResourceId;
4048 /**
4049 * The AWS request ID for this operation.
4050 */
4051 RequestId?: String;
4052 /**
4053 * The HTTP status of the request.
4054 */
4055 Status?: StatusCode;
4056 }
4057 export interface UpdateDataSourcePermissionsRequest {
4058 /**
4059 * The AWS account ID.
4060 */
4061 AwsAccountId: AwsAccountId;
4062 /**
4063 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
4064 */
4065 DataSourceId: ResourceId;
4066 /**
4067 * A list of resource permissions that you want to grant on the data source.
4068 */
4069 GrantPermissions?: ResourcePermissionList;
4070 /**
4071 * A list of resource permissions that you want to revoke on the data source.
4072 */
4073 RevokePermissions?: ResourcePermissionList;
4074 }
4075 export interface UpdateDataSourcePermissionsResponse {
4076 /**
4077 * The Amazon Resource Name (ARN) of the data source.
4078 */
4079 DataSourceArn?: Arn;
4080 /**
4081 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
4082 */
4083 DataSourceId?: ResourceId;
4084 /**
4085 * The AWS request ID for this operation.
4086 */
4087 RequestId?: String;
4088 /**
4089 * The HTTP status of the request.
4090 */
4091 Status?: StatusCode;
4092 }
4093 export interface UpdateDataSourceRequest {
4094 /**
4095 * The AWS account ID.
4096 */
4097 AwsAccountId: AwsAccountId;
4098 /**
4099 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
4100 */
4101 DataSourceId: ResourceId;
4102 /**
4103 * A display name for the data source.
4104 */
4105 Name: ResourceName;
4106 /**
4107 * The parameters that QuickSight uses to connect to your underlying source.
4108 */
4109 DataSourceParameters?: DataSourceParameters;
4110 /**
4111 * The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
4112 */
4113 Credentials?: DataSourceCredentials;
4114 /**
4115 * Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
4116 */
4117 VpcConnectionProperties?: VpcConnectionProperties;
4118 /**
4119 * Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
4120 */
4121 SslProperties?: SslProperties;
4122 }
4123 export interface UpdateDataSourceResponse {
4124 /**
4125 * The Amazon Resource Name (ARN) of the data source.
4126 */
4127 Arn?: Arn;
4128 /**
4129 * The ID of the data source. This ID is unique per AWS Region for each AWS account.
4130 */
4131 DataSourceId?: ResourceId;
4132 /**
4133 * The update status of the data source's last update.
4134 */
4135 UpdateStatus?: ResourceStatus;
4136 /**
4137 * The AWS request ID for this operation.
4138 */
4139 RequestId?: String;
4140 /**
4141 * The HTTP status of the request.
4142 */
4143 Status?: StatusCode;
4144 }
4145 export interface UpdateGroupRequest {
4146 /**
4147 * The name of the group that you want to update.
4148 */
4149 GroupName: GroupName;
4150 /**
4151 * The description for the group that you want to update.
4152 */
4153 Description?: GroupDescription;
4154 /**
4155 * The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
4156 */
4157 AwsAccountId: AwsAccountId;
4158 /**
4159 * The namespace. Currently, you should set this to default.
4160 */
4161 Namespace: Namespace;
4162 }
4163 export interface UpdateGroupResponse {
4164 /**
4165 * The name of the group.
4166 */
4167 Group?: Group;
4168 /**
4169 * The AWS request ID for this operation.
4170 */
4171 RequestId?: String;
4172 /**
4173 * The HTTP status of the request.
4174 */
4175 Status?: StatusCode;
4176 }
4177 export interface UpdateIAMPolicyAssignmentRequest {
4178 /**
4179 * The ID of the AWS account that contains the IAM policy assignment.
4180 */
4181 AwsAccountId: AwsAccountId;
4182 /**
4183 * The name of the assignment. This name must be unique within an AWS account.
4184 */
4185 AssignmentName: IAMPolicyAssignmentName;
4186 /**
4187 * The namespace of the assignment.
4188 */
4189 Namespace: Namespace;
4190 /**
4191 * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
4192 */
4193 AssignmentStatus?: AssignmentStatus;
4194 /**
4195 * The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
4196 */
4197 PolicyArn?: Arn;
4198 /**
4199 * The QuickSight users, groups, or both that you want to assign the policy to.
4200 */
4201 Identities?: IdentityMap;
4202 }
4203 export interface UpdateIAMPolicyAssignmentResponse {
4204 /**
4205 * The name of the assignment.
4206 */
4207 AssignmentName?: IAMPolicyAssignmentName;
4208 /**
4209 * The ID of the assignment.
4210 */
4211 AssignmentId?: String;
4212 /**
4213 * The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.
4214 */
4215 PolicyArn?: Arn;
4216 /**
4217 * The QuickSight users, groups, or both that the IAM policy is assigned to.
4218 */
4219 Identities?: IdentityMap;
4220 /**
4221 * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
4222 */
4223 AssignmentStatus?: AssignmentStatus;
4224 /**
4225 * The AWS request ID for this operation.
4226 */
4227 RequestId?: String;
4228 /**
4229 * The HTTP status of the request.
4230 */
4231 Status?: StatusCode;
4232 }
4233 export type UpdateResourcePermissionList = ResourcePermission[];
4234 export interface UpdateTemplateAliasRequest {
4235 /**
4236 * The ID of the AWS account that contains the template alias that you're updating.
4237 */
4238 AwsAccountId: AwsAccountId;
4239 /**
4240 * The ID for the template.
4241 */
4242 TemplateId: RestrictiveResourceId;
4243 /**
4244 * The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
4245 */
4246 AliasName: AliasName;
4247 /**
4248 * The version number of the template.
4249 */
4250 TemplateVersionNumber: VersionNumber;
4251 }
4252 export interface UpdateTemplateAliasResponse {
4253 /**
4254 * The template alias.
4255 */
4256 TemplateAlias?: TemplateAlias;
4257 /**
4258 * The HTTP status of the request.
4259 */
4260 Status?: StatusCode;
4261 /**
4262 * The AWS request ID for this operation.
4263 */
4264 RequestId?: String;
4265 }
4266 export interface UpdateTemplatePermissionsRequest {
4267 /**
4268 * The ID of the AWS account that contains the template.
4269 */
4270 AwsAccountId: AwsAccountId;
4271 /**
4272 * The ID for the template.
4273 */
4274 TemplateId: RestrictiveResourceId;
4275 /**
4276 * A list of resource permissions to be granted on the template.
4277 */
4278 GrantPermissions?: UpdateResourcePermissionList;
4279 /**
4280 * A list of resource permissions to be revoked from the template.
4281 */
4282 RevokePermissions?: UpdateResourcePermissionList;
4283 }
4284 export interface UpdateTemplatePermissionsResponse {
4285 /**
4286 * The ID for the template.
4287 */
4288 TemplateId?: RestrictiveResourceId;
4289 /**
4290 * The Amazon Resource Name (ARN) of the template.
4291 */
4292 TemplateArn?: Arn;
4293 /**
4294 * A list of resource permissions to be set on the template.
4295 */
4296 Permissions?: ResourcePermissionList;
4297 /**
4298 * The AWS request ID for this operation.
4299 */
4300 RequestId?: String;
4301 /**
4302 * The HTTP status of the request.
4303 */
4304 Status?: StatusCode;
4305 }
4306 export interface UpdateTemplateRequest {
4307 /**
4308 * The ID of the AWS account that contains the template that you're updating.
4309 */
4310 AwsAccountId: AwsAccountId;
4311 /**
4312 * The ID for the template.
4313 */
4314 TemplateId: RestrictiveResourceId;
4315 /**
4316 * The source QuickSight entity from which this template is being updated. You can currently update templates from an Analysis or another template.
4317 */
4318 SourceEntity: TemplateSourceEntity;
4319 /**
4320 * A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
4321 */
4322 VersionDescription?: VersionDescription;
4323 /**
4324 * The name for the template.
4325 */
4326 Name?: TemplateName;
4327 }
4328 export interface UpdateTemplateResponse {
4329 /**
4330 * The ID for the template.
4331 */
4332 TemplateId?: RestrictiveResourceId;
4333 /**
4334 * The Amazon Resource Name (ARN) for the template.
4335 */
4336 Arn?: Arn;
4337 /**
4338 * The ARN for the template, including the version information of the first version.
4339 */
4340 VersionArn?: Arn;
4341 /**
4342 * The creation status of the template.
4343 */
4344 CreationStatus?: ResourceStatus;
4345 /**
4346 * The HTTP status of the request.
4347 */
4348 Status?: StatusCode;
4349 /**
4350 * The AWS request ID for this operation.
4351 */
4352 RequestId?: String;
4353 }
4354 export interface UpdateUserRequest {
4355 /**
4356 * The Amazon QuickSight user name that you want to update.
4357 */
4358 UserName: UserName;
4359 /**
4360 * The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
4361 */
4362 AwsAccountId: AwsAccountId;
4363 /**
4364 * The namespace. Currently, you should set this to default.
4365 */
4366 Namespace: Namespace;
4367 /**
4368 * The email address of the user that you want to update.
4369 */
4370 Email: String;
4371 /**
4372 * The Amazon QuickSight role of the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
4373 */
4374 Role: UserRole;
4375 }
4376 export interface UpdateUserResponse {
4377 /**
4378 * The Amazon QuickSight user.
4379 */
4380 User?: User;
4381 /**
4382 * The AWS request ID for this operation.
4383 */
4384 RequestId?: String;
4385 /**
4386 * The HTTP status of the request.
4387 */
4388 Status?: StatusCode;
4389 }
4390 export interface UploadSettings {
4391 /**
4392 * File format.
4393 */
4394 Format?: FileFormat;
4395 /**
4396 * A row number to start reading data from.
4397 */
4398 StartFromRow?: PositiveInteger;
4399 /**
4400 * Whether the file has a header row, or the files each have a header row.
4401 */
4402 ContainsHeader?: Boolean;
4403 /**
4404 * Text qualifier.
4405 */
4406 TextQualifier?: TextQualifier;
4407 /**
4408 * The delimiter between values in the file.
4409 */
4410 Delimiter?: Delimiter;
4411 }
4412 export interface User {
4413 /**
4414 * The Amazon Resource Name (ARN) for the user.
4415 */
4416 Arn?: Arn;
4417 /**
4418 * The user's user name.
4419 */
4420 UserName?: UserName;
4421 /**
4422 * The user's email address.
4423 */
4424 Email?: String;
4425 /**
4426 * The Amazon QuickSight role for the user. The user role can be one of the following:. READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This role isn't currently available for use.
4427 */
4428 Role?: UserRole;
4429 /**
4430 * The type of identity authentication used by the user.
4431 */
4432 IdentityType?: IdentityType;
4433 /**
4434 * The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
4435 */
4436 Active?: Boolean;
4437 /**
4438 * The principal ID of the user.
4439 */
4440 PrincipalId?: String;
4441 }
4442 export type UserList = User[];
4443 export type UserName = string;
4444 export type UserRole = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|string;
4445 export type Username = string;
4446 export type VersionDescription = string;
4447 export type VersionNumber = number;
4448 export interface VpcConnectionProperties {
4449 /**
4450 * The Amazon Resource Name (ARN) for the VPC connection.
4451 */
4452 VpcConnectionArn: Arn;
4453 }
4454 export type Warehouse = string;
4455 export type WorkGroup = string;
4456 export type long = number;
4457 export type timestamp = Date;
4458 /**
4459 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4460 */
4461 export type apiVersion = "2018-04-01"|"latest"|string;
4462 export interface ClientApiVersions {
4463 /**
4464 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4465 */
4466 apiVersion?: apiVersion;
4467 }
4468 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
4469 /**
4470 * Contains interfaces for use with the QuickSight client.
4471 */
4472 export import Types = QuickSight;
4473}
4474export = QuickSight;