aws-sdk 2.583.0 → 2.587.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -1
- package/README.md +1 -1
- package/apis/apigatewayv2-2018-11-29.min.json +632 -201
- package/apis/ebs-2019-11-02.examples.json +5 -0
- package/apis/ebs-2019-11-02.min.json +195 -0
- package/apis/ebs-2019-11-02.paginators.json +14 -0
- package/apis/kafka-2018-11-14.min.json +170 -34
- package/apis/kendra-2019-02-03.min.json +2 -1
- package/apis/kinesis-video-signaling-2019-12-04.examples.json +5 -0
- package/apis/kinesis-video-signaling-2019-12-04.min.json +79 -0
- package/apis/kinesis-video-signaling-2019-12-04.paginators.json +4 -0
- package/apis/kinesisvideo-2017-09-30.min.json +281 -8
- package/apis/kinesisvideo-2017-09-30.paginators.json +6 -0
- package/apis/lambda-2015-03-31.min.json +217 -25
- package/apis/lambda-2015-03-31.paginators.json +6 -0
- package/apis/metadata.json +8 -0
- package/apis/rds-2014-10-31.min.json +495 -101
- package/apis/rds-2014-10-31.paginators.json +18 -0
- package/apis/rekognition-2016-06-27.min.json +409 -85
- package/apis/rekognition-2016-06-27.paginators.json +12 -0
- package/apis/rekognition-2016-06-27.waiters2.json +45 -0
- package/apis/sagemaker-2017-07-24.min.json +3471 -472
- package/apis/sagemaker-2017-07-24.paginators.json +128 -16
- package/apis/sagemaker-2017-07-24.waiters2.json +30 -0
- package/apis/ssm-2014-11-06.min.json +94 -71
- package/apis/states-2016-11-23.min.json +92 -55
- package/clients/all.d.ts +2 -0
- package/clients/all.js +3 -1
- package/clients/apigatewayv2.d.ts +856 -1161
- package/clients/applicationautoscaling.d.ts +32 -32
- package/clients/browser_default.d.ts +1 -0
- package/clients/browser_default.js +2 -1
- package/clients/ebs.d.ts +211 -0
- package/clients/ebs.js +18 -0
- package/clients/kafka.d.ts +152 -0
- package/clients/kendra.d.ts +7 -3
- package/clients/kinesisvideo.d.ts +312 -1
- package/clients/kinesisvideosignalingchannels.d.ts +121 -0
- package/clients/kinesisvideosignalingchannels.js +18 -0
- package/clients/kms.d.ts +6 -6
- package/clients/lambda.d.ts +199 -2
- package/clients/quicksight.d.ts +223 -223
- package/clients/rds.d.ts +549 -0
- package/clients/rekognition.d.ts +423 -8
- package/clients/rekognition.js +1 -0
- package/clients/sagemaker.d.ts +4588 -610
- package/clients/ssm.d.ts +42 -6
- package/clients/stepfunctions.d.ts +54 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +1182 -1102
- package/dist/aws-sdk.js +2265 -859
- package/dist/aws-sdk.min.js +35 -35
- package/lib/config.d.ts +12 -0
- package/lib/config_service_placeholders.d.ts +4 -0
- package/lib/core.js +1 -1
- package/lib/services/s3.js +5 -4
- package/lib/services/sts.js +2 -4
- package/package.json +1 -1
- package/scripts/region-checker/whitelist.js +5 -5
package/clients/quicksight.d.ts
CHANGED
|
@@ -20,11 +20,11 @@ declare class QuickSight extends Service {
|
|
|
20
20
|
*/
|
|
21
21
|
cancelIngestion(callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API. A dashboard is an entity in QuickSight
|
|
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
24
|
*/
|
|
25
25
|
createDashboard(params: QuickSight.Types.CreateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API. A dashboard is an entity in QuickSight
|
|
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
28
|
*/
|
|
29
29
|
createDashboard(callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
|
|
30
30
|
/**
|
|
@@ -60,11 +60,11 @@ declare class QuickSight extends Service {
|
|
|
60
60
|
*/
|
|
61
61
|
createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Creates an assignment with one specified IAM policy Amazon Resource Name (ARN)
|
|
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
64
|
*/
|
|
65
65
|
createIAMPolicyAssignment(params: QuickSight.Types.CreateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Creates an assignment with one specified IAM policy Amazon Resource Name (ARN)
|
|
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
68
|
*/
|
|
69
69
|
createIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
|
|
70
70
|
/**
|
|
@@ -76,11 +76,11 @@ declare class QuickSight extends Service {
|
|
|
76
76
|
*/
|
|
77
77
|
createIngestion(callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
|
|
78
78
|
/**
|
|
79
|
-
* Creates a template from an existing QuickSight analysis or template.
|
|
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
80
|
*/
|
|
81
81
|
createTemplate(params: QuickSight.Types.CreateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
|
|
82
82
|
/**
|
|
83
|
-
* Creates a template from an existing QuickSight analysis or template.
|
|
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
84
|
*/
|
|
85
85
|
createTemplate(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
|
|
86
86
|
/**
|
|
@@ -132,11 +132,11 @@ declare class QuickSight extends Service {
|
|
|
132
132
|
*/
|
|
133
133
|
deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
|
|
134
134
|
/**
|
|
135
|
-
* Deletes an existing assignment.
|
|
135
|
+
* Deletes an existing IAM policy assignment.
|
|
136
136
|
*/
|
|
137
137
|
deleteIAMPolicyAssignment(params: QuickSight.Types.DeleteIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
|
|
138
138
|
/**
|
|
139
|
-
* Deletes an existing assignment.
|
|
139
|
+
* Deletes an existing IAM policy assignment.
|
|
140
140
|
*/
|
|
141
141
|
deleteIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
|
|
142
142
|
/**
|
|
@@ -148,11 +148,11 @@ declare class QuickSight extends Service {
|
|
|
148
148
|
*/
|
|
149
149
|
deleteTemplate(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
|
|
150
150
|
/**
|
|
151
|
-
*
|
|
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
152
|
*/
|
|
153
153
|
deleteTemplateAlias(params: QuickSight.Types.DeleteTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
|
|
154
154
|
/**
|
|
155
|
-
*
|
|
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
156
|
*/
|
|
157
157
|
deleteTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
|
|
158
158
|
/**
|
|
@@ -180,11 +180,11 @@ declare class QuickSight extends Service {
|
|
|
180
180
|
*/
|
|
181
181
|
describeDashboard(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
|
|
182
182
|
/**
|
|
183
|
-
* Describes read and write permissions
|
|
183
|
+
* Describes read and write permissions for a dashboard.
|
|
184
184
|
*/
|
|
185
185
|
describeDashboardPermissions(params: QuickSight.Types.DescribeDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
|
|
186
186
|
/**
|
|
187
|
-
* Describes read and write permissions
|
|
187
|
+
* Describes read and write permissions for a dashboard.
|
|
188
188
|
*/
|
|
189
189
|
describeDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
|
|
190
190
|
/**
|
|
@@ -228,11 +228,11 @@ declare class QuickSight extends Service {
|
|
|
228
228
|
*/
|
|
229
229
|
describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
|
|
230
230
|
/**
|
|
231
|
-
* Describes an existing
|
|
231
|
+
* Describes an existing IAM policy assignment, as specified by the assignment name.
|
|
232
232
|
*/
|
|
233
233
|
describeIAMPolicyAssignment(params: QuickSight.Types.DescribeIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
|
|
234
234
|
/**
|
|
235
|
-
* Describes an existing
|
|
235
|
+
* Describes an existing IAM policy assignment, as specified by the assignment name.
|
|
236
236
|
*/
|
|
237
237
|
describeIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
|
|
238
238
|
/**
|
|
@@ -252,11 +252,11 @@ declare class QuickSight extends Service {
|
|
|
252
252
|
*/
|
|
253
253
|
describeTemplate(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
|
|
254
254
|
/**
|
|
255
|
-
* Describes the template
|
|
255
|
+
* Describes the template alias for a template.
|
|
256
256
|
*/
|
|
257
257
|
describeTemplateAlias(params: QuickSight.Types.DescribeTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
|
|
258
258
|
/**
|
|
259
|
-
* Describes the template
|
|
259
|
+
* Describes the template alias for a template.
|
|
260
260
|
*/
|
|
261
261
|
describeTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
|
|
262
262
|
/**
|
|
@@ -276,35 +276,35 @@ declare class QuickSight extends Service {
|
|
|
276
276
|
*/
|
|
277
277
|
describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
|
|
278
278
|
/**
|
|
279
|
-
* Generates a server-side embeddable URL and authorization code.
|
|
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
280
|
*/
|
|
281
281
|
getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
|
|
282
282
|
/**
|
|
283
|
-
* Generates a server-side embeddable URL and authorization code.
|
|
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
284
|
*/
|
|
285
285
|
getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
|
|
286
286
|
/**
|
|
287
|
-
* Lists all the versions of the dashboards in the
|
|
287
|
+
* Lists all the versions of the dashboards in the QuickSight subscription.
|
|
288
288
|
*/
|
|
289
289
|
listDashboardVersions(params: QuickSight.Types.ListDashboardVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
|
|
290
290
|
/**
|
|
291
|
-
* Lists all the versions of the dashboards in the
|
|
291
|
+
* Lists all the versions of the dashboards in the QuickSight subscription.
|
|
292
292
|
*/
|
|
293
293
|
listDashboardVersions(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
|
|
294
294
|
/**
|
|
295
|
-
* Lists dashboards in
|
|
295
|
+
* Lists dashboards in an AWS account.
|
|
296
296
|
*/
|
|
297
297
|
listDashboards(params: QuickSight.Types.ListDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
|
|
298
298
|
/**
|
|
299
|
-
* Lists dashboards in
|
|
299
|
+
* Lists dashboards in an AWS account.
|
|
300
300
|
*/
|
|
301
301
|
listDashboards(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
|
|
302
302
|
/**
|
|
303
|
-
* Lists all of the datasets belonging to
|
|
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
304
|
*/
|
|
305
305
|
listDataSets(params: QuickSight.Types.ListDataSetsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
|
|
306
306
|
/**
|
|
307
|
-
* Lists all of the datasets belonging to
|
|
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
308
|
*/
|
|
309
309
|
listDataSets(callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
|
|
310
310
|
/**
|
|
@@ -332,19 +332,19 @@ declare class QuickSight extends Service {
|
|
|
332
332
|
*/
|
|
333
333
|
listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
|
|
334
334
|
/**
|
|
335
|
-
* Lists assignments in current QuickSight account.
|
|
335
|
+
* Lists IAM policy assignments in the current Amazon QuickSight account.
|
|
336
336
|
*/
|
|
337
337
|
listIAMPolicyAssignments(params: QuickSight.Types.ListIAMPolicyAssignmentsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
|
|
338
338
|
/**
|
|
339
|
-
* Lists assignments in current QuickSight account.
|
|
339
|
+
* Lists IAM policy assignments in the current Amazon QuickSight account.
|
|
340
340
|
*/
|
|
341
341
|
listIAMPolicyAssignments(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
|
|
342
342
|
/**
|
|
343
|
-
* Lists all the assignments
|
|
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
344
|
*/
|
|
345
345
|
listIAMPolicyAssignmentsForUser(params: QuickSight.Types.ListIAMPolicyAssignmentsForUserRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
|
|
346
346
|
/**
|
|
347
|
-
* Lists all the assignments
|
|
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
348
|
*/
|
|
349
349
|
listIAMPolicyAssignmentsForUser(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
|
|
350
350
|
/**
|
|
@@ -372,19 +372,19 @@ declare class QuickSight extends Service {
|
|
|
372
372
|
*/
|
|
373
373
|
listTemplateAliases(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
|
|
374
374
|
/**
|
|
375
|
-
* Lists all the versions of the templates in the
|
|
375
|
+
* Lists all the versions of the templates in the current Amazon QuickSight account.
|
|
376
376
|
*/
|
|
377
377
|
listTemplateVersions(params: QuickSight.Types.ListTemplateVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
|
|
378
378
|
/**
|
|
379
|
-
* Lists all the versions of the templates in the
|
|
379
|
+
* Lists all the versions of the templates in the current Amazon QuickSight account.
|
|
380
380
|
*/
|
|
381
381
|
listTemplateVersions(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
|
|
382
382
|
/**
|
|
383
|
-
* Lists all the templates in the QuickSight account.
|
|
383
|
+
* Lists all the templates in the current Amazon QuickSight account.
|
|
384
384
|
*/
|
|
385
385
|
listTemplates(params: QuickSight.Types.ListTemplatesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
|
|
386
386
|
/**
|
|
387
|
-
* Lists all the templates in the QuickSight account.
|
|
387
|
+
* Lists all the templates in the current Amazon QuickSight account.
|
|
388
388
|
*/
|
|
389
389
|
listTemplates(callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
|
|
390
390
|
/**
|
|
@@ -428,11 +428,11 @@ declare class QuickSight extends Service {
|
|
|
428
428
|
*/
|
|
429
429
|
untagResource(callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
|
|
430
430
|
/**
|
|
431
|
-
* Updates a dashboard in
|
|
431
|
+
* Updates a dashboard in an AWS account.
|
|
432
432
|
*/
|
|
433
433
|
updateDashboard(params: QuickSight.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
|
|
434
434
|
/**
|
|
435
|
-
* Updates a dashboard in
|
|
435
|
+
* Updates a dashboard in an AWS account.
|
|
436
436
|
*/
|
|
437
437
|
updateDashboard(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
|
|
438
438
|
/**
|
|
@@ -492,19 +492,19 @@ declare class QuickSight extends Service {
|
|
|
492
492
|
*/
|
|
493
493
|
updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
|
|
494
494
|
/**
|
|
495
|
-
* Updates an existing assignment. This operation updates only the optional parameter or parameters that are specified in the request.
|
|
495
|
+
* Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
|
|
496
496
|
*/
|
|
497
497
|
updateIAMPolicyAssignment(params: QuickSight.Types.UpdateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
|
|
498
498
|
/**
|
|
499
|
-
* Updates an existing assignment. This operation updates only the optional parameter or parameters that are specified in the request.
|
|
499
|
+
* Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
|
|
500
500
|
*/
|
|
501
501
|
updateIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
|
|
502
502
|
/**
|
|
503
|
-
* Updates a template from an existing QuickSight analysis.
|
|
503
|
+
* Updates a template from an existing Amazon QuickSight analysis or another template.
|
|
504
504
|
*/
|
|
505
505
|
updateTemplate(params: QuickSight.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
|
|
506
506
|
/**
|
|
507
|
-
* Updates a template from an existing QuickSight analysis.
|
|
507
|
+
* Updates a template from an existing Amazon QuickSight analysis or another template.
|
|
508
508
|
*/
|
|
509
509
|
updateTemplate(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
|
|
510
510
|
/**
|
|
@@ -516,11 +516,11 @@ declare class QuickSight extends Service {
|
|
|
516
516
|
*/
|
|
517
517
|
updateTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
|
|
518
518
|
/**
|
|
519
|
-
* Updates the permissions
|
|
519
|
+
* Updates the resource permissions for a template.
|
|
520
520
|
*/
|
|
521
521
|
updateTemplatePermissions(params: QuickSight.Types.UpdateTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
|
|
522
522
|
/**
|
|
523
|
-
* Updates the permissions
|
|
523
|
+
* Updates the resource permissions for a template.
|
|
524
524
|
*/
|
|
525
525
|
updateTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
|
|
526
526
|
/**
|
|
@@ -608,7 +608,7 @@ declare namespace QuickSight {
|
|
|
608
608
|
*/
|
|
609
609
|
ColumnName: ColumnName;
|
|
610
610
|
/**
|
|
611
|
-
* A unique ID to identify a calculated column. During dataset update, if the column ID of a calculated column matches that of an existing calculated column, QuickSight preserves the existing calculated column.
|
|
611
|
+
* 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.
|
|
612
612
|
*/
|
|
613
613
|
ColumnId: ColumnId;
|
|
614
614
|
/**
|
|
@@ -659,7 +659,7 @@ declare namespace QuickSight {
|
|
|
659
659
|
*/
|
|
660
660
|
NewColumnType: ColumnDataType;
|
|
661
661
|
/**
|
|
662
|
-
* When casting a column from string to datetime type, you can supply a
|
|
662
|
+
* 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.
|
|
663
663
|
*/
|
|
664
664
|
Format?: TypeCastFormat;
|
|
665
665
|
}
|
|
@@ -687,7 +687,7 @@ declare namespace QuickSight {
|
|
|
687
687
|
*/
|
|
688
688
|
Name?: String;
|
|
689
689
|
/**
|
|
690
|
-
* A structure containing the list of column group
|
|
690
|
+
* A structure containing the list of schemas for column group columns.
|
|
691
691
|
*/
|
|
692
692
|
ColumnGroupColumnSchemaList?: ColumnGroupColumnSchemaList;
|
|
693
693
|
}
|
|
@@ -725,11 +725,11 @@ declare namespace QuickSight {
|
|
|
725
725
|
}
|
|
726
726
|
export interface CreateDashboardRequest {
|
|
727
727
|
/**
|
|
728
|
-
* AWS account
|
|
728
|
+
* The ID of the AWS account where you want to create the dashboard.
|
|
729
729
|
*/
|
|
730
730
|
AwsAccountId: AwsAccountId;
|
|
731
731
|
/**
|
|
732
|
-
* The ID for the dashboard, also added to IAM policy.
|
|
732
|
+
* The ID for the dashboard, also added to the IAM policy.
|
|
733
733
|
*/
|
|
734
734
|
DashboardId: RestrictiveResourceId;
|
|
735
735
|
/**
|
|
@@ -737,15 +737,15 @@ declare namespace QuickSight {
|
|
|
737
737
|
*/
|
|
738
738
|
Name: DashboardName;
|
|
739
739
|
/**
|
|
740
|
-
* 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
|
|
740
|
+
* 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.
|
|
741
741
|
*/
|
|
742
742
|
Parameters?: Parameters;
|
|
743
743
|
/**
|
|
744
|
-
* A structure that contains the permissions of the dashboard. You can use this for granting permissions with principal and action information.
|
|
744
|
+
* A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
|
|
745
745
|
*/
|
|
746
746
|
Permissions?: ResourcePermissionList;
|
|
747
747
|
/**
|
|
748
|
-
*
|
|
748
|
+
* 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.
|
|
749
749
|
*/
|
|
750
750
|
SourceEntity: DashboardSourceEntity;
|
|
751
751
|
/**
|
|
@@ -757,7 +757,7 @@ declare namespace QuickSight {
|
|
|
757
757
|
*/
|
|
758
758
|
VersionDescription?: VersionDescription;
|
|
759
759
|
/**
|
|
760
|
-
*
|
|
760
|
+
* 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.
|
|
761
761
|
*/
|
|
762
762
|
DashboardPublishOptions?: DashboardPublishOptions;
|
|
763
763
|
}
|
|
@@ -775,7 +775,7 @@ declare namespace QuickSight {
|
|
|
775
775
|
*/
|
|
776
776
|
DashboardId?: RestrictiveResourceId;
|
|
777
777
|
/**
|
|
778
|
-
* The
|
|
778
|
+
* The status of the dashboard creation request.
|
|
779
779
|
*/
|
|
780
780
|
CreationStatus?: ResourceStatus;
|
|
781
781
|
/**
|
|
@@ -789,7 +789,7 @@ declare namespace QuickSight {
|
|
|
789
789
|
}
|
|
790
790
|
export interface CreateDataSetRequest {
|
|
791
791
|
/**
|
|
792
|
-
* The AWS
|
|
792
|
+
* The AWS account ID.
|
|
793
793
|
*/
|
|
794
794
|
AwsAccountId: AwsAccountId;
|
|
795
795
|
/**
|
|
@@ -809,7 +809,7 @@ declare namespace QuickSight {
|
|
|
809
809
|
*/
|
|
810
810
|
LogicalTableMap?: LogicalTableMap;
|
|
811
811
|
/**
|
|
812
|
-
* Indicates whether
|
|
812
|
+
* Indicates whether you want to import the data into SPICE.
|
|
813
813
|
*/
|
|
814
814
|
ImportMode: DataSetImportMode;
|
|
815
815
|
/**
|
|
@@ -821,7 +821,7 @@ declare namespace QuickSight {
|
|
|
821
821
|
*/
|
|
822
822
|
Permissions?: ResourcePermissionList;
|
|
823
823
|
/**
|
|
824
|
-
*
|
|
824
|
+
* The row-level security configuration for the data that you want to create.
|
|
825
825
|
*/
|
|
826
826
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
827
827
|
/**
|
|
@@ -839,11 +839,11 @@ declare namespace QuickSight {
|
|
|
839
839
|
*/
|
|
840
840
|
DataSetId?: ResourceId;
|
|
841
841
|
/**
|
|
842
|
-
* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
|
|
842
|
+
* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
|
|
843
843
|
*/
|
|
844
844
|
IngestionArn?: Arn;
|
|
845
845
|
/**
|
|
846
|
-
* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
|
|
846
|
+
* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
|
|
847
847
|
*/
|
|
848
848
|
IngestionId?: ResourceId;
|
|
849
849
|
/**
|
|
@@ -985,7 +985,7 @@ declare namespace QuickSight {
|
|
|
985
985
|
}
|
|
986
986
|
export interface CreateIAMPolicyAssignmentRequest {
|
|
987
987
|
/**
|
|
988
|
-
* The AWS
|
|
988
|
+
* The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
|
|
989
989
|
*/
|
|
990
990
|
AwsAccountId: AwsAccountId;
|
|
991
991
|
/**
|
|
@@ -993,15 +993,15 @@ declare namespace QuickSight {
|
|
|
993
993
|
*/
|
|
994
994
|
AssignmentName: IAMPolicyAssignmentName;
|
|
995
995
|
/**
|
|
996
|
-
* The status of
|
|
996
|
+
* 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.
|
|
997
997
|
*/
|
|
998
998
|
AssignmentStatus: AssignmentStatus;
|
|
999
999
|
/**
|
|
1000
|
-
*
|
|
1000
|
+
* The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
|
|
1001
1001
|
*/
|
|
1002
1002
|
PolicyArn?: Arn;
|
|
1003
1003
|
/**
|
|
1004
|
-
* QuickSight users
|
|
1004
|
+
* The QuickSight users, groups, or both that you want to assign the policy to.
|
|
1005
1005
|
*/
|
|
1006
1006
|
Identities?: IdentityMap;
|
|
1007
1007
|
/**
|
|
@@ -1011,23 +1011,23 @@ declare namespace QuickSight {
|
|
|
1011
1011
|
}
|
|
1012
1012
|
export interface CreateIAMPolicyAssignmentResponse {
|
|
1013
1013
|
/**
|
|
1014
|
-
* The name of the assignment.
|
|
1014
|
+
* The name of the assignment. This name must be unique within the AWS account.
|
|
1015
1015
|
*/
|
|
1016
1016
|
AssignmentName?: IAMPolicyAssignmentName;
|
|
1017
1017
|
/**
|
|
1018
|
-
*
|
|
1018
|
+
* The ID for the assignment.
|
|
1019
1019
|
*/
|
|
1020
1020
|
AssignmentId?: String;
|
|
1021
1021
|
/**
|
|
1022
|
-
* The status of
|
|
1022
|
+
* 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.
|
|
1023
1023
|
*/
|
|
1024
1024
|
AssignmentStatus?: AssignmentStatus;
|
|
1025
1025
|
/**
|
|
1026
|
-
*
|
|
1026
|
+
* The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
|
|
1027
1027
|
*/
|
|
1028
1028
|
PolicyArn?: Arn;
|
|
1029
1029
|
/**
|
|
1030
|
-
* QuickSight users
|
|
1030
|
+
* The QuickSight users, groups, or both that the IAM policy is assigned to.
|
|
1031
1031
|
*/
|
|
1032
1032
|
Identities?: IdentityMap;
|
|
1033
1033
|
/**
|
|
@@ -1077,7 +1077,7 @@ declare namespace QuickSight {
|
|
|
1077
1077
|
}
|
|
1078
1078
|
export interface CreateTemplateAliasRequest {
|
|
1079
1079
|
/**
|
|
1080
|
-
* AWS account
|
|
1080
|
+
* The ID of the AWS account that contains the template that you creating an alias for.
|
|
1081
1081
|
*/
|
|
1082
1082
|
AwsAccountId: AwsAccountId;
|
|
1083
1083
|
/**
|
|
@@ -1085,7 +1085,7 @@ declare namespace QuickSight {
|
|
|
1085
1085
|
*/
|
|
1086
1086
|
TemplateId: RestrictiveResourceId;
|
|
1087
1087
|
/**
|
|
1088
|
-
* The name that you want to give to the template alias that you're creating.
|
|
1088
|
+
* 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.
|
|
1089
1089
|
*/
|
|
1090
1090
|
AliasName: AliasName;
|
|
1091
1091
|
/**
|
|
@@ -1095,7 +1095,7 @@ declare namespace QuickSight {
|
|
|
1095
1095
|
}
|
|
1096
1096
|
export interface CreateTemplateAliasResponse {
|
|
1097
1097
|
/**
|
|
1098
|
-
* Information
|
|
1098
|
+
* Information about the template alias.
|
|
1099
1099
|
*/
|
|
1100
1100
|
TemplateAlias?: TemplateAlias;
|
|
1101
1101
|
/**
|
|
@@ -1113,7 +1113,7 @@ declare namespace QuickSight {
|
|
|
1113
1113
|
*/
|
|
1114
1114
|
AwsAccountId: AwsAccountId;
|
|
1115
1115
|
/**
|
|
1116
|
-
* An ID for the template you want to create. This is unique per AWS
|
|
1116
|
+
* An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
|
|
1117
1117
|
*/
|
|
1118
1118
|
TemplateId: RestrictiveResourceId;
|
|
1119
1119
|
/**
|
|
@@ -1125,7 +1125,7 @@ declare namespace QuickSight {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
Permissions?: ResourcePermissionList;
|
|
1127
1127
|
/**
|
|
1128
|
-
* The Amazon Resource Name (ARN) of the source entity from which this template is being created.
|
|
1128
|
+
* 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.
|
|
1129
1129
|
*/
|
|
1130
1130
|
SourceEntity: TemplateSourceEntity;
|
|
1131
1131
|
/**
|
|
@@ -1133,13 +1133,13 @@ declare namespace QuickSight {
|
|
|
1133
1133
|
*/
|
|
1134
1134
|
Tags?: TagList;
|
|
1135
1135
|
/**
|
|
1136
|
-
* A description of the current template version being created. This API
|
|
1136
|
+
* 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.
|
|
1137
1137
|
*/
|
|
1138
1138
|
VersionDescription?: VersionDescription;
|
|
1139
1139
|
}
|
|
1140
1140
|
export interface CreateTemplateResponse {
|
|
1141
1141
|
/**
|
|
1142
|
-
* The
|
|
1142
|
+
* The ARN for the template.
|
|
1143
1143
|
*/
|
|
1144
1144
|
Arn?: Arn;
|
|
1145
1145
|
/**
|
|
@@ -1165,7 +1165,7 @@ declare namespace QuickSight {
|
|
|
1165
1165
|
}
|
|
1166
1166
|
export interface CredentialPair {
|
|
1167
1167
|
/**
|
|
1168
|
-
*
|
|
1168
|
+
* User name.
|
|
1169
1169
|
*/
|
|
1170
1170
|
Username: Username;
|
|
1171
1171
|
/**
|
|
@@ -1198,7 +1198,7 @@ declare namespace QuickSight {
|
|
|
1198
1198
|
*/
|
|
1199
1199
|
DashboardId?: RestrictiveResourceId;
|
|
1200
1200
|
/**
|
|
1201
|
-
* The Amazon Resource
|
|
1201
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
1202
1202
|
*/
|
|
1203
1203
|
Arn?: Arn;
|
|
1204
1204
|
/**
|
|
@@ -1210,15 +1210,15 @@ declare namespace QuickSight {
|
|
|
1210
1210
|
*/
|
|
1211
1211
|
Version?: DashboardVersion;
|
|
1212
1212
|
/**
|
|
1213
|
-
* The time this was created.
|
|
1213
|
+
* The time that this dataset was created.
|
|
1214
1214
|
*/
|
|
1215
1215
|
CreatedTime?: Timestamp;
|
|
1216
1216
|
/**
|
|
1217
|
-
* The last time this was published.
|
|
1217
|
+
* The last time that this dataset was published.
|
|
1218
1218
|
*/
|
|
1219
1219
|
LastPublishedTime?: Timestamp;
|
|
1220
1220
|
/**
|
|
1221
|
-
* The last time this was updated.
|
|
1221
|
+
* The last time that this dataset was updated.
|
|
1222
1222
|
*/
|
|
1223
1223
|
LastUpdatedTime?: Timestamp;
|
|
1224
1224
|
}
|
|
@@ -1238,11 +1238,11 @@ declare namespace QuickSight {
|
|
|
1238
1238
|
export type DashboardName = string;
|
|
1239
1239
|
export interface DashboardPublishOptions {
|
|
1240
1240
|
/**
|
|
1241
|
-
* Ad hoc filtering option.
|
|
1241
|
+
* Ad hoc (one-time) filtering option.
|
|
1242
1242
|
*/
|
|
1243
1243
|
AdHocFilteringOption?: AdHocFilteringOption;
|
|
1244
1244
|
/**
|
|
1245
|
-
* Export to
|
|
1245
|
+
* Export to .csv option.
|
|
1246
1246
|
*/
|
|
1247
1247
|
ExportToCSVOption?: ExportToCSVOption;
|
|
1248
1248
|
/**
|
|
@@ -1262,13 +1262,13 @@ declare namespace QuickSight {
|
|
|
1262
1262
|
*/
|
|
1263
1263
|
DataSetReferences: DataSetReferenceList;
|
|
1264
1264
|
/**
|
|
1265
|
-
* The Amazon Resource
|
|
1265
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
1266
1266
|
*/
|
|
1267
1267
|
Arn: Arn;
|
|
1268
1268
|
}
|
|
1269
1269
|
export interface DashboardSummary {
|
|
1270
1270
|
/**
|
|
1271
|
-
* The Amazon Resource
|
|
1271
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
1272
1272
|
*/
|
|
1273
1273
|
Arn?: Arn;
|
|
1274
1274
|
/**
|
|
@@ -1276,15 +1276,15 @@ declare namespace QuickSight {
|
|
|
1276
1276
|
*/
|
|
1277
1277
|
DashboardId?: RestrictiveResourceId;
|
|
1278
1278
|
/**
|
|
1279
|
-
* A display name for the
|
|
1279
|
+
* A display name for the dashboard.
|
|
1280
1280
|
*/
|
|
1281
1281
|
Name?: DashboardName;
|
|
1282
1282
|
/**
|
|
1283
|
-
* The time this was created.
|
|
1283
|
+
* The time that this dashboard was created.
|
|
1284
1284
|
*/
|
|
1285
1285
|
CreatedTime?: Timestamp;
|
|
1286
1286
|
/**
|
|
1287
|
-
* The last time this was updated.
|
|
1287
|
+
* The last time that this dashboard was updated.
|
|
1288
1288
|
*/
|
|
1289
1289
|
LastUpdatedTime?: Timestamp;
|
|
1290
1290
|
/**
|
|
@@ -1292,7 +1292,7 @@ declare namespace QuickSight {
|
|
|
1292
1292
|
*/
|
|
1293
1293
|
PublishedVersionNumber?: VersionNumber;
|
|
1294
1294
|
/**
|
|
1295
|
-
* The last time this was published.
|
|
1295
|
+
* The last time that this dashboard was published.
|
|
1296
1296
|
*/
|
|
1297
1297
|
LastPublishedTime?: Timestamp;
|
|
1298
1298
|
}
|
|
@@ -1300,7 +1300,7 @@ declare namespace QuickSight {
|
|
|
1300
1300
|
export type DashboardUIState = "EXPANDED"|"COLLAPSED"|string;
|
|
1301
1301
|
export interface DashboardVersion {
|
|
1302
1302
|
/**
|
|
1303
|
-
* The time this was created.
|
|
1303
|
+
* The time that this dashboard version was created.
|
|
1304
1304
|
*/
|
|
1305
1305
|
CreatedTime?: Timestamp;
|
|
1306
1306
|
/**
|
|
@@ -1316,7 +1316,7 @@ declare namespace QuickSight {
|
|
|
1316
1316
|
*/
|
|
1317
1317
|
Status?: ResourceStatus;
|
|
1318
1318
|
/**
|
|
1319
|
-
* The Amazon Resource
|
|
1319
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
1320
1320
|
*/
|
|
1321
1321
|
Arn?: Arn;
|
|
1322
1322
|
/**
|
|
@@ -1330,11 +1330,11 @@ declare namespace QuickSight {
|
|
|
1330
1330
|
}
|
|
1331
1331
|
export interface DashboardVersionSummary {
|
|
1332
1332
|
/**
|
|
1333
|
-
* The Amazon Resource
|
|
1333
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
1334
1334
|
*/
|
|
1335
1335
|
Arn?: Arn;
|
|
1336
1336
|
/**
|
|
1337
|
-
* The time this was created.
|
|
1337
|
+
* The time that this dashboard version was created.
|
|
1338
1338
|
*/
|
|
1339
1339
|
CreatedTime?: Timestamp;
|
|
1340
1340
|
/**
|
|
@@ -1357,7 +1357,7 @@ declare namespace QuickSight {
|
|
|
1357
1357
|
export type DashboardVersionSummaryList = DashboardVersionSummary[];
|
|
1358
1358
|
export interface DataSet {
|
|
1359
1359
|
/**
|
|
1360
|
-
* The Amazon Resource
|
|
1360
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
1361
1361
|
*/
|
|
1362
1362
|
Arn?: Arn;
|
|
1363
1363
|
/**
|
|
@@ -1369,11 +1369,11 @@ declare namespace QuickSight {
|
|
|
1369
1369
|
*/
|
|
1370
1370
|
Name?: ResourceName;
|
|
1371
1371
|
/**
|
|
1372
|
-
* The time this was created.
|
|
1372
|
+
* The time that this dataset was created.
|
|
1373
1373
|
*/
|
|
1374
1374
|
CreatedTime?: Timestamp;
|
|
1375
1375
|
/**
|
|
1376
|
-
* The last time this was updated.
|
|
1376
|
+
* The last time that this dataset was updated.
|
|
1377
1377
|
*/
|
|
1378
1378
|
LastUpdatedTime?: Timestamp;
|
|
1379
1379
|
/**
|
|
@@ -1389,7 +1389,7 @@ declare namespace QuickSight {
|
|
|
1389
1389
|
*/
|
|
1390
1390
|
OutputColumns?: OutputColumnList;
|
|
1391
1391
|
/**
|
|
1392
|
-
* Indicates whether
|
|
1392
|
+
* Indicates whether you want to import the data into SPICE.
|
|
1393
1393
|
*/
|
|
1394
1394
|
ImportMode?: DataSetImportMode;
|
|
1395
1395
|
/**
|
|
@@ -1397,11 +1397,11 @@ declare namespace QuickSight {
|
|
|
1397
1397
|
*/
|
|
1398
1398
|
ConsumedSpiceCapacityInBytes?: Long;
|
|
1399
1399
|
/**
|
|
1400
|
-
* Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
|
|
1400
|
+
* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
|
|
1401
1401
|
*/
|
|
1402
1402
|
ColumnGroups?: ColumnGroupList;
|
|
1403
1403
|
/**
|
|
1404
|
-
*
|
|
1404
|
+
* The row-level security configuration for the dataset.
|
|
1405
1405
|
*/
|
|
1406
1406
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
1407
1407
|
}
|
|
@@ -1428,7 +1428,7 @@ declare namespace QuickSight {
|
|
|
1428
1428
|
*/
|
|
1429
1429
|
DataSetPlaceholder: NonEmptyString;
|
|
1430
1430
|
/**
|
|
1431
|
-
* Dataset ARN.
|
|
1431
|
+
* Dataset Amazon Resource Name (ARN).
|
|
1432
1432
|
*/
|
|
1433
1433
|
DataSetArn: Arn;
|
|
1434
1434
|
}
|
|
@@ -1441,7 +1441,7 @@ declare namespace QuickSight {
|
|
|
1441
1441
|
}
|
|
1442
1442
|
export interface DataSetSummary {
|
|
1443
1443
|
/**
|
|
1444
|
-
* The Amazon Resource
|
|
1444
|
+
* The Amazon Resource Name (ARN) of the dataset.
|
|
1445
1445
|
*/
|
|
1446
1446
|
Arn?: Arn;
|
|
1447
1447
|
/**
|
|
@@ -1453,26 +1453,26 @@ declare namespace QuickSight {
|
|
|
1453
1453
|
*/
|
|
1454
1454
|
Name?: ResourceName;
|
|
1455
1455
|
/**
|
|
1456
|
-
* The time this was created.
|
|
1456
|
+
* The time that this dataset was created.
|
|
1457
1457
|
*/
|
|
1458
1458
|
CreatedTime?: Timestamp;
|
|
1459
1459
|
/**
|
|
1460
|
-
* The last time this was updated.
|
|
1460
|
+
* The last time that this dataset was updated.
|
|
1461
1461
|
*/
|
|
1462
1462
|
LastUpdatedTime?: Timestamp;
|
|
1463
1463
|
/**
|
|
1464
|
-
* Indicates whether
|
|
1464
|
+
* Indicates whether you want to import the data into SPICE.
|
|
1465
1465
|
*/
|
|
1466
1466
|
ImportMode?: DataSetImportMode;
|
|
1467
1467
|
/**
|
|
1468
|
-
*
|
|
1468
|
+
* The row-level security configuration for the dataset.
|
|
1469
1469
|
*/
|
|
1470
1470
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
1471
1471
|
}
|
|
1472
1472
|
export type DataSetSummaryList = DataSetSummary[];
|
|
1473
1473
|
export interface DataSource {
|
|
1474
1474
|
/**
|
|
1475
|
-
* The Amazon Resource
|
|
1475
|
+
* The Amazon Resource Name (ARN) of the data source.
|
|
1476
1476
|
*/
|
|
1477
1477
|
Arn?: Arn;
|
|
1478
1478
|
/**
|
|
@@ -1484,7 +1484,7 @@ declare namespace QuickSight {
|
|
|
1484
1484
|
*/
|
|
1485
1485
|
Name?: ResourceName;
|
|
1486
1486
|
/**
|
|
1487
|
-
* The type of the data source. This indicates which database engine the data source connects to.
|
|
1487
|
+
* The type of the data source. This type indicates which database engine the data source connects to.
|
|
1488
1488
|
*/
|
|
1489
1489
|
Type?: DataSourceType;
|
|
1490
1490
|
/**
|
|
@@ -1492,15 +1492,15 @@ declare namespace QuickSight {
|
|
|
1492
1492
|
*/
|
|
1493
1493
|
Status?: ResourceStatus;
|
|
1494
1494
|
/**
|
|
1495
|
-
* The time this was created.
|
|
1495
|
+
* The time that this data source was created.
|
|
1496
1496
|
*/
|
|
1497
1497
|
CreatedTime?: Timestamp;
|
|
1498
1498
|
/**
|
|
1499
|
-
* The last time this was updated.
|
|
1499
|
+
* The last time that this data source was updated.
|
|
1500
1500
|
*/
|
|
1501
1501
|
LastUpdatedTime?: Timestamp;
|
|
1502
1502
|
/**
|
|
1503
|
-
* The parameters that QuickSight uses to connect to your underlying source. This is a variant type structure.
|
|
1503
|
+
* 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.
|
|
1504
1504
|
*/
|
|
1505
1505
|
DataSourceParameters?: DataSourceParameters;
|
|
1506
1506
|
/**
|
|
@@ -1536,15 +1536,15 @@ declare namespace QuickSight {
|
|
|
1536
1536
|
export type DataSourceList = DataSource[];
|
|
1537
1537
|
export interface DataSourceParameters {
|
|
1538
1538
|
/**
|
|
1539
|
-
* Amazon Elasticsearch parameters.
|
|
1539
|
+
* Amazon Elasticsearch Service parameters.
|
|
1540
1540
|
*/
|
|
1541
1541
|
AmazonElasticsearchParameters?: AmazonElasticsearchParameters;
|
|
1542
1542
|
/**
|
|
1543
|
-
* Athena parameters.
|
|
1543
|
+
* Amazon Athena parameters.
|
|
1544
1544
|
*/
|
|
1545
1545
|
AthenaParameters?: AthenaParameters;
|
|
1546
1546
|
/**
|
|
1547
|
-
* Aurora MySQL parameters.
|
|
1547
|
+
* Amazon Aurora MySQL parameters.
|
|
1548
1548
|
*/
|
|
1549
1549
|
AuroraParameters?: AuroraParameters;
|
|
1550
1550
|
/**
|
|
@@ -1576,11 +1576,11 @@ declare namespace QuickSight {
|
|
|
1576
1576
|
*/
|
|
1577
1577
|
PrestoParameters?: PrestoParameters;
|
|
1578
1578
|
/**
|
|
1579
|
-
* RDS parameters.
|
|
1579
|
+
* Amazon RDS parameters.
|
|
1580
1580
|
*/
|
|
1581
1581
|
RdsParameters?: RdsParameters;
|
|
1582
1582
|
/**
|
|
1583
|
-
* Redshift parameters.
|
|
1583
|
+
* Amazon Redshift parameters.
|
|
1584
1584
|
*/
|
|
1585
1585
|
RedshiftParameters?: RedshiftParameters;
|
|
1586
1586
|
/**
|
|
@@ -1638,7 +1638,7 @@ declare namespace QuickSight {
|
|
|
1638
1638
|
export type DecimalParameterList = DecimalParameter[];
|
|
1639
1639
|
export interface DeleteDashboardRequest {
|
|
1640
1640
|
/**
|
|
1641
|
-
* AWS account
|
|
1641
|
+
* The ID of the AWS account that contains the dashboard that you're deleting.
|
|
1642
1642
|
*/
|
|
1643
1643
|
AwsAccountId: AwsAccountId;
|
|
1644
1644
|
/**
|
|
@@ -1646,7 +1646,7 @@ declare namespace QuickSight {
|
|
|
1646
1646
|
*/
|
|
1647
1647
|
DashboardId: RestrictiveResourceId;
|
|
1648
1648
|
/**
|
|
1649
|
-
* The version number of the dashboard. If version number property is provided, only the specified version of the dashboard is deleted.
|
|
1649
|
+
* The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
|
|
1650
1650
|
*/
|
|
1651
1651
|
VersionNumber?: VersionNumber;
|
|
1652
1652
|
}
|
|
@@ -1656,7 +1656,7 @@ declare namespace QuickSight {
|
|
|
1656
1656
|
*/
|
|
1657
1657
|
Status?: StatusCode;
|
|
1658
1658
|
/**
|
|
1659
|
-
* The Secure Socket Layer (SSL) properties that apply
|
|
1659
|
+
* The Secure Socket Layer (SSL) properties that apply for the resource.
|
|
1660
1660
|
*/
|
|
1661
1661
|
Arn?: Arn;
|
|
1662
1662
|
/**
|
|
@@ -1778,7 +1778,7 @@ declare namespace QuickSight {
|
|
|
1778
1778
|
}
|
|
1779
1779
|
export interface DeleteIAMPolicyAssignmentRequest {
|
|
1780
1780
|
/**
|
|
1781
|
-
* The AWS account ID where you want to delete
|
|
1781
|
+
* The AWS account ID where you want to delete the IAM policy assignment.
|
|
1782
1782
|
*/
|
|
1783
1783
|
AwsAccountId: AwsAccountId;
|
|
1784
1784
|
/**
|
|
@@ -1806,15 +1806,15 @@ declare namespace QuickSight {
|
|
|
1806
1806
|
}
|
|
1807
1807
|
export interface DeleteTemplateAliasRequest {
|
|
1808
1808
|
/**
|
|
1809
|
-
* AWS account
|
|
1809
|
+
* The ID of the AWS account that contains the item to delete.
|
|
1810
1810
|
*/
|
|
1811
1811
|
AwsAccountId: AwsAccountId;
|
|
1812
1812
|
/**
|
|
1813
|
-
*
|
|
1813
|
+
* The ID for the template that the specified alias is for.
|
|
1814
1814
|
*/
|
|
1815
1815
|
TemplateId: RestrictiveResourceId;
|
|
1816
1816
|
/**
|
|
1817
|
-
* The
|
|
1817
|
+
* 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.
|
|
1818
1818
|
*/
|
|
1819
1819
|
AliasName: AliasName;
|
|
1820
1820
|
}
|
|
@@ -1824,11 +1824,11 @@ declare namespace QuickSight {
|
|
|
1824
1824
|
*/
|
|
1825
1825
|
Status?: StatusCode;
|
|
1826
1826
|
/**
|
|
1827
|
-
* An ID for the template.
|
|
1827
|
+
* An ID for the template associated with the deletion.
|
|
1828
1828
|
*/
|
|
1829
1829
|
TemplateId?: RestrictiveResourceId;
|
|
1830
1830
|
/**
|
|
1831
|
-
* The name
|
|
1831
|
+
* The name for the template alias.
|
|
1832
1832
|
*/
|
|
1833
1833
|
AliasName?: AliasName;
|
|
1834
1834
|
/**
|
|
@@ -1842,7 +1842,7 @@ declare namespace QuickSight {
|
|
|
1842
1842
|
}
|
|
1843
1843
|
export interface DeleteTemplateRequest {
|
|
1844
1844
|
/**
|
|
1845
|
-
* AWS account
|
|
1845
|
+
* The ID of the AWS account that contains the template that you're deleting.
|
|
1846
1846
|
*/
|
|
1847
1847
|
AwsAccountId: AwsAccountId;
|
|
1848
1848
|
/**
|
|
@@ -1923,11 +1923,11 @@ declare namespace QuickSight {
|
|
|
1923
1923
|
export type Delimiter = string;
|
|
1924
1924
|
export interface DescribeDashboardPermissionsRequest {
|
|
1925
1925
|
/**
|
|
1926
|
-
* AWS account
|
|
1926
|
+
* The ID of the AWS account that contains the dashboard that you're describing permissions for.
|
|
1927
1927
|
*/
|
|
1928
1928
|
AwsAccountId: AwsAccountId;
|
|
1929
1929
|
/**
|
|
1930
|
-
* The ID for the dashboard, also added to IAM policy.
|
|
1930
|
+
* The ID for the dashboard, also added to the IAM policy.
|
|
1931
1931
|
*/
|
|
1932
1932
|
DashboardId: RestrictiveResourceId;
|
|
1933
1933
|
}
|
|
@@ -1941,7 +1941,7 @@ declare namespace QuickSight {
|
|
|
1941
1941
|
*/
|
|
1942
1942
|
DashboardArn?: Arn;
|
|
1943
1943
|
/**
|
|
1944
|
-
* A structure that contains the permissions
|
|
1944
|
+
* A structure that contains the permissions for the dashboard.
|
|
1945
1945
|
*/
|
|
1946
1946
|
Permissions?: ResourcePermissionList;
|
|
1947
1947
|
/**
|
|
@@ -1955,7 +1955,7 @@ declare namespace QuickSight {
|
|
|
1955
1955
|
}
|
|
1956
1956
|
export interface DescribeDashboardRequest {
|
|
1957
1957
|
/**
|
|
1958
|
-
* AWS account
|
|
1958
|
+
* The ID of the AWS account that contains the dashboard that you're describing.
|
|
1959
1959
|
*/
|
|
1960
1960
|
AwsAccountId: AwsAccountId;
|
|
1961
1961
|
/**
|
|
@@ -1963,7 +1963,7 @@ declare namespace QuickSight {
|
|
|
1963
1963
|
*/
|
|
1964
1964
|
DashboardId: RestrictiveResourceId;
|
|
1965
1965
|
/**
|
|
1966
|
-
* The version number for the dashboard. If version number isn
|
|
1966
|
+
* The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
|
|
1967
1967
|
*/
|
|
1968
1968
|
VersionNumber?: VersionNumber;
|
|
1969
1969
|
/**
|
|
@@ -1977,7 +1977,7 @@ declare namespace QuickSight {
|
|
|
1977
1977
|
*/
|
|
1978
1978
|
Dashboard?: Dashboard;
|
|
1979
1979
|
/**
|
|
1980
|
-
* The
|
|
1980
|
+
* The HTTP status of this request.
|
|
1981
1981
|
*/
|
|
1982
1982
|
Status?: StatusCode;
|
|
1983
1983
|
/**
|
|
@@ -1987,7 +1987,7 @@ declare namespace QuickSight {
|
|
|
1987
1987
|
}
|
|
1988
1988
|
export interface DescribeDataSetPermissionsRequest {
|
|
1989
1989
|
/**
|
|
1990
|
-
* The AWS
|
|
1990
|
+
* The AWS account ID.
|
|
1991
1991
|
*/
|
|
1992
1992
|
AwsAccountId: AwsAccountId;
|
|
1993
1993
|
/**
|
|
@@ -2019,7 +2019,7 @@ declare namespace QuickSight {
|
|
|
2019
2019
|
}
|
|
2020
2020
|
export interface DescribeDataSetRequest {
|
|
2021
2021
|
/**
|
|
2022
|
-
* The AWS
|
|
2022
|
+
* The AWS account ID.
|
|
2023
2023
|
*/
|
|
2024
2024
|
AwsAccountId: AwsAccountId;
|
|
2025
2025
|
/**
|
|
@@ -2127,7 +2127,7 @@ declare namespace QuickSight {
|
|
|
2127
2127
|
}
|
|
2128
2128
|
export interface DescribeIAMPolicyAssignmentRequest {
|
|
2129
2129
|
/**
|
|
2130
|
-
* The AWS account
|
|
2130
|
+
* The ID of the AWS account that contains the assignment that you want to describe.
|
|
2131
2131
|
*/
|
|
2132
2132
|
AwsAccountId: AwsAccountId;
|
|
2133
2133
|
/**
|
|
@@ -2183,15 +2183,15 @@ declare namespace QuickSight {
|
|
|
2183
2183
|
}
|
|
2184
2184
|
export interface DescribeTemplateAliasRequest {
|
|
2185
2185
|
/**
|
|
2186
|
-
* AWS account
|
|
2186
|
+
* The ID of the AWS account that contains the template alias that you're describing.
|
|
2187
2187
|
*/
|
|
2188
2188
|
AwsAccountId: AwsAccountId;
|
|
2189
2189
|
/**
|
|
2190
|
-
*
|
|
2190
|
+
* The ID for the template.
|
|
2191
2191
|
*/
|
|
2192
2192
|
TemplateId: RestrictiveResourceId;
|
|
2193
2193
|
/**
|
|
2194
|
-
* The
|
|
2194
|
+
* 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.
|
|
2195
2195
|
*/
|
|
2196
2196
|
AliasName: AliasName;
|
|
2197
2197
|
}
|
|
@@ -2211,7 +2211,7 @@ declare namespace QuickSight {
|
|
|
2211
2211
|
}
|
|
2212
2212
|
export interface DescribeTemplatePermissionsRequest {
|
|
2213
2213
|
/**
|
|
2214
|
-
* AWS account
|
|
2214
|
+
* The ID of the AWS account that contains the template that you're describing.
|
|
2215
2215
|
*/
|
|
2216
2216
|
AwsAccountId: AwsAccountId;
|
|
2217
2217
|
/**
|
|
@@ -2243,25 +2243,25 @@ declare namespace QuickSight {
|
|
|
2243
2243
|
}
|
|
2244
2244
|
export interface DescribeTemplateRequest {
|
|
2245
2245
|
/**
|
|
2246
|
-
* AWS account
|
|
2246
|
+
* The ID of the AWS account that contains the template that you're describing.
|
|
2247
2247
|
*/
|
|
2248
2248
|
AwsAccountId: AwsAccountId;
|
|
2249
2249
|
/**
|
|
2250
|
-
*
|
|
2250
|
+
* The ID for the template.
|
|
2251
2251
|
*/
|
|
2252
2252
|
TemplateId: RestrictiveResourceId;
|
|
2253
2253
|
/**
|
|
2254
|
-
*
|
|
2254
|
+
* (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
|
|
2255
2255
|
*/
|
|
2256
2256
|
VersionNumber?: VersionNumber;
|
|
2257
2257
|
/**
|
|
2258
|
-
* The alias of the template that you want to describe. If you
|
|
2258
|
+
* 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.
|
|
2259
2259
|
*/
|
|
2260
2260
|
AliasName?: AliasName;
|
|
2261
2261
|
}
|
|
2262
2262
|
export interface DescribeTemplateResponse {
|
|
2263
2263
|
/**
|
|
2264
|
-
* The template structure
|
|
2264
|
+
* The template structure for the object you want to describe.
|
|
2265
2265
|
*/
|
|
2266
2266
|
Template?: Template;
|
|
2267
2267
|
/**
|
|
@@ -2307,7 +2307,7 @@ declare namespace QuickSight {
|
|
|
2307
2307
|
*/
|
|
2308
2308
|
Type?: IngestionErrorType;
|
|
2309
2309
|
/**
|
|
2310
|
-
* Error
|
|
2310
|
+
* Error message.
|
|
2311
2311
|
*/
|
|
2312
2312
|
Message?: string;
|
|
2313
2313
|
}
|
|
@@ -2321,7 +2321,7 @@ declare namespace QuickSight {
|
|
|
2321
2321
|
export type FileFormat = "CSV"|"TSV"|"CLF"|"ELF"|"XLSX"|"JSON"|string;
|
|
2322
2322
|
export interface FilterOperation {
|
|
2323
2323
|
/**
|
|
2324
|
-
* An expression that must evaluate to a
|
|
2324
|
+
* An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
|
|
2325
2325
|
*/
|
|
2326
2326
|
ConditionExpression: Expression;
|
|
2327
2327
|
}
|
|
@@ -2343,37 +2343,37 @@ declare namespace QuickSight {
|
|
|
2343
2343
|
export type GeoSpatialDataRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"|string;
|
|
2344
2344
|
export interface GetDashboardEmbedUrlRequest {
|
|
2345
2345
|
/**
|
|
2346
|
-
* AWS account
|
|
2346
|
+
* The ID for the AWS account that contains the dashboard that you're embedding.
|
|
2347
2347
|
*/
|
|
2348
2348
|
AwsAccountId: AwsAccountId;
|
|
2349
2349
|
/**
|
|
2350
|
-
* The ID for the dashboard, also added to IAM policy
|
|
2350
|
+
* The ID for the dashboard, also added to the IAM policy.
|
|
2351
2351
|
*/
|
|
2352
2352
|
DashboardId: RestrictiveResourceId;
|
|
2353
2353
|
/**
|
|
2354
|
-
* The authentication method the user uses to sign in.
|
|
2354
|
+
* The authentication method that the user uses to sign in.
|
|
2355
2355
|
*/
|
|
2356
2356
|
IdentityType: IdentityType;
|
|
2357
2357
|
/**
|
|
2358
|
-
* How many minutes the session is valid. The session lifetime must be
|
|
2358
|
+
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
|
|
2359
2359
|
*/
|
|
2360
2360
|
SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
|
|
2361
2361
|
/**
|
|
2362
|
-
* Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
|
|
2362
|
+
* Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
|
|
2363
2363
|
*/
|
|
2364
2364
|
UndoRedoDisabled?: boolean;
|
|
2365
2365
|
/**
|
|
2366
|
-
* Remove the reset button on embedded dashboard. The default is FALSE, which
|
|
2366
|
+
* Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
|
|
2367
2367
|
*/
|
|
2368
2368
|
ResetDisabled?: boolean;
|
|
2369
2369
|
/**
|
|
2370
|
-
* 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
|
|
2370
|
+
* 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.
|
|
2371
2371
|
*/
|
|
2372
2372
|
UserArn?: Arn;
|
|
2373
2373
|
}
|
|
2374
2374
|
export interface GetDashboardEmbedUrlResponse {
|
|
2375
2375
|
/**
|
|
2376
|
-
* 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 that enables a single-
|
|
2376
|
+
* 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.
|
|
2377
2377
|
*/
|
|
2378
2378
|
EmbedUrl?: EmbeddingUrl;
|
|
2379
2379
|
/**
|
|
@@ -2387,7 +2387,7 @@ declare namespace QuickSight {
|
|
|
2387
2387
|
}
|
|
2388
2388
|
export interface Group {
|
|
2389
2389
|
/**
|
|
2390
|
-
* The Amazon Resource
|
|
2390
|
+
* The Amazon Resource Name (ARN) for the group.
|
|
2391
2391
|
*/
|
|
2392
2392
|
Arn?: Arn;
|
|
2393
2393
|
/**
|
|
@@ -2407,7 +2407,7 @@ declare namespace QuickSight {
|
|
|
2407
2407
|
export type GroupList = Group[];
|
|
2408
2408
|
export interface GroupMember {
|
|
2409
2409
|
/**
|
|
2410
|
-
* The Amazon Resource
|
|
2410
|
+
* The Amazon Resource Name (ARN) for the group member (user).
|
|
2411
2411
|
*/
|
|
2412
2412
|
Arn?: Arn;
|
|
2413
2413
|
/**
|
|
@@ -2421,7 +2421,7 @@ declare namespace QuickSight {
|
|
|
2421
2421
|
export type Host = string;
|
|
2422
2422
|
export interface IAMPolicyAssignment {
|
|
2423
2423
|
/**
|
|
2424
|
-
* AWS account ID.
|
|
2424
|
+
* The AWS account ID.
|
|
2425
2425
|
*/
|
|
2426
2426
|
AwsAccountId?: AwsAccountId;
|
|
2427
2427
|
/**
|
|
@@ -2433,7 +2433,7 @@ declare namespace QuickSight {
|
|
|
2433
2433
|
*/
|
|
2434
2434
|
AssignmentName?: IAMPolicyAssignmentName;
|
|
2435
2435
|
/**
|
|
2436
|
-
*
|
|
2436
|
+
* The Amazon Resource Name (ARN) for the IAM policy.
|
|
2437
2437
|
*/
|
|
2438
2438
|
PolicyArn?: Arn;
|
|
2439
2439
|
/**
|
|
@@ -2463,7 +2463,7 @@ declare namespace QuickSight {
|
|
|
2463
2463
|
export type IdentityType = "IAM"|"QUICKSIGHT"|string;
|
|
2464
2464
|
export interface Ingestion {
|
|
2465
2465
|
/**
|
|
2466
|
-
* The Amazon Resource
|
|
2466
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
2467
2467
|
*/
|
|
2468
2468
|
Arn: Arn;
|
|
2469
2469
|
/**
|
|
@@ -2481,15 +2481,15 @@ declare namespace QuickSight {
|
|
|
2481
2481
|
RowInfo?: RowInfo;
|
|
2482
2482
|
QueueInfo?: QueueInfo;
|
|
2483
2483
|
/**
|
|
2484
|
-
* The time this ingestion started.
|
|
2484
|
+
* The time that this ingestion started.
|
|
2485
2485
|
*/
|
|
2486
2486
|
CreatedTime: timestamp;
|
|
2487
2487
|
/**
|
|
2488
|
-
* The time this ingestion took, measured in seconds.
|
|
2488
|
+
* The time that this ingestion took, measured in seconds.
|
|
2489
2489
|
*/
|
|
2490
2490
|
IngestionTimeInSeconds?: long;
|
|
2491
2491
|
/**
|
|
2492
|
-
*
|
|
2492
|
+
* The size of the data ingested, in bytes.
|
|
2493
2493
|
*/
|
|
2494
2494
|
IngestionSizeInBytes?: long;
|
|
2495
2495
|
/**
|
|
@@ -2559,7 +2559,7 @@ declare namespace QuickSight {
|
|
|
2559
2559
|
export type JoinType = "INNER"|"OUTER"|"LEFT"|"RIGHT"|string;
|
|
2560
2560
|
export interface ListDashboardVersionsRequest {
|
|
2561
2561
|
/**
|
|
2562
|
-
* AWS account
|
|
2562
|
+
* The ID of the AWS account that contains the dashboard that you're listing versions for.
|
|
2563
2563
|
*/
|
|
2564
2564
|
AwsAccountId: AwsAccountId;
|
|
2565
2565
|
/**
|
|
@@ -2595,7 +2595,7 @@ declare namespace QuickSight {
|
|
|
2595
2595
|
}
|
|
2596
2596
|
export interface ListDashboardsRequest {
|
|
2597
2597
|
/**
|
|
2598
|
-
* AWS account
|
|
2598
|
+
* The ID of the AWS account that contains the dashboards that you're listing.
|
|
2599
2599
|
*/
|
|
2600
2600
|
AwsAccountId: AwsAccountId;
|
|
2601
2601
|
/**
|
|
@@ -2609,7 +2609,7 @@ declare namespace QuickSight {
|
|
|
2609
2609
|
}
|
|
2610
2610
|
export interface ListDashboardsResponse {
|
|
2611
2611
|
/**
|
|
2612
|
-
* A structure that contains all of the dashboards shared with the user.
|
|
2612
|
+
* A structure that contains all of the dashboards shared with the user. This structure provides basic information about the dashboards.
|
|
2613
2613
|
*/
|
|
2614
2614
|
DashboardSummaryList?: DashboardSummaryList;
|
|
2615
2615
|
/**
|
|
@@ -2627,7 +2627,7 @@ declare namespace QuickSight {
|
|
|
2627
2627
|
}
|
|
2628
2628
|
export interface ListDataSetsRequest {
|
|
2629
2629
|
/**
|
|
2630
|
-
* The AWS
|
|
2630
|
+
* The AWS account ID.
|
|
2631
2631
|
*/
|
|
2632
2632
|
AwsAccountId: AwsAccountId;
|
|
2633
2633
|
/**
|
|
@@ -2767,7 +2767,7 @@ declare namespace QuickSight {
|
|
|
2767
2767
|
}
|
|
2768
2768
|
export interface ListIAMPolicyAssignmentsForUserRequest {
|
|
2769
2769
|
/**
|
|
2770
|
-
* The AWS account
|
|
2770
|
+
* The ID of the AWS account that contains the assignments.
|
|
2771
2771
|
*/
|
|
2772
2772
|
AwsAccountId: AwsAccountId;
|
|
2773
2773
|
/**
|
|
@@ -2789,7 +2789,7 @@ declare namespace QuickSight {
|
|
|
2789
2789
|
}
|
|
2790
2790
|
export interface ListIAMPolicyAssignmentsForUserResponse {
|
|
2791
2791
|
/**
|
|
2792
|
-
*
|
|
2792
|
+
* The active assignments for this user.
|
|
2793
2793
|
*/
|
|
2794
2794
|
ActiveAssignments?: ActiveIAMPolicyAssignmentList;
|
|
2795
2795
|
/**
|
|
@@ -2807,15 +2807,15 @@ declare namespace QuickSight {
|
|
|
2807
2807
|
}
|
|
2808
2808
|
export interface ListIAMPolicyAssignmentsRequest {
|
|
2809
2809
|
/**
|
|
2810
|
-
* The AWS account
|
|
2810
|
+
* The ID of the AWS account that contains these IAM policy assignments.
|
|
2811
2811
|
*/
|
|
2812
2812
|
AwsAccountId: AwsAccountId;
|
|
2813
2813
|
/**
|
|
2814
|
-
* The status of the
|
|
2814
|
+
* The status of the assignments.
|
|
2815
2815
|
*/
|
|
2816
2816
|
AssignmentStatus?: AssignmentStatus;
|
|
2817
2817
|
/**
|
|
2818
|
-
* The namespace for
|
|
2818
|
+
* The namespace for the assignments.
|
|
2819
2819
|
*/
|
|
2820
2820
|
Namespace: Namespace;
|
|
2821
2821
|
/**
|
|
@@ -2903,7 +2903,7 @@ declare namespace QuickSight {
|
|
|
2903
2903
|
}
|
|
2904
2904
|
export interface ListTemplateAliasesRequest {
|
|
2905
2905
|
/**
|
|
2906
|
-
* AWS account
|
|
2906
|
+
* The ID of the AWS account that contains the template aliases that you're listing.
|
|
2907
2907
|
*/
|
|
2908
2908
|
AwsAccountId: AwsAccountId;
|
|
2909
2909
|
/**
|
|
@@ -2939,7 +2939,7 @@ declare namespace QuickSight {
|
|
|
2939
2939
|
}
|
|
2940
2940
|
export interface ListTemplateVersionsRequest {
|
|
2941
2941
|
/**
|
|
2942
|
-
* AWS account
|
|
2942
|
+
* The ID of the AWS account that contains the templates that you're listing.
|
|
2943
2943
|
*/
|
|
2944
2944
|
AwsAccountId: AwsAccountId;
|
|
2945
2945
|
/**
|
|
@@ -2975,7 +2975,7 @@ declare namespace QuickSight {
|
|
|
2975
2975
|
}
|
|
2976
2976
|
export interface ListTemplatesRequest {
|
|
2977
2977
|
/**
|
|
2978
|
-
* AWS account
|
|
2978
|
+
* The ID of the AWS account that contains the templates that you're listing.
|
|
2979
2979
|
*/
|
|
2980
2980
|
AwsAccountId: AwsAccountId;
|
|
2981
2981
|
/**
|
|
@@ -3011,7 +3011,7 @@ declare namespace QuickSight {
|
|
|
3011
3011
|
*/
|
|
3012
3012
|
UserName: UserName;
|
|
3013
3013
|
/**
|
|
3014
|
-
* The AWS
|
|
3014
|
+
* The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
|
|
3015
3015
|
*/
|
|
3016
3016
|
AwsAccountId: AwsAccountId;
|
|
3017
3017
|
/**
|
|
@@ -3260,11 +3260,11 @@ declare namespace QuickSight {
|
|
|
3260
3260
|
}
|
|
3261
3261
|
export interface RedshiftParameters {
|
|
3262
3262
|
/**
|
|
3263
|
-
* Host. This can be blank if
|
|
3263
|
+
* Host. This field can be blank if ClusterId is provided.
|
|
3264
3264
|
*/
|
|
3265
3265
|
Host?: Host;
|
|
3266
3266
|
/**
|
|
3267
|
-
* Port. This can be blank if the ClusterId is provided.
|
|
3267
|
+
* Port. This field can be blank if the ClusterId is provided.
|
|
3268
3268
|
*/
|
|
3269
3269
|
Port?: OptionalPort;
|
|
3270
3270
|
/**
|
|
@@ -3272,7 +3272,7 @@ declare namespace QuickSight {
|
|
|
3272
3272
|
*/
|
|
3273
3273
|
Database: Database;
|
|
3274
3274
|
/**
|
|
3275
|
-
* Cluster ID. This can be blank if the Host and Port are provided.
|
|
3275
|
+
* Cluster ID. This field can be blank if the Host and Port are provided.
|
|
3276
3276
|
*/
|
|
3277
3277
|
ClusterId?: ClusterId;
|
|
3278
3278
|
}
|
|
@@ -3334,11 +3334,11 @@ declare namespace QuickSight {
|
|
|
3334
3334
|
*/
|
|
3335
3335
|
DataSourceArn: Arn;
|
|
3336
3336
|
/**
|
|
3337
|
-
* The schema name.
|
|
3337
|
+
* The schema name. This name applies to certain relational database engines.
|
|
3338
3338
|
*/
|
|
3339
3339
|
Schema?: RelationalTableSchema;
|
|
3340
3340
|
/**
|
|
3341
|
-
*
|
|
3341
|
+
* The name of the relational table.
|
|
3342
3342
|
*/
|
|
3343
3343
|
Name: RelationalTableName;
|
|
3344
3344
|
/**
|
|
@@ -3350,11 +3350,11 @@ declare namespace QuickSight {
|
|
|
3350
3350
|
export type RelationalTableSchema = string;
|
|
3351
3351
|
export interface RenameColumnOperation {
|
|
3352
3352
|
/**
|
|
3353
|
-
*
|
|
3353
|
+
* The name of the column to be renamed.
|
|
3354
3354
|
*/
|
|
3355
3355
|
ColumnName: ColumnName;
|
|
3356
3356
|
/**
|
|
3357
|
-
*
|
|
3357
|
+
* The new name for the column.
|
|
3358
3358
|
*/
|
|
3359
3359
|
NewColumnName: ColumnName;
|
|
3360
3360
|
}
|
|
@@ -3362,11 +3362,11 @@ declare namespace QuickSight {
|
|
|
3362
3362
|
export type ResourceName = string;
|
|
3363
3363
|
export interface ResourcePermission {
|
|
3364
3364
|
/**
|
|
3365
|
-
* The Amazon Resource Name (ARN) of
|
|
3365
|
+
* 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. .
|
|
3366
3366
|
*/
|
|
3367
3367
|
Principal: Principal;
|
|
3368
3368
|
/**
|
|
3369
|
-
* The action to grant or revoke permissions on
|
|
3369
|
+
* The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
|
|
3370
3370
|
*/
|
|
3371
3371
|
Actions: ActionList;
|
|
3372
3372
|
}
|
|
@@ -3386,7 +3386,7 @@ declare namespace QuickSight {
|
|
|
3386
3386
|
}
|
|
3387
3387
|
export interface RowLevelPermissionDataSet {
|
|
3388
3388
|
/**
|
|
3389
|
-
* The Amazon Resource
|
|
3389
|
+
* The Amazon Resource Name (ARN) of the permission dataset.
|
|
3390
3390
|
*/
|
|
3391
3391
|
Arn: Arn;
|
|
3392
3392
|
/**
|
|
@@ -3405,11 +3405,11 @@ declare namespace QuickSight {
|
|
|
3405
3405
|
}
|
|
3406
3406
|
export interface S3Source {
|
|
3407
3407
|
/**
|
|
3408
|
-
*
|
|
3408
|
+
* The amazon Resource Name (ARN) for the data source.
|
|
3409
3409
|
*/
|
|
3410
3410
|
DataSourceArn: Arn;
|
|
3411
3411
|
/**
|
|
3412
|
-
* Information
|
|
3412
|
+
* Information about the format for the S3 source file or files.
|
|
3413
3413
|
*/
|
|
3414
3414
|
UploadSettings?: UploadSettings;
|
|
3415
3415
|
/**
|
|
@@ -3472,7 +3472,7 @@ declare namespace QuickSight {
|
|
|
3472
3472
|
}
|
|
3473
3473
|
export interface SslProperties {
|
|
3474
3474
|
/**
|
|
3475
|
-
* A
|
|
3475
|
+
* A Boolean option to control whether SSL should be disabled.
|
|
3476
3476
|
*/
|
|
3477
3477
|
DisableSsl?: Boolean;
|
|
3478
3478
|
}
|
|
@@ -3566,7 +3566,7 @@ declare namespace QuickSight {
|
|
|
3566
3566
|
*/
|
|
3567
3567
|
AliasName?: AliasName;
|
|
3568
3568
|
/**
|
|
3569
|
-
* The ARN of the template alias.
|
|
3569
|
+
* The Amazon Resource Name (ARN) of the template alias.
|
|
3570
3570
|
*/
|
|
3571
3571
|
Arn?: Arn;
|
|
3572
3572
|
/**
|
|
@@ -3590,7 +3590,7 @@ declare namespace QuickSight {
|
|
|
3590
3590
|
export type TemplateName = string;
|
|
3591
3591
|
export interface TemplateSourceAnalysis {
|
|
3592
3592
|
/**
|
|
3593
|
-
* The Amazon Resource
|
|
3593
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
3594
3594
|
*/
|
|
3595
3595
|
Arn: Arn;
|
|
3596
3596
|
/**
|
|
@@ -3610,7 +3610,7 @@ declare namespace QuickSight {
|
|
|
3610
3610
|
}
|
|
3611
3611
|
export interface TemplateSourceTemplate {
|
|
3612
3612
|
/**
|
|
3613
|
-
* The Amazon Resource
|
|
3613
|
+
* The Amazon Resource Name (ARN) of the resource.
|
|
3614
3614
|
*/
|
|
3615
3615
|
Arn: Arn;
|
|
3616
3616
|
}
|
|
@@ -3620,7 +3620,7 @@ declare namespace QuickSight {
|
|
|
3620
3620
|
*/
|
|
3621
3621
|
Arn?: Arn;
|
|
3622
3622
|
/**
|
|
3623
|
-
* The ID of the template. This is unique per AWS Region for each AWS account.
|
|
3623
|
+
* The ID of the template. This ID is unique per AWS Region for each AWS account.
|
|
3624
3624
|
*/
|
|
3625
3625
|
TemplateId?: RestrictiveResourceId;
|
|
3626
3626
|
/**
|
|
@@ -3632,18 +3632,18 @@ declare namespace QuickSight {
|
|
|
3632
3632
|
*/
|
|
3633
3633
|
LatestVersionNumber?: VersionNumber;
|
|
3634
3634
|
/**
|
|
3635
|
-
* The last time this was created.
|
|
3635
|
+
* The last time that this template was created.
|
|
3636
3636
|
*/
|
|
3637
3637
|
CreatedTime?: Timestamp;
|
|
3638
3638
|
/**
|
|
3639
|
-
* The last time this was updated.
|
|
3639
|
+
* The last time that this template was updated.
|
|
3640
3640
|
*/
|
|
3641
3641
|
LastUpdatedTime?: Timestamp;
|
|
3642
3642
|
}
|
|
3643
3643
|
export type TemplateSummaryList = TemplateSummary[];
|
|
3644
3644
|
export interface TemplateVersion {
|
|
3645
3645
|
/**
|
|
3646
|
-
* The time this was created.
|
|
3646
|
+
* The time that this template version was created.
|
|
3647
3647
|
*/
|
|
3648
3648
|
CreatedTime?: Timestamp;
|
|
3649
3649
|
/**
|
|
@@ -3681,7 +3681,7 @@ declare namespace QuickSight {
|
|
|
3681
3681
|
*/
|
|
3682
3682
|
VersionNumber?: VersionNumber;
|
|
3683
3683
|
/**
|
|
3684
|
-
* The time this was created.
|
|
3684
|
+
* The time that this template version was created.
|
|
3685
3685
|
*/
|
|
3686
3686
|
CreatedTime?: Timestamp;
|
|
3687
3687
|
/**
|
|
@@ -3689,7 +3689,7 @@ declare namespace QuickSight {
|
|
|
3689
3689
|
*/
|
|
3690
3690
|
Status?: ResourceStatus;
|
|
3691
3691
|
/**
|
|
3692
|
-
* The
|
|
3692
|
+
* The description of the template version.
|
|
3693
3693
|
*/
|
|
3694
3694
|
Description?: VersionDescription;
|
|
3695
3695
|
}
|
|
@@ -3771,7 +3771,7 @@ declare namespace QuickSight {
|
|
|
3771
3771
|
}
|
|
3772
3772
|
export interface UpdateDashboardPermissionsRequest {
|
|
3773
3773
|
/**
|
|
3774
|
-
* AWS account
|
|
3774
|
+
* The ID of the AWS account that contains the dashboard whose permissions you're updating.
|
|
3775
3775
|
*/
|
|
3776
3776
|
AwsAccountId: AwsAccountId;
|
|
3777
3777
|
/**
|
|
@@ -3811,7 +3811,7 @@ declare namespace QuickSight {
|
|
|
3811
3811
|
}
|
|
3812
3812
|
export interface UpdateDashboardPublishedVersionRequest {
|
|
3813
3813
|
/**
|
|
3814
|
-
* AWS account
|
|
3814
|
+
* The ID of the AWS account that contains the dashboard that you're updating.
|
|
3815
3815
|
*/
|
|
3816
3816
|
AwsAccountId: AwsAccountId;
|
|
3817
3817
|
/**
|
|
@@ -3843,7 +3843,7 @@ declare namespace QuickSight {
|
|
|
3843
3843
|
}
|
|
3844
3844
|
export interface UpdateDashboardRequest {
|
|
3845
3845
|
/**
|
|
3846
|
-
* AWS account
|
|
3846
|
+
* The ID of the AWS account that contains the dashboard that you're updating.
|
|
3847
3847
|
*/
|
|
3848
3848
|
AwsAccountId: AwsAccountId;
|
|
3849
3849
|
/**
|
|
@@ -3855,7 +3855,7 @@ declare namespace QuickSight {
|
|
|
3855
3855
|
*/
|
|
3856
3856
|
Name: DashboardName;
|
|
3857
3857
|
/**
|
|
3858
|
-
* The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the
|
|
3858
|
+
* 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.
|
|
3859
3859
|
*/
|
|
3860
3860
|
SourceEntity: DashboardSourceEntity;
|
|
3861
3861
|
/**
|
|
@@ -3867,7 +3867,7 @@ declare namespace QuickSight {
|
|
|
3867
3867
|
*/
|
|
3868
3868
|
VersionDescription?: VersionDescription;
|
|
3869
3869
|
/**
|
|
3870
|
-
*
|
|
3870
|
+
* 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.
|
|
3871
3871
|
*/
|
|
3872
3872
|
DashboardPublishOptions?: DashboardPublishOptions;
|
|
3873
3873
|
}
|
|
@@ -3899,11 +3899,11 @@ declare namespace QuickSight {
|
|
|
3899
3899
|
}
|
|
3900
3900
|
export interface UpdateDataSetPermissionsRequest {
|
|
3901
3901
|
/**
|
|
3902
|
-
* The AWS
|
|
3902
|
+
* The AWS account ID.
|
|
3903
3903
|
*/
|
|
3904
3904
|
AwsAccountId: AwsAccountId;
|
|
3905
3905
|
/**
|
|
3906
|
-
* The ID for the dataset
|
|
3906
|
+
* The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
|
|
3907
3907
|
*/
|
|
3908
3908
|
DataSetId: ResourceId;
|
|
3909
3909
|
/**
|
|
@@ -3921,7 +3921,7 @@ declare namespace QuickSight {
|
|
|
3921
3921
|
*/
|
|
3922
3922
|
DataSetArn?: Arn;
|
|
3923
3923
|
/**
|
|
3924
|
-
* The ID for the dataset
|
|
3924
|
+
* The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
|
|
3925
3925
|
*/
|
|
3926
3926
|
DataSetId?: ResourceId;
|
|
3927
3927
|
/**
|
|
@@ -3935,11 +3935,11 @@ declare namespace QuickSight {
|
|
|
3935
3935
|
}
|
|
3936
3936
|
export interface UpdateDataSetRequest {
|
|
3937
3937
|
/**
|
|
3938
|
-
* The AWS
|
|
3938
|
+
* The AWS account ID.
|
|
3939
3939
|
*/
|
|
3940
3940
|
AwsAccountId: AwsAccountId;
|
|
3941
3941
|
/**
|
|
3942
|
-
* The ID for the dataset that you want to
|
|
3942
|
+
* The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
|
|
3943
3943
|
*/
|
|
3944
3944
|
DataSetId: ResourceId;
|
|
3945
3945
|
/**
|
|
@@ -3955,7 +3955,7 @@ declare namespace QuickSight {
|
|
|
3955
3955
|
*/
|
|
3956
3956
|
LogicalTableMap?: LogicalTableMap;
|
|
3957
3957
|
/**
|
|
3958
|
-
* Indicates whether
|
|
3958
|
+
* Indicates whether you want to import the data into SPICE.
|
|
3959
3959
|
*/
|
|
3960
3960
|
ImportMode: DataSetImportMode;
|
|
3961
3961
|
/**
|
|
@@ -3963,7 +3963,7 @@ declare namespace QuickSight {
|
|
|
3963
3963
|
*/
|
|
3964
3964
|
ColumnGroups?: ColumnGroupList;
|
|
3965
3965
|
/**
|
|
3966
|
-
*
|
|
3966
|
+
* The row-level security configuration for the data you want to create.
|
|
3967
3967
|
*/
|
|
3968
3968
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
3969
3969
|
}
|
|
@@ -3977,11 +3977,11 @@ declare namespace QuickSight {
|
|
|
3977
3977
|
*/
|
|
3978
3978
|
DataSetId?: ResourceId;
|
|
3979
3979
|
/**
|
|
3980
|
-
* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
|
|
3980
|
+
* The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
|
|
3981
3981
|
*/
|
|
3982
3982
|
IngestionArn?: Arn;
|
|
3983
3983
|
/**
|
|
3984
|
-
* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
|
|
3984
|
+
* The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
|
|
3985
3985
|
*/
|
|
3986
3986
|
IngestionId?: ResourceId;
|
|
3987
3987
|
/**
|
|
@@ -4115,11 +4115,11 @@ declare namespace QuickSight {
|
|
|
4115
4115
|
}
|
|
4116
4116
|
export interface UpdateIAMPolicyAssignmentRequest {
|
|
4117
4117
|
/**
|
|
4118
|
-
* The AWS account
|
|
4118
|
+
* The ID of the AWS account that contains the IAM policy assignment.
|
|
4119
4119
|
*/
|
|
4120
4120
|
AwsAccountId: AwsAccountId;
|
|
4121
4121
|
/**
|
|
4122
|
-
* The name of the assignment.
|
|
4122
|
+
* The name of the assignment. This name must be unique within an AWS account.
|
|
4123
4123
|
*/
|
|
4124
4124
|
AssignmentName: IAMPolicyAssignmentName;
|
|
4125
4125
|
/**
|
|
@@ -4127,15 +4127,15 @@ declare namespace QuickSight {
|
|
|
4127
4127
|
*/
|
|
4128
4128
|
Namespace: Namespace;
|
|
4129
4129
|
/**
|
|
4130
|
-
* The status of
|
|
4130
|
+
* 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.
|
|
4131
4131
|
*/
|
|
4132
4132
|
AssignmentStatus?: AssignmentStatus;
|
|
4133
4133
|
/**
|
|
4134
|
-
*
|
|
4134
|
+
* The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
|
|
4135
4135
|
*/
|
|
4136
4136
|
PolicyArn?: Arn;
|
|
4137
4137
|
/**
|
|
4138
|
-
* QuickSight users
|
|
4138
|
+
* The QuickSight users, groups, or both that you want to assign the policy to.
|
|
4139
4139
|
*/
|
|
4140
4140
|
Identities?: IdentityMap;
|
|
4141
4141
|
}
|
|
@@ -4149,15 +4149,15 @@ declare namespace QuickSight {
|
|
|
4149
4149
|
*/
|
|
4150
4150
|
AssignmentId?: String;
|
|
4151
4151
|
/**
|
|
4152
|
-
* The IAM policy
|
|
4152
|
+
* The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.
|
|
4153
4153
|
*/
|
|
4154
4154
|
PolicyArn?: Arn;
|
|
4155
4155
|
/**
|
|
4156
|
-
* QuickSight users
|
|
4156
|
+
* The QuickSight users, groups, or both that the IAM policy is assigned to.
|
|
4157
4157
|
*/
|
|
4158
4158
|
Identities?: IdentityMap;
|
|
4159
4159
|
/**
|
|
4160
|
-
* The status of the assignment:
|
|
4160
|
+
* 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.
|
|
4161
4161
|
*/
|
|
4162
4162
|
AssignmentStatus?: AssignmentStatus;
|
|
4163
4163
|
/**
|
|
@@ -4172,7 +4172,7 @@ declare namespace QuickSight {
|
|
|
4172
4172
|
export type UpdateResourcePermissionList = ResourcePermission[];
|
|
4173
4173
|
export interface UpdateTemplateAliasRequest {
|
|
4174
4174
|
/**
|
|
4175
|
-
* AWS account
|
|
4175
|
+
* The ID of the AWS account that contains the template alias that you're updating.
|
|
4176
4176
|
*/
|
|
4177
4177
|
AwsAccountId: AwsAccountId;
|
|
4178
4178
|
/**
|
|
@@ -4180,7 +4180,7 @@ declare namespace QuickSight {
|
|
|
4180
4180
|
*/
|
|
4181
4181
|
TemplateId: RestrictiveResourceId;
|
|
4182
4182
|
/**
|
|
4183
|
-
* The alias of the template that you want to update. If you
|
|
4183
|
+
* 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.
|
|
4184
4184
|
*/
|
|
4185
4185
|
AliasName: AliasName;
|
|
4186
4186
|
/**
|
|
@@ -4204,7 +4204,7 @@ declare namespace QuickSight {
|
|
|
4204
4204
|
}
|
|
4205
4205
|
export interface UpdateTemplatePermissionsRequest {
|
|
4206
4206
|
/**
|
|
4207
|
-
* AWS account
|
|
4207
|
+
* The ID of the AWS account that contains the template.
|
|
4208
4208
|
*/
|
|
4209
4209
|
AwsAccountId: AwsAccountId;
|
|
4210
4210
|
/**
|
|
@@ -4244,7 +4244,7 @@ declare namespace QuickSight {
|
|
|
4244
4244
|
}
|
|
4245
4245
|
export interface UpdateTemplateRequest {
|
|
4246
4246
|
/**
|
|
4247
|
-
* AWS account
|
|
4247
|
+
* The ID of the AWS account that contains the template that you're updating.
|
|
4248
4248
|
*/
|
|
4249
4249
|
AwsAccountId: AwsAccountId;
|
|
4250
4250
|
/**
|
|
@@ -4252,11 +4252,11 @@ declare namespace QuickSight {
|
|
|
4252
4252
|
*/
|
|
4253
4253
|
TemplateId: RestrictiveResourceId;
|
|
4254
4254
|
/**
|
|
4255
|
-
* The source QuickSight entity from which this template is being
|
|
4255
|
+
* The source QuickSight entity from which this template is being updated. You can currently update templates from an Analysis or another template.
|
|
4256
4256
|
*/
|
|
4257
4257
|
SourceEntity: TemplateSourceEntity;
|
|
4258
4258
|
/**
|
|
4259
|
-
* A description of the current template version being updated. Every time you
|
|
4259
|
+
* 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.
|
|
4260
4260
|
*/
|
|
4261
4261
|
VersionDescription?: VersionDescription;
|
|
4262
4262
|
/**
|
|
@@ -4274,7 +4274,7 @@ declare namespace QuickSight {
|
|
|
4274
4274
|
*/
|
|
4275
4275
|
Arn?: Arn;
|
|
4276
4276
|
/**
|
|
4277
|
-
* The
|
|
4277
|
+
* The ARN for the template, including the version information of the first version.
|
|
4278
4278
|
*/
|
|
4279
4279
|
VersionArn?: Arn;
|
|
4280
4280
|
/**
|
|
@@ -4336,7 +4336,7 @@ declare namespace QuickSight {
|
|
|
4336
4336
|
*/
|
|
4337
4337
|
StartFromRow?: PositiveInteger;
|
|
4338
4338
|
/**
|
|
4339
|
-
* Whether
|
|
4339
|
+
* Whether the file has a header row, or the files each have a header row.
|
|
4340
4340
|
*/
|
|
4341
4341
|
ContainsHeader?: Boolean;
|
|
4342
4342
|
/**
|
|
@@ -4350,7 +4350,7 @@ declare namespace QuickSight {
|
|
|
4350
4350
|
}
|
|
4351
4351
|
export interface User {
|
|
4352
4352
|
/**
|
|
4353
|
-
* The Amazon Resource
|
|
4353
|
+
* The Amazon Resource Name (ARN) for the user.
|
|
4354
4354
|
*/
|
|
4355
4355
|
Arn?: Arn;
|
|
4356
4356
|
/**
|
|
@@ -4370,7 +4370,7 @@ declare namespace QuickSight {
|
|
|
4370
4370
|
*/
|
|
4371
4371
|
IdentityType?: IdentityType;
|
|
4372
4372
|
/**
|
|
4373
|
-
*
|
|
4373
|
+
* 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.
|
|
4374
4374
|
*/
|
|
4375
4375
|
Active?: Boolean;
|
|
4376
4376
|
/**
|