aws-sdk 2.978.0 → 2.982.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 +27 -1
- package/README.md +1 -1
- package/apis/acm-pca-2017-08-22.min.json +26 -14
- package/apis/cloudformation-2010-05-15.min.json +27 -1
- package/apis/ec2-2016-11-15.min.json +731 -727
- package/apis/elasticfilesystem-2015-02-01.min.json +2 -1
- package/apis/firehose-2015-08-04.min.json +104 -79
- package/apis/fsx-2018-03-01.min.json +639 -66
- package/apis/fsx-2018-03-01.paginators.json +15 -0
- package/apis/iot-2015-05-28.min.json +481 -232
- package/apis/iot-2015-05-28.paginators.json +12 -0
- package/apis/kms-2014-11-01.examples.json +100 -94
- package/apis/kms-2014-11-01.min.json +54 -34
- package/apis/mediatailor-2018-04-23.min.json +144 -116
- package/apis/quicksight-2018-04-01.min.json +162 -127
- package/apis/s3control-2018-08-20.min.json +470 -24
- package/apis/s3control-2018-08-20.paginators.json +5 -0
- package/apis/schemas-2019-12-02.min.json +49 -31
- package/apis/securityhub-2018-10-26.min.json +492 -205
- package/apis/securityhub-2018-10-26.paginators.json +22 -11
- package/apis/servicecatalog-appregistry-2020-06-24.min.json +68 -0
- package/apis/transfer-2018-11-05.min.json +403 -9
- package/apis/transfer-2018-11-05.paginators.json +10 -0
- package/clients/accessanalyzer.d.ts +46 -43
- package/clients/acmpca.d.ts +21 -7
- package/clients/cloudformation.d.ts +116 -80
- package/clients/cloudtrail.d.ts +72 -72
- package/clients/codebuild.d.ts +3 -3
- package/clients/computeoptimizer.d.ts +1 -1
- package/clients/configservice.d.ts +323 -323
- package/clients/ebs.d.ts +1 -1
- package/clients/ec2.d.ts +22 -13
- package/clients/efs.d.ts +57 -31
- package/clients/firehose.d.ts +39 -10
- package/clients/fsx.d.ts +694 -52
- package/clients/iot.d.ts +829 -506
- package/clients/kms.d.ts +293 -280
- package/clients/lexmodelbuildingservice.d.ts +1 -1
- package/clients/mediatailor.d.ts +45 -8
- package/clients/memorydb.d.ts +2 -2
- package/clients/polly.d.ts +2 -2
- package/clients/quicksight.d.ts +343 -310
- package/clients/s3control.d.ts +439 -44
- package/clients/schemas.d.ts +25 -0
- package/clients/securityhub.d.ts +524 -21
- package/clients/servicecatalogappregistry.d.ts +81 -3
- package/clients/sqs.d.ts +4 -4
- package/clients/transfer.d.ts +556 -28
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +25 -27
- package/dist/aws-sdk.js +1414 -1077
- package/dist/aws-sdk.min.js +85 -85
- package/dist/xml2js.js +2 -3
- package/lib/core.js +1 -1
- package/package.json +1 -1
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 Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account
|
|
23
|
+
* Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
|
|
24
24
|
*/
|
|
25
25
|
createAccountCustomization(params: QuickSight.Types.CreateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account
|
|
27
|
+
* Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
|
|
28
28
|
*/
|
|
29
29
|
createAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
|
|
30
30
|
/**
|
|
@@ -36,11 +36,11 @@ declare class QuickSight extends Service {
|
|
|
36
36
|
*/
|
|
37
37
|
createAnalysis(callback?: (err: AWSError, data: QuickSight.Types.CreateAnalysisResponse) => void): Request<QuickSight.Types.CreateAnalysisResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* 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. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account
|
|
39
|
+
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
|
|
40
40
|
*/
|
|
41
41
|
createDashboard(params: QuickSight.Types.CreateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* 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. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account
|
|
43
|
+
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
|
|
44
44
|
*/
|
|
45
45
|
createDashboard(callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
|
|
46
46
|
/**
|
|
@@ -92,11 +92,11 @@ declare class QuickSight extends Service {
|
|
|
92
92
|
*/
|
|
93
93
|
createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
|
|
94
94
|
/**
|
|
95
|
-
* Creates an assignment with one specified
|
|
95
|
+
* Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
|
|
96
96
|
*/
|
|
97
97
|
createIAMPolicyAssignment(params: QuickSight.Types.CreateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
|
|
98
98
|
/**
|
|
99
|
-
* Creates an assignment with one specified
|
|
99
|
+
* Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
|
|
100
100
|
*/
|
|
101
101
|
createIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
|
|
102
102
|
/**
|
|
@@ -108,19 +108,19 @@ declare class QuickSight extends Service {
|
|
|
108
108
|
*/
|
|
109
109
|
createIngestion(callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
|
|
110
110
|
/**
|
|
111
|
-
* (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account
|
|
111
|
+
* (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
|
|
112
112
|
*/
|
|
113
113
|
createNamespace(params: QuickSight.Types.CreateNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateNamespaceResponse) => void): Request<QuickSight.Types.CreateNamespaceResponse, AWSError>;
|
|
114
114
|
/**
|
|
115
|
-
* (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account
|
|
115
|
+
* (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
|
|
116
116
|
*/
|
|
117
117
|
createNamespace(callback?: (err: AWSError, data: QuickSight.Types.CreateNamespaceResponse) => void): Request<QuickSight.Types.CreateNamespaceResponse, AWSError>;
|
|
118
118
|
/**
|
|
119
|
-
* Creates a template from an existing Amazon 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.
|
|
119
|
+
* Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in Amazon 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.
|
|
120
120
|
*/
|
|
121
121
|
createTemplate(params: QuickSight.Types.CreateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
|
|
122
122
|
/**
|
|
123
|
-
* Creates a template from an existing Amazon 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.
|
|
123
|
+
* Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in Amazon 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.
|
|
124
124
|
*/
|
|
125
125
|
createTemplate(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
|
|
126
126
|
/**
|
|
@@ -148,19 +148,19 @@ declare class QuickSight extends Service {
|
|
|
148
148
|
*/
|
|
149
149
|
createThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.CreateThemeAliasResponse) => void): Request<QuickSight.Types.CreateThemeAliasResponse, AWSError>;
|
|
150
150
|
/**
|
|
151
|
-
* Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account
|
|
151
|
+
* Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account and Amazon QuickSight namespace.
|
|
152
152
|
*/
|
|
153
153
|
deleteAccountCustomization(params: QuickSight.Types.DeleteAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountCustomizationResponse) => void): Request<QuickSight.Types.DeleteAccountCustomizationResponse, AWSError>;
|
|
154
154
|
/**
|
|
155
|
-
* Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account
|
|
155
|
+
* Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account and Amazon QuickSight namespace.
|
|
156
156
|
*/
|
|
157
157
|
deleteAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountCustomizationResponse) => void): Request<QuickSight.Types.DeleteAccountCustomizationResponse, AWSError>;
|
|
158
158
|
/**
|
|
159
|
-
* Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
|
|
159
|
+
* Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
|
|
160
160
|
*/
|
|
161
161
|
deleteAnalysis(params: QuickSight.Types.DeleteAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAnalysisResponse) => void): Request<QuickSight.Types.DeleteAnalysisResponse, AWSError>;
|
|
162
162
|
/**
|
|
163
|
-
* Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
|
|
163
|
+
* Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
|
|
164
164
|
*/
|
|
165
165
|
deleteAnalysis(callback?: (err: AWSError, data: QuickSight.Types.DeleteAnalysisResponse) => void): Request<QuickSight.Types.DeleteAnalysisResponse, AWSError>;
|
|
166
166
|
/**
|
|
@@ -220,11 +220,11 @@ declare class QuickSight extends Service {
|
|
|
220
220
|
*/
|
|
221
221
|
deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
|
|
222
222
|
/**
|
|
223
|
-
* Deletes an existing
|
|
223
|
+
* Deletes an existing IAMpolicy assignment.
|
|
224
224
|
*/
|
|
225
225
|
deleteIAMPolicyAssignment(params: QuickSight.Types.DeleteIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
|
|
226
226
|
/**
|
|
227
|
-
* Deletes an existing
|
|
227
|
+
* Deletes an existing IAMpolicy assignment.
|
|
228
228
|
*/
|
|
229
229
|
deleteIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
|
|
230
230
|
/**
|
|
@@ -284,19 +284,19 @@ declare class QuickSight extends Service {
|
|
|
284
284
|
*/
|
|
285
285
|
deleteUserByPrincipalId(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
|
|
286
286
|
/**
|
|
287
|
-
* Describes the customizations associated with the provided Amazon Web Services account
|
|
287
|
+
* Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region;. Amazon Web Services Region; - In each Amazon Web Services Region; where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region;, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region;, you change your Region settings. If you're using the AWS CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region;. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI. Namespace - A Amazon QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region;. Applied customizations - Within an Amazon Web Services Region;, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in other Amazon Web Services Regions;, run the CreateAccountCustomization command in each Amazon Web Services Region; where you want to apply the same customizations.
|
|
288
288
|
*/
|
|
289
289
|
describeAccountCustomization(params: QuickSight.Types.DescribeAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountCustomizationResponse) => void): Request<QuickSight.Types.DescribeAccountCustomizationResponse, AWSError>;
|
|
290
290
|
/**
|
|
291
|
-
* Describes the customizations associated with the provided Amazon Web Services account
|
|
291
|
+
* Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region;. Amazon Web Services Region; - In each Amazon Web Services Region; where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region;, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region;, you change your Region settings. If you're using the AWS CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region;. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI. Namespace - A Amazon QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region;. Applied customizations - Within an Amazon Web Services Region;, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in other Amazon Web Services Regions;, run the CreateAccountCustomization command in each Amazon Web Services Region; where you want to apply the same customizations.
|
|
292
292
|
*/
|
|
293
293
|
describeAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountCustomizationResponse) => void): Request<QuickSight.Types.DescribeAccountCustomizationResponse, AWSError>;
|
|
294
294
|
/**
|
|
295
|
-
* Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account
|
|
295
|
+
* Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
|
|
296
296
|
*/
|
|
297
297
|
describeAccountSettings(params: QuickSight.Types.DescribeAccountSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
|
|
298
298
|
/**
|
|
299
|
-
* Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account
|
|
299
|
+
* Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
|
|
300
300
|
*/
|
|
301
301
|
describeAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
|
|
302
302
|
/**
|
|
@@ -396,11 +396,11 @@ declare class QuickSight extends Service {
|
|
|
396
396
|
*/
|
|
397
397
|
describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
|
|
398
398
|
/**
|
|
399
|
-
* Describes an existing
|
|
399
|
+
* Describes an existing IAMpolicy assignment, as specified by the assignment name.
|
|
400
400
|
*/
|
|
401
401
|
describeIAMPolicyAssignment(params: QuickSight.Types.DescribeIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
|
|
402
402
|
/**
|
|
403
|
-
* Describes an existing
|
|
403
|
+
* Describes an existing IAMpolicy assignment, as specified by the assignment name.
|
|
404
404
|
*/
|
|
405
405
|
describeIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
|
|
406
406
|
/**
|
|
@@ -492,59 +492,59 @@ declare class QuickSight extends Service {
|
|
|
492
492
|
*/
|
|
493
493
|
generateEmbedUrlForRegisteredUser(callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse, AWSError>;
|
|
494
494
|
/**
|
|
495
|
-
* Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
|
495
|
+
* Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
|
496
496
|
*/
|
|
497
497
|
getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
|
|
498
498
|
/**
|
|
499
|
-
* Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
|
499
|
+
* Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
|
500
500
|
*/
|
|
501
501
|
getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
|
|
502
502
|
/**
|
|
503
|
-
* Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding
|
|
503
|
+
* Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding Analytics Customizing Access to the Amazon QuickSight Console
|
|
504
504
|
*/
|
|
505
505
|
getSessionEmbedUrl(params: QuickSight.Types.GetSessionEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetSessionEmbedUrlResponse) => void): Request<QuickSight.Types.GetSessionEmbedUrlResponse, AWSError>;
|
|
506
506
|
/**
|
|
507
|
-
* Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding
|
|
507
|
+
* Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding Analytics Customizing Access to the Amazon QuickSight Console
|
|
508
508
|
*/
|
|
509
509
|
getSessionEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetSessionEmbedUrlResponse) => void): Request<QuickSight.Types.GetSessionEmbedUrlResponse, AWSError>;
|
|
510
510
|
/**
|
|
511
|
-
* Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account
|
|
511
|
+
* Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
|
512
512
|
*/
|
|
513
513
|
listAnalyses(params: QuickSight.Types.ListAnalysesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListAnalysesResponse) => void): Request<QuickSight.Types.ListAnalysesResponse, AWSError>;
|
|
514
514
|
/**
|
|
515
|
-
* Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account
|
|
515
|
+
* Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
|
516
516
|
*/
|
|
517
517
|
listAnalyses(callback?: (err: AWSError, data: QuickSight.Types.ListAnalysesResponse) => void): Request<QuickSight.Types.ListAnalysesResponse, AWSError>;
|
|
518
518
|
/**
|
|
519
|
-
* Lists all the versions of the dashboards in the QuickSight subscription.
|
|
519
|
+
* Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
|
520
520
|
*/
|
|
521
521
|
listDashboardVersions(params: QuickSight.Types.ListDashboardVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
|
|
522
522
|
/**
|
|
523
|
-
* Lists all the versions of the dashboards in the QuickSight subscription.
|
|
523
|
+
* Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
|
524
524
|
*/
|
|
525
525
|
listDashboardVersions(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
|
|
526
526
|
/**
|
|
527
|
-
* Lists dashboards in an Amazon Web Services account
|
|
527
|
+
* Lists dashboards in an Amazon Web Services account.
|
|
528
528
|
*/
|
|
529
529
|
listDashboards(params: QuickSight.Types.ListDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
|
|
530
530
|
/**
|
|
531
|
-
* Lists dashboards in an Amazon Web Services account
|
|
531
|
+
* Lists dashboards in an Amazon Web Services account.
|
|
532
532
|
*/
|
|
533
533
|
listDashboards(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
|
|
534
534
|
/**
|
|
535
|
-
* Lists all of the datasets belonging to the current Amazon Web Services account
|
|
535
|
+
* Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region;. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
|
|
536
536
|
*/
|
|
537
537
|
listDataSets(params: QuickSight.Types.ListDataSetsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
|
|
538
538
|
/**
|
|
539
|
-
* Lists all of the datasets belonging to the current Amazon Web Services account
|
|
539
|
+
* Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region;. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
|
|
540
540
|
*/
|
|
541
541
|
listDataSets(callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
|
|
542
542
|
/**
|
|
543
|
-
* Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account
|
|
543
|
+
* Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account.
|
|
544
544
|
*/
|
|
545
545
|
listDataSources(params: QuickSight.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
|
|
546
546
|
/**
|
|
547
|
-
* Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account
|
|
547
|
+
* Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account.
|
|
548
548
|
*/
|
|
549
549
|
listDataSources(callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
|
|
550
550
|
/**
|
|
@@ -580,19 +580,19 @@ declare class QuickSight extends Service {
|
|
|
580
580
|
*/
|
|
581
581
|
listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
|
|
582
582
|
/**
|
|
583
|
-
* Lists
|
|
583
|
+
* Lists IAMpolicy assignments in the current Amazon QuickSight account.
|
|
584
584
|
*/
|
|
585
585
|
listIAMPolicyAssignments(params: QuickSight.Types.ListIAMPolicyAssignmentsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
|
|
586
586
|
/**
|
|
587
|
-
* Lists
|
|
587
|
+
* Lists IAMpolicy assignments in the current Amazon QuickSight account.
|
|
588
588
|
*/
|
|
589
589
|
listIAMPolicyAssignments(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
|
|
590
590
|
/**
|
|
591
|
-
* Lists all the
|
|
591
|
+
* Lists all the IAMpolicy 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.
|
|
592
592
|
*/
|
|
593
593
|
listIAMPolicyAssignmentsForUser(params: QuickSight.Types.ListIAMPolicyAssignmentsForUserRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
|
|
594
594
|
/**
|
|
595
|
-
* Lists all the
|
|
595
|
+
* Lists all the IAMpolicy 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.
|
|
596
596
|
*/
|
|
597
597
|
listIAMPolicyAssignmentsForUser(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
|
|
598
598
|
/**
|
|
@@ -604,11 +604,11 @@ declare class QuickSight extends Service {
|
|
|
604
604
|
*/
|
|
605
605
|
listIngestions(callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
|
|
606
606
|
/**
|
|
607
|
-
* Lists the namespaces for the specified Amazon Web Services account
|
|
607
|
+
* Lists the namespaces for the specified Amazon Web Services account.
|
|
608
608
|
*/
|
|
609
609
|
listNamespaces(params: QuickSight.Types.ListNamespacesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListNamespacesResponse) => void): Request<QuickSight.Types.ListNamespacesResponse, AWSError>;
|
|
610
610
|
/**
|
|
611
|
-
* Lists the namespaces for the specified Amazon Web Services account
|
|
611
|
+
* Lists the namespaces for the specified Amazon Web Services account.
|
|
612
612
|
*/
|
|
613
613
|
listNamespaces(callback?: (err: AWSError, data: QuickSight.Types.ListNamespacesResponse) => void): Request<QuickSight.Types.ListNamespacesResponse, AWSError>;
|
|
614
614
|
/**
|
|
@@ -652,19 +652,19 @@ declare class QuickSight extends Service {
|
|
|
652
652
|
*/
|
|
653
653
|
listThemeAliases(callback?: (err: AWSError, data: QuickSight.Types.ListThemeAliasesResponse) => void): Request<QuickSight.Types.ListThemeAliasesResponse, AWSError>;
|
|
654
654
|
/**
|
|
655
|
-
* Lists all the versions of the themes in the current Amazon Web Services account
|
|
655
|
+
* Lists all the versions of the themes in the current Amazon Web Services account.
|
|
656
656
|
*/
|
|
657
657
|
listThemeVersions(params: QuickSight.Types.ListThemeVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemeVersionsResponse) => void): Request<QuickSight.Types.ListThemeVersionsResponse, AWSError>;
|
|
658
658
|
/**
|
|
659
|
-
* Lists all the versions of the themes in the current Amazon Web Services account
|
|
659
|
+
* Lists all the versions of the themes in the current Amazon Web Services account.
|
|
660
660
|
*/
|
|
661
661
|
listThemeVersions(callback?: (err: AWSError, data: QuickSight.Types.ListThemeVersionsResponse) => void): Request<QuickSight.Types.ListThemeVersionsResponse, AWSError>;
|
|
662
662
|
/**
|
|
663
|
-
* Lists all the themes in the current Amazon Web Services account
|
|
663
|
+
* Lists all the themes in the current Amazon Web Services account.
|
|
664
664
|
*/
|
|
665
665
|
listThemes(params: QuickSight.Types.ListThemesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemesResponse) => void): Request<QuickSight.Types.ListThemesResponse, AWSError>;
|
|
666
666
|
/**
|
|
667
|
-
* Lists all the themes in the current Amazon Web Services account
|
|
667
|
+
* Lists all the themes in the current Amazon Web Services account.
|
|
668
668
|
*/
|
|
669
669
|
listThemes(callback?: (err: AWSError, data: QuickSight.Types.ListThemesResponse) => void): Request<QuickSight.Types.ListThemesResponse, AWSError>;
|
|
670
670
|
/**
|
|
@@ -724,11 +724,11 @@ declare class QuickSight extends Service {
|
|
|
724
724
|
*/
|
|
725
725
|
searchFolders(callback?: (err: AWSError, data: QuickSight.Types.SearchFoldersResponse) => void): Request<QuickSight.Types.SearchFoldersResponse, AWSError>;
|
|
726
726
|
/**
|
|
727
|
-
* 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 Resource Groups.
|
|
727
|
+
* Assigns one or more tags (key-value pairs) to the specified Amazon 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. Amazon QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for Amazon 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 Amazon QuickSight. This restriction is because Amazon QuickSight costs are based on users and SPICE capacity, which aren't taggable resources. Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.
|
|
728
728
|
*/
|
|
729
729
|
tagResource(params: QuickSight.Types.TagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
|
|
730
730
|
/**
|
|
731
|
-
* 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 Resource Groups.
|
|
731
|
+
* Assigns one or more tags (key-value pairs) to the specified Amazon 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. Amazon QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for Amazon 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 Amazon QuickSight. This restriction is because Amazon QuickSight costs are based on users and SPICE capacity, which aren't taggable resources. Amazon QuickSight doesn't currently support the Tag Editor for Resource Groups.
|
|
732
732
|
*/
|
|
733
733
|
tagResource(callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
|
|
734
734
|
/**
|
|
@@ -740,19 +740,19 @@ declare class QuickSight extends Service {
|
|
|
740
740
|
*/
|
|
741
741
|
untagResource(callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
|
|
742
742
|
/**
|
|
743
|
-
* Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account
|
|
743
|
+
* Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
|
|
744
744
|
*/
|
|
745
745
|
updateAccountCustomization(params: QuickSight.Types.UpdateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
|
|
746
746
|
/**
|
|
747
|
-
* Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account
|
|
747
|
+
* Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
|
|
748
748
|
*/
|
|
749
749
|
updateAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
|
|
750
750
|
/**
|
|
751
|
-
* Updates the Amazon QuickSight settings in your Amazon Web Services account
|
|
751
|
+
* Updates the Amazon QuickSight settings in your Amazon Web Services account.
|
|
752
752
|
*/
|
|
753
753
|
updateAccountSettings(params: QuickSight.Types.UpdateAccountSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountSettingsResponse) => void): Request<QuickSight.Types.UpdateAccountSettingsResponse, AWSError>;
|
|
754
754
|
/**
|
|
755
|
-
* Updates the Amazon QuickSight settings in your Amazon Web Services account
|
|
755
|
+
* Updates the Amazon QuickSight settings in your Amazon Web Services account.
|
|
756
756
|
*/
|
|
757
757
|
updateAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountSettingsResponse) => void): Request<QuickSight.Types.UpdateAccountSettingsResponse, AWSError>;
|
|
758
758
|
/**
|
|
@@ -772,11 +772,11 @@ declare class QuickSight extends Service {
|
|
|
772
772
|
*/
|
|
773
773
|
updateAnalysisPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisPermissionsResponse) => void): Request<QuickSight.Types.UpdateAnalysisPermissionsResponse, AWSError>;
|
|
774
774
|
/**
|
|
775
|
-
* Updates a dashboard in an Amazon Web Services account
|
|
775
|
+
* Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
|
|
776
776
|
*/
|
|
777
777
|
updateDashboard(params: QuickSight.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
|
|
778
778
|
/**
|
|
779
|
-
* Updates a dashboard in an Amazon Web Services account
|
|
779
|
+
* Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
|
|
780
780
|
*/
|
|
781
781
|
updateDashboard(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
|
|
782
782
|
/**
|
|
@@ -852,11 +852,11 @@ declare class QuickSight extends Service {
|
|
|
852
852
|
*/
|
|
853
853
|
updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
|
|
854
854
|
/**
|
|
855
|
-
* Updates an existing
|
|
855
|
+
* Updates an existing IAMpolicy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
|
|
856
856
|
*/
|
|
857
857
|
updateIAMPolicyAssignment(params: QuickSight.Types.UpdateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
|
|
858
858
|
/**
|
|
859
|
-
* Updates an existing
|
|
859
|
+
* Updates an existing IAMpolicy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
|
|
860
860
|
*/
|
|
861
861
|
updateIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
|
|
862
862
|
/**
|
|
@@ -919,32 +919,32 @@ declare class QuickSight extends Service {
|
|
|
919
919
|
declare namespace QuickSight {
|
|
920
920
|
export interface AccountCustomization {
|
|
921
921
|
/**
|
|
922
|
-
* The default theme for this QuickSight subscription.
|
|
922
|
+
* The default theme for this Amazon QuickSight subscription.
|
|
923
923
|
*/
|
|
924
924
|
DefaultTheme?: Arn;
|
|
925
925
|
}
|
|
926
926
|
export interface AccountSettings {
|
|
927
927
|
/**
|
|
928
|
-
* The "account name" you provided for the QuickSight subscription in your Amazon Web Services account
|
|
928
|
+
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
|
|
929
929
|
*/
|
|
930
930
|
AccountName?: String;
|
|
931
931
|
/**
|
|
932
|
-
* The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
|
|
932
|
+
* The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
|
|
933
933
|
*/
|
|
934
934
|
Edition?: Edition;
|
|
935
935
|
/**
|
|
936
|
-
* The default QuickSight namespace for your Amazon Web Services account
|
|
936
|
+
* The default Amazon QuickSight namespace for your Amazon Web Services account.
|
|
937
937
|
*/
|
|
938
938
|
DefaultNamespace?: Namespace;
|
|
939
939
|
/**
|
|
940
|
-
* The main notification email for your QuickSight subscription.
|
|
940
|
+
* The main notification email for your Amazon QuickSight subscription.
|
|
941
941
|
*/
|
|
942
942
|
NotificationEmail?: String;
|
|
943
943
|
}
|
|
944
944
|
export type ActionList = String[];
|
|
945
945
|
export interface ActiveIAMPolicyAssignment {
|
|
946
946
|
/**
|
|
947
|
-
* A name for the
|
|
947
|
+
* A name for the IAMpolicy assignment.
|
|
948
948
|
*/
|
|
949
949
|
AssignmentName?: IAMPolicyAssignmentName;
|
|
950
950
|
/**
|
|
@@ -963,7 +963,7 @@ declare namespace QuickSight {
|
|
|
963
963
|
export type AliasName = string;
|
|
964
964
|
export interface AmazonElasticsearchParameters {
|
|
965
965
|
/**
|
|
966
|
-
* The
|
|
966
|
+
* The Elasticsearch domain.
|
|
967
967
|
*/
|
|
968
968
|
Domain: Domain;
|
|
969
969
|
}
|
|
@@ -1064,7 +1064,7 @@ declare namespace QuickSight {
|
|
|
1064
1064
|
*/
|
|
1065
1065
|
AnalysisId?: RestrictiveResourceId;
|
|
1066
1066
|
/**
|
|
1067
|
-
* The name of the analysis. This name is displayed in the QuickSight console.
|
|
1067
|
+
* The name of the analysis. This name is displayed in the Amazon QuickSight console.
|
|
1068
1068
|
*/
|
|
1069
1069
|
Name?: AnalysisName;
|
|
1070
1070
|
/**
|
|
@@ -1118,15 +1118,15 @@ declare namespace QuickSight {
|
|
|
1118
1118
|
}
|
|
1119
1119
|
export interface AuroraPostgreSqlParameters {
|
|
1120
1120
|
/**
|
|
1121
|
-
*
|
|
1121
|
+
* The Amazon Aurora PostgreSQL-Compatible host to connect to.
|
|
1122
1122
|
*/
|
|
1123
1123
|
Host: Host;
|
|
1124
1124
|
/**
|
|
1125
|
-
*
|
|
1125
|
+
* The port that Amazon Aurora PostgreSQL is listening on.
|
|
1126
1126
|
*/
|
|
1127
1127
|
Port: Port;
|
|
1128
1128
|
/**
|
|
1129
|
-
*
|
|
1129
|
+
* The Amazon Aurora PostgreSQL database to connect to.
|
|
1130
1130
|
*/
|
|
1131
1131
|
Database: Database;
|
|
1132
1132
|
}
|
|
@@ -1162,7 +1162,7 @@ declare namespace QuickSight {
|
|
|
1162
1162
|
export type CalculatedColumnList = CalculatedColumn[];
|
|
1163
1163
|
export interface CancelIngestionRequest {
|
|
1164
1164
|
/**
|
|
1165
|
-
* The Amazon Web Services account
|
|
1165
|
+
* The Amazon Web Services account ID.
|
|
1166
1166
|
*/
|
|
1167
1167
|
AwsAccountId: AwsAccountId;
|
|
1168
1168
|
/**
|
|
@@ -1246,7 +1246,7 @@ declare namespace QuickSight {
|
|
|
1246
1246
|
export type ColumnId = string;
|
|
1247
1247
|
export interface ColumnLevelPermissionRule {
|
|
1248
1248
|
/**
|
|
1249
|
-
* An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
|
|
1249
|
+
* An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
|
|
1250
1250
|
*/
|
|
1251
1251
|
Principals?: PrincipalList;
|
|
1252
1252
|
/**
|
|
@@ -1284,18 +1284,20 @@ declare namespace QuickSight {
|
|
|
1284
1284
|
ColumnDescription?: ColumnDescription;
|
|
1285
1285
|
}
|
|
1286
1286
|
export type ColumnTagList = ColumnTag[];
|
|
1287
|
+
export type ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE"|"COLUMN_DESCRIPTION"|string;
|
|
1288
|
+
export type ColumnTagNames = ColumnTagName[];
|
|
1287
1289
|
export type CopySourceArn = string;
|
|
1288
1290
|
export interface CreateAccountCustomizationRequest {
|
|
1289
1291
|
/**
|
|
1290
|
-
* The ID for the Amazon Web Services account
|
|
1292
|
+
* The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
|
|
1291
1293
|
*/
|
|
1292
1294
|
AwsAccountId: AwsAccountId;
|
|
1293
1295
|
/**
|
|
1294
|
-
* The QuickSight namespace that you want to add customizations to.
|
|
1296
|
+
* The Amazon QuickSight namespace that you want to add customizations to.
|
|
1295
1297
|
*/
|
|
1296
1298
|
Namespace?: Namespace;
|
|
1297
1299
|
/**
|
|
1298
|
-
* The QuickSight customizations you're adding in the current Amazon Web Services Region;. You can add these to an Amazon Web Services account
|
|
1300
|
+
* The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region;. You can add these to an Amazon Web Services account and a Amazon QuickSight namespace. For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.
|
|
1299
1301
|
*/
|
|
1300
1302
|
AccountCustomization: AccountCustomization;
|
|
1301
1303
|
/**
|
|
@@ -1305,11 +1307,11 @@ declare namespace QuickSight {
|
|
|
1305
1307
|
}
|
|
1306
1308
|
export interface CreateAccountCustomizationResponse {
|
|
1307
1309
|
/**
|
|
1308
|
-
* The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account
|
|
1310
|
+
* The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.
|
|
1309
1311
|
*/
|
|
1310
1312
|
Arn?: Arn;
|
|
1311
1313
|
/**
|
|
1312
|
-
* The ID for the Amazon Web Services account
|
|
1314
|
+
* The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
|
|
1313
1315
|
*/
|
|
1314
1316
|
AwsAccountId?: AwsAccountId;
|
|
1315
1317
|
/**
|
|
@@ -1317,7 +1319,7 @@ declare namespace QuickSight {
|
|
|
1317
1319
|
*/
|
|
1318
1320
|
Namespace?: Namespace;
|
|
1319
1321
|
/**
|
|
1320
|
-
* The QuickSight customizations you're adding in the current Amazon Web Services Region;.
|
|
1322
|
+
* The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region;.
|
|
1321
1323
|
*/
|
|
1322
1324
|
AccountCustomization?: AccountCustomization;
|
|
1323
1325
|
/**
|
|
@@ -1331,7 +1333,7 @@ declare namespace QuickSight {
|
|
|
1331
1333
|
}
|
|
1332
1334
|
export interface CreateAnalysisRequest {
|
|
1333
1335
|
/**
|
|
1334
|
-
* The ID of the Amazon Web Services account
|
|
1336
|
+
* The ID of the Amazon Web Services account where you are creating an analysis.
|
|
1335
1337
|
*/
|
|
1336
1338
|
AwsAccountId: AwsAccountId;
|
|
1337
1339
|
/**
|
|
@@ -1339,7 +1341,7 @@ declare namespace QuickSight {
|
|
|
1339
1341
|
*/
|
|
1340
1342
|
AnalysisId: RestrictiveResourceId;
|
|
1341
1343
|
/**
|
|
1342
|
-
* A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
|
|
1344
|
+
* A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.
|
|
1343
1345
|
*/
|
|
1344
1346
|
Name: AnalysisName;
|
|
1345
1347
|
/**
|
|
@@ -1355,7 +1357,7 @@ declare namespace QuickSight {
|
|
|
1355
1357
|
*/
|
|
1356
1358
|
SourceEntity: AnalysisSourceEntity;
|
|
1357
1359
|
/**
|
|
1358
|
-
* The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
|
|
1360
|
+
* The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
|
|
1359
1361
|
*/
|
|
1360
1362
|
ThemeArn?: Arn;
|
|
1361
1363
|
/**
|
|
@@ -1393,11 +1395,11 @@ declare namespace QuickSight {
|
|
|
1393
1395
|
}
|
|
1394
1396
|
export interface CreateDashboardRequest {
|
|
1395
1397
|
/**
|
|
1396
|
-
* The ID of the Amazon Web Services account
|
|
1398
|
+
* The ID of the Amazon Web Services account where you want to create the dashboard.
|
|
1397
1399
|
*/
|
|
1398
1400
|
AwsAccountId: AwsAccountId;
|
|
1399
1401
|
/**
|
|
1400
|
-
* The ID for the dashboard, also added to the
|
|
1402
|
+
* The ID for the dashboard, also added to the IAMpolicy.
|
|
1401
1403
|
*/
|
|
1402
1404
|
DashboardId: RestrictiveResourceId;
|
|
1403
1405
|
/**
|
|
@@ -1409,11 +1411,11 @@ declare namespace QuickSight {
|
|
|
1409
1411
|
*/
|
|
1410
1412
|
Parameters?: Parameters;
|
|
1411
1413
|
/**
|
|
1412
|
-
* A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of
|
|
1414
|
+
* A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN. To specify no permissions, omit the permissions list.
|
|
1413
1415
|
*/
|
|
1414
1416
|
Permissions?: ResourcePermissionList;
|
|
1415
1417
|
/**
|
|
1416
|
-
* The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account
|
|
1418
|
+
* The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
|
|
1417
1419
|
*/
|
|
1418
1420
|
SourceEntity: DashboardSourceEntity;
|
|
1419
1421
|
/**
|
|
@@ -1425,11 +1427,11 @@ declare namespace QuickSight {
|
|
|
1425
1427
|
*/
|
|
1426
1428
|
VersionDescription?: VersionDescription;
|
|
1427
1429
|
/**
|
|
1428
|
-
* 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. This option is COLLAPSED by default.
|
|
1430
|
+
* 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, Amazon 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. This option is COLLAPSED by default.
|
|
1429
1431
|
*/
|
|
1430
1432
|
DashboardPublishOptions?: DashboardPublishOptions;
|
|
1431
1433
|
/**
|
|
1432
|
-
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account
|
|
1434
|
+
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
|
|
1433
1435
|
*/
|
|
1434
1436
|
ThemeArn?: Arn;
|
|
1435
1437
|
}
|
|
@@ -1461,11 +1463,11 @@ declare namespace QuickSight {
|
|
|
1461
1463
|
}
|
|
1462
1464
|
export interface CreateDataSetRequest {
|
|
1463
1465
|
/**
|
|
1464
|
-
* The Amazon Web Services account
|
|
1466
|
+
* The Amazon Web Services account ID.
|
|
1465
1467
|
*/
|
|
1466
1468
|
AwsAccountId: AwsAccountId;
|
|
1467
1469
|
/**
|
|
1468
|
-
* An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1470
|
+
* An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
1469
1471
|
*/
|
|
1470
1472
|
DataSetId: ResourceId;
|
|
1471
1473
|
/**
|
|
@@ -1485,7 +1487,7 @@ declare namespace QuickSight {
|
|
|
1485
1487
|
*/
|
|
1486
1488
|
ImportMode: DataSetImportMode;
|
|
1487
1489
|
/**
|
|
1488
|
-
* Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
|
|
1490
|
+
* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
|
|
1489
1491
|
*/
|
|
1490
1492
|
ColumnGroups?: ColumnGroupList;
|
|
1491
1493
|
/**
|
|
@@ -1512,6 +1514,7 @@ declare namespace QuickSight {
|
|
|
1512
1514
|
* Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
|
|
1513
1515
|
*/
|
|
1514
1516
|
Tags?: TagList;
|
|
1517
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
1515
1518
|
}
|
|
1516
1519
|
export interface CreateDataSetResponse {
|
|
1517
1520
|
/**
|
|
@@ -1519,7 +1522,7 @@ declare namespace QuickSight {
|
|
|
1519
1522
|
*/
|
|
1520
1523
|
Arn?: Arn;
|
|
1521
1524
|
/**
|
|
1522
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1525
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
1523
1526
|
*/
|
|
1524
1527
|
DataSetId?: ResourceId;
|
|
1525
1528
|
/**
|
|
@@ -1541,11 +1544,11 @@ declare namespace QuickSight {
|
|
|
1541
1544
|
}
|
|
1542
1545
|
export interface CreateDataSourceRequest {
|
|
1543
1546
|
/**
|
|
1544
|
-
* The Amazon Web Services account
|
|
1547
|
+
* The Amazon Web Services account ID.
|
|
1545
1548
|
*/
|
|
1546
1549
|
AwsAccountId: AwsAccountId;
|
|
1547
1550
|
/**
|
|
1548
|
-
* An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1551
|
+
* An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
1549
1552
|
*/
|
|
1550
1553
|
DataSourceId: ResourceId;
|
|
1551
1554
|
/**
|
|
@@ -1553,15 +1556,15 @@ declare namespace QuickSight {
|
|
|
1553
1556
|
*/
|
|
1554
1557
|
Name: ResourceName;
|
|
1555
1558
|
/**
|
|
1556
|
-
* The type of the data source.
|
|
1559
|
+
* The type of the data source. To return a list of all data sources, use ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon Elasticsearch Service.
|
|
1557
1560
|
*/
|
|
1558
1561
|
Type: DataSourceType;
|
|
1559
1562
|
/**
|
|
1560
|
-
* The parameters that QuickSight uses to connect to your underlying source.
|
|
1563
|
+
* The parameters that Amazon QuickSight uses to connect to your underlying source.
|
|
1561
1564
|
*/
|
|
1562
1565
|
DataSourceParameters?: DataSourceParameters;
|
|
1563
1566
|
/**
|
|
1564
|
-
* The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
|
|
1567
|
+
* The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
|
|
1565
1568
|
*/
|
|
1566
1569
|
Credentials?: DataSourceCredentials;
|
|
1567
1570
|
/**
|
|
@@ -1569,11 +1572,11 @@ declare namespace QuickSight {
|
|
|
1569
1572
|
*/
|
|
1570
1573
|
Permissions?: ResourcePermissionList;
|
|
1571
1574
|
/**
|
|
1572
|
-
* Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
|
|
1575
|
+
* Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
|
1573
1576
|
*/
|
|
1574
1577
|
VpcConnectionProperties?: VpcConnectionProperties;
|
|
1575
1578
|
/**
|
|
1576
|
-
* Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
|
|
1579
|
+
* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
|
1577
1580
|
*/
|
|
1578
1581
|
SslProperties?: SslProperties;
|
|
1579
1582
|
/**
|
|
@@ -1587,7 +1590,7 @@ declare namespace QuickSight {
|
|
|
1587
1590
|
*/
|
|
1588
1591
|
Arn?: Arn;
|
|
1589
1592
|
/**
|
|
1590
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1593
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
1591
1594
|
*/
|
|
1592
1595
|
DataSourceId?: ResourceId;
|
|
1593
1596
|
/**
|
|
@@ -1693,7 +1696,7 @@ declare namespace QuickSight {
|
|
|
1693
1696
|
*/
|
|
1694
1697
|
GroupName: GroupName;
|
|
1695
1698
|
/**
|
|
1696
|
-
* The ID for the Amazon Web Services account
|
|
1699
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
1697
1700
|
*/
|
|
1698
1701
|
AwsAccountId: AwsAccountId;
|
|
1699
1702
|
/**
|
|
@@ -1725,7 +1728,7 @@ declare namespace QuickSight {
|
|
|
1725
1728
|
*/
|
|
1726
1729
|
Description?: GroupDescription;
|
|
1727
1730
|
/**
|
|
1728
|
-
* The ID for the Amazon Web Services account
|
|
1731
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
1729
1732
|
*/
|
|
1730
1733
|
AwsAccountId: AwsAccountId;
|
|
1731
1734
|
/**
|
|
@@ -1749,11 +1752,11 @@ declare namespace QuickSight {
|
|
|
1749
1752
|
}
|
|
1750
1753
|
export interface CreateIAMPolicyAssignmentRequest {
|
|
1751
1754
|
/**
|
|
1752
|
-
* The ID of the Amazon Web Services account
|
|
1755
|
+
* The ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or groups.
|
|
1753
1756
|
*/
|
|
1754
1757
|
AwsAccountId: AwsAccountId;
|
|
1755
1758
|
/**
|
|
1756
|
-
* The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account
|
|
1759
|
+
* The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.
|
|
1757
1760
|
*/
|
|
1758
1761
|
AssignmentName: IAMPolicyAssignmentName;
|
|
1759
1762
|
/**
|
|
@@ -1761,11 +1764,11 @@ declare namespace QuickSight {
|
|
|
1761
1764
|
*/
|
|
1762
1765
|
AssignmentStatus: AssignmentStatus;
|
|
1763
1766
|
/**
|
|
1764
|
-
* The ARN for the
|
|
1767
|
+
* The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups specified in this assignment.
|
|
1765
1768
|
*/
|
|
1766
1769
|
PolicyArn?: Arn;
|
|
1767
1770
|
/**
|
|
1768
|
-
* The QuickSight users, groups, or both that you want to assign the policy to.
|
|
1771
|
+
* The Amazon QuickSight users, groups, or both that you want to assign the policy to.
|
|
1769
1772
|
*/
|
|
1770
1773
|
Identities?: IdentityMap;
|
|
1771
1774
|
/**
|
|
@@ -1775,7 +1778,7 @@ declare namespace QuickSight {
|
|
|
1775
1778
|
}
|
|
1776
1779
|
export interface CreateIAMPolicyAssignmentResponse {
|
|
1777
1780
|
/**
|
|
1778
|
-
* The name of the assignment. This name must be unique within the Amazon Web Services account
|
|
1781
|
+
* The name of the assignment. This name must be unique within the Amazon Web Services account.
|
|
1779
1782
|
*/
|
|
1780
1783
|
AssignmentName?: IAMPolicyAssignmentName;
|
|
1781
1784
|
/**
|
|
@@ -1787,11 +1790,11 @@ declare namespace QuickSight {
|
|
|
1787
1790
|
*/
|
|
1788
1791
|
AssignmentStatus?: AssignmentStatus;
|
|
1789
1792
|
/**
|
|
1790
|
-
* The ARN for the
|
|
1793
|
+
* The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.
|
|
1791
1794
|
*/
|
|
1792
1795
|
PolicyArn?: Arn;
|
|
1793
1796
|
/**
|
|
1794
|
-
* The QuickSight users, groups, or both that the
|
|
1797
|
+
* The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.
|
|
1795
1798
|
*/
|
|
1796
1799
|
Identities?: IdentityMap;
|
|
1797
1800
|
/**
|
|
@@ -1813,7 +1816,7 @@ declare namespace QuickSight {
|
|
|
1813
1816
|
*/
|
|
1814
1817
|
IngestionId: IngestionId;
|
|
1815
1818
|
/**
|
|
1816
|
-
* The Amazon Web Services account
|
|
1819
|
+
* The Amazon Web Services account ID.
|
|
1817
1820
|
*/
|
|
1818
1821
|
AwsAccountId: AwsAccountId;
|
|
1819
1822
|
}
|
|
@@ -1841,7 +1844,7 @@ declare namespace QuickSight {
|
|
|
1841
1844
|
}
|
|
1842
1845
|
export interface CreateNamespaceRequest {
|
|
1843
1846
|
/**
|
|
1844
|
-
* The ID for the Amazon Web Services account
|
|
1847
|
+
* The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
|
|
1845
1848
|
*/
|
|
1846
1849
|
AwsAccountId: AwsAccountId;
|
|
1847
1850
|
/**
|
|
@@ -1859,7 +1862,7 @@ declare namespace QuickSight {
|
|
|
1859
1862
|
}
|
|
1860
1863
|
export interface CreateNamespaceResponse {
|
|
1861
1864
|
/**
|
|
1862
|
-
* The ARN of the QuickSight namespace you created.
|
|
1865
|
+
* The ARN of the Amazon QuickSight namespace you created.
|
|
1863
1866
|
*/
|
|
1864
1867
|
Arn?: Arn;
|
|
1865
1868
|
/**
|
|
@@ -1889,7 +1892,7 @@ declare namespace QuickSight {
|
|
|
1889
1892
|
}
|
|
1890
1893
|
export interface CreateTemplateAliasRequest {
|
|
1891
1894
|
/**
|
|
1892
|
-
* The ID of the Amazon Web Services account
|
|
1895
|
+
* The ID of the Amazon Web Services account that contains the template that you creating an alias for.
|
|
1893
1896
|
*/
|
|
1894
1897
|
AwsAccountId: AwsAccountId;
|
|
1895
1898
|
/**
|
|
@@ -1921,11 +1924,11 @@ declare namespace QuickSight {
|
|
|
1921
1924
|
}
|
|
1922
1925
|
export interface CreateTemplateRequest {
|
|
1923
1926
|
/**
|
|
1924
|
-
* The ID for the Amazon Web Services account
|
|
1927
|
+
* The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
1925
1928
|
*/
|
|
1926
1929
|
AwsAccountId: AwsAccountId;
|
|
1927
1930
|
/**
|
|
1928
|
-
* An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account
|
|
1931
|
+
* An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.
|
|
1929
1932
|
*/
|
|
1930
1933
|
TemplateId: RestrictiveResourceId;
|
|
1931
1934
|
/**
|
|
@@ -1937,7 +1940,7 @@ declare namespace QuickSight {
|
|
|
1937
1940
|
*/
|
|
1938
1941
|
Permissions?: ResourcePermissionList;
|
|
1939
1942
|
/**
|
|
1940
|
-
* The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account
|
|
1943
|
+
* The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
|
|
1941
1944
|
*/
|
|
1942
1945
|
SourceEntity: TemplateSourceEntity;
|
|
1943
1946
|
/**
|
|
@@ -1977,7 +1980,7 @@ declare namespace QuickSight {
|
|
|
1977
1980
|
}
|
|
1978
1981
|
export interface CreateThemeAliasRequest {
|
|
1979
1982
|
/**
|
|
1980
|
-
* The ID of the Amazon Web Services account
|
|
1983
|
+
* The ID of the Amazon Web Services account that contains the theme for the new theme alias.
|
|
1981
1984
|
*/
|
|
1982
1985
|
AwsAccountId: AwsAccountId;
|
|
1983
1986
|
/**
|
|
@@ -2009,11 +2012,11 @@ declare namespace QuickSight {
|
|
|
2009
2012
|
}
|
|
2010
2013
|
export interface CreateThemeRequest {
|
|
2011
2014
|
/**
|
|
2012
|
-
* The ID of the Amazon Web Services account
|
|
2015
|
+
* The ID of the Amazon Web Services account where you want to store the new theme.
|
|
2013
2016
|
*/
|
|
2014
2017
|
AwsAccountId: AwsAccountId;
|
|
2015
2018
|
/**
|
|
2016
|
-
* An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region
|
|
2019
|
+
* An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
|
|
2017
2020
|
*/
|
|
2018
2021
|
ThemeId: RestrictiveResourceId;
|
|
2019
2022
|
/**
|
|
@@ -2021,7 +2024,7 @@ declare namespace QuickSight {
|
|
|
2021
2024
|
*/
|
|
2022
2025
|
Name: ThemeName;
|
|
2023
2026
|
/**
|
|
2024
|
-
* The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.
|
|
2027
|
+
* The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a Amazon QuickSight analysis.
|
|
2025
2028
|
*/
|
|
2026
2029
|
BaseThemeId: RestrictiveResourceId;
|
|
2027
2030
|
/**
|
|
@@ -2366,6 +2369,10 @@ declare namespace QuickSight {
|
|
|
2366
2369
|
* A set of one or more definitions of a ColumnLevelPermissionRule .
|
|
2367
2370
|
*/
|
|
2368
2371
|
ColumnLevelPermissionRules?: ColumnLevelPermissionRuleList;
|
|
2372
|
+
/**
|
|
2373
|
+
* The usage configuration to apply to child datasets that reference this dataset as a source.
|
|
2374
|
+
*/
|
|
2375
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
2369
2376
|
}
|
|
2370
2377
|
export type DataSetArnsList = Arn[];
|
|
2371
2378
|
export interface DataSetConfiguration {
|
|
@@ -2441,13 +2448,23 @@ declare namespace QuickSight {
|
|
|
2441
2448
|
ColumnLevelPermissionRulesApplied?: Boolean;
|
|
2442
2449
|
}
|
|
2443
2450
|
export type DataSetSummaryList = DataSetSummary[];
|
|
2451
|
+
export interface DataSetUsageConfiguration {
|
|
2452
|
+
/**
|
|
2453
|
+
* An option that controls whether a child dataset of a direct query can use this dataset as a source.
|
|
2454
|
+
*/
|
|
2455
|
+
DisableUseAsDirectQuerySource?: Boolean;
|
|
2456
|
+
/**
|
|
2457
|
+
* An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
|
|
2458
|
+
*/
|
|
2459
|
+
DisableUseAsImportedSource?: Boolean;
|
|
2460
|
+
}
|
|
2444
2461
|
export interface DataSource {
|
|
2445
2462
|
/**
|
|
2446
2463
|
* The Amazon Resource Name (ARN) of the data source.
|
|
2447
2464
|
*/
|
|
2448
2465
|
Arn?: Arn;
|
|
2449
2466
|
/**
|
|
2450
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2467
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
2451
2468
|
*/
|
|
2452
2469
|
DataSourceId?: ResourceId;
|
|
2453
2470
|
/**
|
|
@@ -2479,11 +2496,11 @@ declare namespace QuickSight {
|
|
|
2479
2496
|
*/
|
|
2480
2497
|
AlternateDataSourceParameters?: DataSourceParametersList;
|
|
2481
2498
|
/**
|
|
2482
|
-
* 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.
|
|
2499
|
+
* The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
|
2483
2500
|
*/
|
|
2484
2501
|
VpcConnectionProperties?: VpcConnectionProperties;
|
|
2485
2502
|
/**
|
|
2486
|
-
* Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
|
|
2503
|
+
* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
|
2487
2504
|
*/
|
|
2488
2505
|
SslProperties?: SslProperties;
|
|
2489
2506
|
/**
|
|
@@ -2515,83 +2532,83 @@ declare namespace QuickSight {
|
|
|
2515
2532
|
export type DataSourceList = DataSource[];
|
|
2516
2533
|
export interface DataSourceParameters {
|
|
2517
2534
|
/**
|
|
2518
|
-
*
|
|
2535
|
+
* The parameters for Elasticsearch.
|
|
2519
2536
|
*/
|
|
2520
2537
|
AmazonElasticsearchParameters?: AmazonElasticsearchParameters;
|
|
2521
2538
|
/**
|
|
2522
|
-
* Amazon Athena
|
|
2539
|
+
* The parameters for Amazon Athena.
|
|
2523
2540
|
*/
|
|
2524
2541
|
AthenaParameters?: AthenaParameters;
|
|
2525
2542
|
/**
|
|
2526
|
-
* Amazon Aurora MySQL
|
|
2543
|
+
* The parameters for Amazon Aurora MySQL.
|
|
2527
2544
|
*/
|
|
2528
2545
|
AuroraParameters?: AuroraParameters;
|
|
2529
2546
|
/**
|
|
2530
|
-
*
|
|
2547
|
+
* The parameters for Amazon Aurora.
|
|
2531
2548
|
*/
|
|
2532
2549
|
AuroraPostgreSqlParameters?: AuroraPostgreSqlParameters;
|
|
2533
2550
|
/**
|
|
2534
|
-
*
|
|
2551
|
+
* The parameters for IoT Analytics.
|
|
2535
2552
|
*/
|
|
2536
2553
|
AwsIotAnalyticsParameters?: AwsIotAnalyticsParameters;
|
|
2537
2554
|
/**
|
|
2538
|
-
*
|
|
2555
|
+
* The parameters for Jira.
|
|
2539
2556
|
*/
|
|
2540
2557
|
JiraParameters?: JiraParameters;
|
|
2541
2558
|
/**
|
|
2542
|
-
*
|
|
2559
|
+
* The parameters for MariaDB.
|
|
2543
2560
|
*/
|
|
2544
2561
|
MariaDbParameters?: MariaDbParameters;
|
|
2545
2562
|
/**
|
|
2546
|
-
*
|
|
2563
|
+
* The parameters for MySQL.
|
|
2547
2564
|
*/
|
|
2548
2565
|
MySqlParameters?: MySqlParameters;
|
|
2549
2566
|
/**
|
|
2550
|
-
*
|
|
2567
|
+
* The parameters for Oracle.
|
|
2551
2568
|
*/
|
|
2552
2569
|
OracleParameters?: OracleParameters;
|
|
2553
2570
|
/**
|
|
2554
|
-
*
|
|
2571
|
+
* The parameters for PostgreSQL.
|
|
2555
2572
|
*/
|
|
2556
2573
|
PostgreSqlParameters?: PostgreSqlParameters;
|
|
2557
2574
|
/**
|
|
2558
|
-
*
|
|
2575
|
+
* The parameters for Presto.
|
|
2559
2576
|
*/
|
|
2560
2577
|
PrestoParameters?: PrestoParameters;
|
|
2561
2578
|
/**
|
|
2562
|
-
* Amazon RDS
|
|
2579
|
+
* The parameters for Amazon RDS.
|
|
2563
2580
|
*/
|
|
2564
2581
|
RdsParameters?: RdsParameters;
|
|
2565
2582
|
/**
|
|
2566
|
-
* Amazon Redshift
|
|
2583
|
+
* The parameters for Amazon Redshift.
|
|
2567
2584
|
*/
|
|
2568
2585
|
RedshiftParameters?: RedshiftParameters;
|
|
2569
2586
|
/**
|
|
2570
|
-
*
|
|
2587
|
+
* The parameters for S3.
|
|
2571
2588
|
*/
|
|
2572
2589
|
S3Parameters?: S3Parameters;
|
|
2573
2590
|
/**
|
|
2574
|
-
*
|
|
2591
|
+
* The parameters for ServiceNow.
|
|
2575
2592
|
*/
|
|
2576
2593
|
ServiceNowParameters?: ServiceNowParameters;
|
|
2577
2594
|
/**
|
|
2578
|
-
*
|
|
2595
|
+
* The parameters for Snowflake.
|
|
2579
2596
|
*/
|
|
2580
2597
|
SnowflakeParameters?: SnowflakeParameters;
|
|
2581
2598
|
/**
|
|
2582
|
-
*
|
|
2599
|
+
* The parameters for Spark.
|
|
2583
2600
|
*/
|
|
2584
2601
|
SparkParameters?: SparkParameters;
|
|
2585
2602
|
/**
|
|
2586
|
-
* SQL Server
|
|
2603
|
+
* The parameters for SQL Server.
|
|
2587
2604
|
*/
|
|
2588
2605
|
SqlServerParameters?: SqlServerParameters;
|
|
2589
2606
|
/**
|
|
2590
|
-
*
|
|
2607
|
+
* The parameters for Teradata.
|
|
2591
2608
|
*/
|
|
2592
2609
|
TeradataParameters?: TeradataParameters;
|
|
2593
2610
|
/**
|
|
2594
|
-
*
|
|
2611
|
+
* The parameters for Twitter.
|
|
2595
2612
|
*/
|
|
2596
2613
|
TwitterParameters?: TwitterParameters;
|
|
2597
2614
|
}
|
|
@@ -2622,11 +2639,11 @@ declare namespace QuickSight {
|
|
|
2622
2639
|
export type DecimalParameterList = DecimalParameter[];
|
|
2623
2640
|
export interface DeleteAccountCustomizationRequest {
|
|
2624
2641
|
/**
|
|
2625
|
-
* The ID for the Amazon Web Services account
|
|
2642
|
+
* The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region;.
|
|
2626
2643
|
*/
|
|
2627
2644
|
AwsAccountId: AwsAccountId;
|
|
2628
2645
|
/**
|
|
2629
|
-
* The QuickSight namespace that you're deleting the customizations from.
|
|
2646
|
+
* The Amazon QuickSight namespace that you're deleting the customizations from.
|
|
2630
2647
|
*/
|
|
2631
2648
|
Namespace?: Namespace;
|
|
2632
2649
|
}
|
|
@@ -2642,7 +2659,7 @@ declare namespace QuickSight {
|
|
|
2642
2659
|
}
|
|
2643
2660
|
export interface DeleteAnalysisRequest {
|
|
2644
2661
|
/**
|
|
2645
|
-
* The ID of the Amazon Web Services account
|
|
2662
|
+
* The ID of the Amazon Web Services account where you want to delete an analysis.
|
|
2646
2663
|
*/
|
|
2647
2664
|
AwsAccountId: AwsAccountId;
|
|
2648
2665
|
/**
|
|
@@ -2650,7 +2667,7 @@ declare namespace QuickSight {
|
|
|
2650
2667
|
*/
|
|
2651
2668
|
AnalysisId: RestrictiveResourceId;
|
|
2652
2669
|
/**
|
|
2653
|
-
* A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
|
|
2670
|
+
* A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
|
|
2654
2671
|
*/
|
|
2655
2672
|
RecoveryWindowInDays?: RecoveryWindowInDays;
|
|
2656
2673
|
/**
|
|
@@ -2682,7 +2699,7 @@ declare namespace QuickSight {
|
|
|
2682
2699
|
}
|
|
2683
2700
|
export interface DeleteDashboardRequest {
|
|
2684
2701
|
/**
|
|
2685
|
-
* The ID of the Amazon Web Services account
|
|
2702
|
+
* The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
|
|
2686
2703
|
*/
|
|
2687
2704
|
AwsAccountId: AwsAccountId;
|
|
2688
2705
|
/**
|
|
@@ -2714,11 +2731,11 @@ declare namespace QuickSight {
|
|
|
2714
2731
|
}
|
|
2715
2732
|
export interface DeleteDataSetRequest {
|
|
2716
2733
|
/**
|
|
2717
|
-
* The Amazon Web Services account
|
|
2734
|
+
* The Amazon Web Services account ID.
|
|
2718
2735
|
*/
|
|
2719
2736
|
AwsAccountId: AwsAccountId;
|
|
2720
2737
|
/**
|
|
2721
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2738
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
2722
2739
|
*/
|
|
2723
2740
|
DataSetId: ResourceId;
|
|
2724
2741
|
}
|
|
@@ -2728,7 +2745,7 @@ declare namespace QuickSight {
|
|
|
2728
2745
|
*/
|
|
2729
2746
|
Arn?: Arn;
|
|
2730
2747
|
/**
|
|
2731
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2748
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
2732
2749
|
*/
|
|
2733
2750
|
DataSetId?: ResourceId;
|
|
2734
2751
|
/**
|
|
@@ -2742,11 +2759,11 @@ declare namespace QuickSight {
|
|
|
2742
2759
|
}
|
|
2743
2760
|
export interface DeleteDataSourceRequest {
|
|
2744
2761
|
/**
|
|
2745
|
-
* The Amazon Web Services account
|
|
2762
|
+
* The Amazon Web Services account ID.
|
|
2746
2763
|
*/
|
|
2747
2764
|
AwsAccountId: AwsAccountId;
|
|
2748
2765
|
/**
|
|
2749
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2766
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
2750
2767
|
*/
|
|
2751
2768
|
DataSourceId: ResourceId;
|
|
2752
2769
|
}
|
|
@@ -2756,7 +2773,7 @@ declare namespace QuickSight {
|
|
|
2756
2773
|
*/
|
|
2757
2774
|
Arn?: Arn;
|
|
2758
2775
|
/**
|
|
2759
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2776
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
2760
2777
|
*/
|
|
2761
2778
|
DataSourceId?: ResourceId;
|
|
2762
2779
|
/**
|
|
@@ -2834,7 +2851,7 @@ declare namespace QuickSight {
|
|
|
2834
2851
|
*/
|
|
2835
2852
|
GroupName: GroupName;
|
|
2836
2853
|
/**
|
|
2837
|
-
* The ID for the Amazon Web Services account
|
|
2854
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
2838
2855
|
*/
|
|
2839
2856
|
AwsAccountId: AwsAccountId;
|
|
2840
2857
|
/**
|
|
@@ -2858,7 +2875,7 @@ declare namespace QuickSight {
|
|
|
2858
2875
|
*/
|
|
2859
2876
|
GroupName: GroupName;
|
|
2860
2877
|
/**
|
|
2861
|
-
* The ID for the Amazon Web Services account
|
|
2878
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
2862
2879
|
*/
|
|
2863
2880
|
AwsAccountId: AwsAccountId;
|
|
2864
2881
|
/**
|
|
@@ -2878,7 +2895,7 @@ declare namespace QuickSight {
|
|
|
2878
2895
|
}
|
|
2879
2896
|
export interface DeleteIAMPolicyAssignmentRequest {
|
|
2880
2897
|
/**
|
|
2881
|
-
* The Amazon Web Services account
|
|
2898
|
+
* The Amazon Web Services account ID where you want to delete the IAMpolicy assignment.
|
|
2882
2899
|
*/
|
|
2883
2900
|
AwsAccountId: AwsAccountId;
|
|
2884
2901
|
/**
|
|
@@ -2906,7 +2923,7 @@ declare namespace QuickSight {
|
|
|
2906
2923
|
}
|
|
2907
2924
|
export interface DeleteNamespaceRequest {
|
|
2908
2925
|
/**
|
|
2909
|
-
* The ID for the Amazon Web Services account
|
|
2926
|
+
* The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
|
|
2910
2927
|
*/
|
|
2911
2928
|
AwsAccountId: AwsAccountId;
|
|
2912
2929
|
/**
|
|
@@ -2926,7 +2943,7 @@ declare namespace QuickSight {
|
|
|
2926
2943
|
}
|
|
2927
2944
|
export interface DeleteTemplateAliasRequest {
|
|
2928
2945
|
/**
|
|
2929
|
-
* The ID of the Amazon Web Services account
|
|
2946
|
+
* The ID of the Amazon Web Services account that contains the item to delete.
|
|
2930
2947
|
*/
|
|
2931
2948
|
AwsAccountId: AwsAccountId;
|
|
2932
2949
|
/**
|
|
@@ -2962,7 +2979,7 @@ declare namespace QuickSight {
|
|
|
2962
2979
|
}
|
|
2963
2980
|
export interface DeleteTemplateRequest {
|
|
2964
2981
|
/**
|
|
2965
|
-
* The ID of the Amazon Web Services account
|
|
2982
|
+
* The ID of the Amazon Web Services account that contains the template that you're deleting.
|
|
2966
2983
|
*/
|
|
2967
2984
|
AwsAccountId: AwsAccountId;
|
|
2968
2985
|
/**
|
|
@@ -2994,7 +3011,7 @@ declare namespace QuickSight {
|
|
|
2994
3011
|
}
|
|
2995
3012
|
export interface DeleteThemeAliasRequest {
|
|
2996
3013
|
/**
|
|
2997
|
-
* The ID of the Amazon Web Services account
|
|
3014
|
+
* The ID of the Amazon Web Services account that contains the theme alias to delete.
|
|
2998
3015
|
*/
|
|
2999
3016
|
AwsAccountId: AwsAccountId;
|
|
3000
3017
|
/**
|
|
@@ -3030,7 +3047,7 @@ declare namespace QuickSight {
|
|
|
3030
3047
|
}
|
|
3031
3048
|
export interface DeleteThemeRequest {
|
|
3032
3049
|
/**
|
|
3033
|
-
* The ID of the Amazon Web Services account
|
|
3050
|
+
* The ID of the Amazon Web Services account that contains the theme that you're deleting.
|
|
3034
3051
|
*/
|
|
3035
3052
|
AwsAccountId: AwsAccountId;
|
|
3036
3053
|
/**
|
|
@@ -3066,7 +3083,7 @@ declare namespace QuickSight {
|
|
|
3066
3083
|
*/
|
|
3067
3084
|
PrincipalId: String;
|
|
3068
3085
|
/**
|
|
3069
|
-
* The ID for the Amazon Web Services account
|
|
3086
|
+
* The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
3070
3087
|
*/
|
|
3071
3088
|
AwsAccountId: AwsAccountId;
|
|
3072
3089
|
/**
|
|
@@ -3090,7 +3107,7 @@ declare namespace QuickSight {
|
|
|
3090
3107
|
*/
|
|
3091
3108
|
UserName: UserName;
|
|
3092
3109
|
/**
|
|
3093
|
-
* The ID for the Amazon Web Services account
|
|
3110
|
+
* The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
3094
3111
|
*/
|
|
3095
3112
|
AwsAccountId: AwsAccountId;
|
|
3096
3113
|
/**
|
|
@@ -3111,33 +3128,33 @@ declare namespace QuickSight {
|
|
|
3111
3128
|
export type Delimiter = string;
|
|
3112
3129
|
export interface DescribeAccountCustomizationRequest {
|
|
3113
3130
|
/**
|
|
3114
|
-
* The ID for the Amazon Web Services account
|
|
3131
|
+
* The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.
|
|
3115
3132
|
*/
|
|
3116
3133
|
AwsAccountId: AwsAccountId;
|
|
3117
3134
|
/**
|
|
3118
|
-
* The QuickSight namespace that you want to describe QuickSight customizations for.
|
|
3135
|
+
* The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.
|
|
3119
3136
|
*/
|
|
3120
3137
|
Namespace?: Namespace;
|
|
3121
3138
|
/**
|
|
3122
|
-
* The Resolved flag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.
|
|
3139
|
+
* The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.
|
|
3123
3140
|
*/
|
|
3124
3141
|
Resolved?: boolean;
|
|
3125
3142
|
}
|
|
3126
3143
|
export interface DescribeAccountCustomizationResponse {
|
|
3127
3144
|
/**
|
|
3128
|
-
* The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account
|
|
3145
|
+
* The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.
|
|
3129
3146
|
*/
|
|
3130
3147
|
Arn?: Arn;
|
|
3131
3148
|
/**
|
|
3132
|
-
* The ID for the Amazon Web Services account
|
|
3149
|
+
* The ID for the Amazon Web Services account that you're describing.
|
|
3133
3150
|
*/
|
|
3134
3151
|
AwsAccountId?: AwsAccountId;
|
|
3135
3152
|
/**
|
|
3136
|
-
* The QuickSight namespace that you're describing.
|
|
3153
|
+
* The Amazon QuickSight namespace that you're describing.
|
|
3137
3154
|
*/
|
|
3138
3155
|
Namespace?: Namespace;
|
|
3139
3156
|
/**
|
|
3140
|
-
* The QuickSight customizations that exist in the current Amazon Web Services Region;.
|
|
3157
|
+
* The Amazon QuickSight customizations that exist in the current Amazon Web Services Region;.
|
|
3141
3158
|
*/
|
|
3142
3159
|
AccountCustomization?: AccountCustomization;
|
|
3143
3160
|
/**
|
|
@@ -3151,13 +3168,13 @@ declare namespace QuickSight {
|
|
|
3151
3168
|
}
|
|
3152
3169
|
export interface DescribeAccountSettingsRequest {
|
|
3153
3170
|
/**
|
|
3154
|
-
* The ID for the Amazon Web Services account
|
|
3171
|
+
* The ID for the Amazon Web Services account that contains the settings that you want to list.
|
|
3155
3172
|
*/
|
|
3156
3173
|
AwsAccountId: AwsAccountId;
|
|
3157
3174
|
}
|
|
3158
3175
|
export interface DescribeAccountSettingsResponse {
|
|
3159
3176
|
/**
|
|
3160
|
-
* The QuickSight settings for this Amazon Web Services account
|
|
3177
|
+
* The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a Amazon QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region; where you use it.
|
|
3161
3178
|
*/
|
|
3162
3179
|
AccountSettings?: AccountSettings;
|
|
3163
3180
|
/**
|
|
@@ -3171,7 +3188,7 @@ declare namespace QuickSight {
|
|
|
3171
3188
|
}
|
|
3172
3189
|
export interface DescribeAnalysisPermissionsRequest {
|
|
3173
3190
|
/**
|
|
3174
|
-
* The ID of the Amazon Web Services account
|
|
3191
|
+
* The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
|
|
3175
3192
|
*/
|
|
3176
3193
|
AwsAccountId: AwsAccountId;
|
|
3177
3194
|
/**
|
|
@@ -3203,7 +3220,7 @@ declare namespace QuickSight {
|
|
|
3203
3220
|
}
|
|
3204
3221
|
export interface DescribeAnalysisRequest {
|
|
3205
3222
|
/**
|
|
3206
|
-
* The ID of the Amazon Web Services account
|
|
3223
|
+
* The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
|
|
3207
3224
|
*/
|
|
3208
3225
|
AwsAccountId: AwsAccountId;
|
|
3209
3226
|
/**
|
|
@@ -3227,11 +3244,11 @@ declare namespace QuickSight {
|
|
|
3227
3244
|
}
|
|
3228
3245
|
export interface DescribeDashboardPermissionsRequest {
|
|
3229
3246
|
/**
|
|
3230
|
-
* The ID of the Amazon Web Services account
|
|
3247
|
+
* The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.
|
|
3231
3248
|
*/
|
|
3232
3249
|
AwsAccountId: AwsAccountId;
|
|
3233
3250
|
/**
|
|
3234
|
-
* The ID for the dashboard, also added to the
|
|
3251
|
+
* The ID for the dashboard, also added to the IAMpolicy.
|
|
3235
3252
|
*/
|
|
3236
3253
|
DashboardId: RestrictiveResourceId;
|
|
3237
3254
|
}
|
|
@@ -3259,7 +3276,7 @@ declare namespace QuickSight {
|
|
|
3259
3276
|
}
|
|
3260
3277
|
export interface DescribeDashboardRequest {
|
|
3261
3278
|
/**
|
|
3262
|
-
* The ID of the Amazon Web Services account
|
|
3279
|
+
* The ID of the Amazon Web Services account that contains the dashboard that you're describing.
|
|
3263
3280
|
*/
|
|
3264
3281
|
AwsAccountId: AwsAccountId;
|
|
3265
3282
|
/**
|
|
@@ -3291,11 +3308,11 @@ declare namespace QuickSight {
|
|
|
3291
3308
|
}
|
|
3292
3309
|
export interface DescribeDataSetPermissionsRequest {
|
|
3293
3310
|
/**
|
|
3294
|
-
* The Amazon Web Services account
|
|
3311
|
+
* The Amazon Web Services account ID.
|
|
3295
3312
|
*/
|
|
3296
3313
|
AwsAccountId: AwsAccountId;
|
|
3297
3314
|
/**
|
|
3298
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3315
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
3299
3316
|
*/
|
|
3300
3317
|
DataSetId: ResourceId;
|
|
3301
3318
|
}
|
|
@@ -3305,7 +3322,7 @@ declare namespace QuickSight {
|
|
|
3305
3322
|
*/
|
|
3306
3323
|
DataSetArn?: Arn;
|
|
3307
3324
|
/**
|
|
3308
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3325
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
3309
3326
|
*/
|
|
3310
3327
|
DataSetId?: ResourceId;
|
|
3311
3328
|
/**
|
|
@@ -3323,11 +3340,11 @@ declare namespace QuickSight {
|
|
|
3323
3340
|
}
|
|
3324
3341
|
export interface DescribeDataSetRequest {
|
|
3325
3342
|
/**
|
|
3326
|
-
* The Amazon Web Services account
|
|
3343
|
+
* The Amazon Web Services account ID.
|
|
3327
3344
|
*/
|
|
3328
3345
|
AwsAccountId: AwsAccountId;
|
|
3329
3346
|
/**
|
|
3330
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3347
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
3331
3348
|
*/
|
|
3332
3349
|
DataSetId: ResourceId;
|
|
3333
3350
|
}
|
|
@@ -3347,11 +3364,11 @@ declare namespace QuickSight {
|
|
|
3347
3364
|
}
|
|
3348
3365
|
export interface DescribeDataSourcePermissionsRequest {
|
|
3349
3366
|
/**
|
|
3350
|
-
* The Amazon Web Services account
|
|
3367
|
+
* The Amazon Web Services account ID.
|
|
3351
3368
|
*/
|
|
3352
3369
|
AwsAccountId: AwsAccountId;
|
|
3353
3370
|
/**
|
|
3354
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3371
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
3355
3372
|
*/
|
|
3356
3373
|
DataSourceId: ResourceId;
|
|
3357
3374
|
}
|
|
@@ -3361,7 +3378,7 @@ declare namespace QuickSight {
|
|
|
3361
3378
|
*/
|
|
3362
3379
|
DataSourceArn?: Arn;
|
|
3363
3380
|
/**
|
|
3364
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3381
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
3365
3382
|
*/
|
|
3366
3383
|
DataSourceId?: ResourceId;
|
|
3367
3384
|
/**
|
|
@@ -3379,11 +3396,11 @@ declare namespace QuickSight {
|
|
|
3379
3396
|
}
|
|
3380
3397
|
export interface DescribeDataSourceRequest {
|
|
3381
3398
|
/**
|
|
3382
|
-
* The Amazon Web Services account
|
|
3399
|
+
* The Amazon Web Services account ID.
|
|
3383
3400
|
*/
|
|
3384
3401
|
AwsAccountId: AwsAccountId;
|
|
3385
3402
|
/**
|
|
3386
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3403
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
3387
3404
|
*/
|
|
3388
3405
|
DataSourceId: ResourceId;
|
|
3389
3406
|
}
|
|
@@ -3495,7 +3512,7 @@ declare namespace QuickSight {
|
|
|
3495
3512
|
*/
|
|
3496
3513
|
GroupName: GroupName;
|
|
3497
3514
|
/**
|
|
3498
|
-
* The ID for the Amazon Web Services account
|
|
3515
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
3499
3516
|
*/
|
|
3500
3517
|
AwsAccountId: AwsAccountId;
|
|
3501
3518
|
/**
|
|
@@ -3519,7 +3536,7 @@ declare namespace QuickSight {
|
|
|
3519
3536
|
}
|
|
3520
3537
|
export interface DescribeIAMPolicyAssignmentRequest {
|
|
3521
3538
|
/**
|
|
3522
|
-
* The ID of the Amazon Web Services account
|
|
3539
|
+
* The ID of the Amazon Web Services account that contains the assignment that you want to describe.
|
|
3523
3540
|
*/
|
|
3524
3541
|
AwsAccountId: AwsAccountId;
|
|
3525
3542
|
/**
|
|
@@ -3533,7 +3550,7 @@ declare namespace QuickSight {
|
|
|
3533
3550
|
}
|
|
3534
3551
|
export interface DescribeIAMPolicyAssignmentResponse {
|
|
3535
3552
|
/**
|
|
3536
|
-
* Information describing the
|
|
3553
|
+
* Information describing the IAMpolicy assignment.
|
|
3537
3554
|
*/
|
|
3538
3555
|
IAMPolicyAssignment?: IAMPolicyAssignment;
|
|
3539
3556
|
/**
|
|
@@ -3547,7 +3564,7 @@ declare namespace QuickSight {
|
|
|
3547
3564
|
}
|
|
3548
3565
|
export interface DescribeIngestionRequest {
|
|
3549
3566
|
/**
|
|
3550
|
-
* The Amazon Web Services account
|
|
3567
|
+
* The Amazon Web Services account ID.
|
|
3551
3568
|
*/
|
|
3552
3569
|
AwsAccountId: AwsAccountId;
|
|
3553
3570
|
/**
|
|
@@ -3575,7 +3592,7 @@ declare namespace QuickSight {
|
|
|
3575
3592
|
}
|
|
3576
3593
|
export interface DescribeNamespaceRequest {
|
|
3577
3594
|
/**
|
|
3578
|
-
* The ID for the Amazon Web Services account
|
|
3595
|
+
* The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
|
|
3579
3596
|
*/
|
|
3580
3597
|
AwsAccountId: AwsAccountId;
|
|
3581
3598
|
/**
|
|
@@ -3599,7 +3616,7 @@ declare namespace QuickSight {
|
|
|
3599
3616
|
}
|
|
3600
3617
|
export interface DescribeTemplateAliasRequest {
|
|
3601
3618
|
/**
|
|
3602
|
-
* The ID of the Amazon Web Services account
|
|
3619
|
+
* The ID of the Amazon Web Services account that contains the template alias that you're describing.
|
|
3603
3620
|
*/
|
|
3604
3621
|
AwsAccountId: AwsAccountId;
|
|
3605
3622
|
/**
|
|
@@ -3627,7 +3644,7 @@ declare namespace QuickSight {
|
|
|
3627
3644
|
}
|
|
3628
3645
|
export interface DescribeTemplatePermissionsRequest {
|
|
3629
3646
|
/**
|
|
3630
|
-
* The ID of the Amazon Web Services account
|
|
3647
|
+
* The ID of the Amazon Web Services account that contains the template that you're describing.
|
|
3631
3648
|
*/
|
|
3632
3649
|
AwsAccountId: AwsAccountId;
|
|
3633
3650
|
/**
|
|
@@ -3659,7 +3676,7 @@ declare namespace QuickSight {
|
|
|
3659
3676
|
}
|
|
3660
3677
|
export interface DescribeTemplateRequest {
|
|
3661
3678
|
/**
|
|
3662
|
-
* The ID of the Amazon Web Services account
|
|
3679
|
+
* The ID of the Amazon Web Services account that contains the template that you're describing.
|
|
3663
3680
|
*/
|
|
3664
3681
|
AwsAccountId: AwsAccountId;
|
|
3665
3682
|
/**
|
|
@@ -3691,7 +3708,7 @@ declare namespace QuickSight {
|
|
|
3691
3708
|
}
|
|
3692
3709
|
export interface DescribeThemeAliasRequest {
|
|
3693
3710
|
/**
|
|
3694
|
-
* The ID of the Amazon Web Services account
|
|
3711
|
+
* The ID of the Amazon Web Services account that contains the theme alias that you're describing.
|
|
3695
3712
|
*/
|
|
3696
3713
|
AwsAccountId: AwsAccountId;
|
|
3697
3714
|
/**
|
|
@@ -3719,7 +3736,7 @@ declare namespace QuickSight {
|
|
|
3719
3736
|
}
|
|
3720
3737
|
export interface DescribeThemePermissionsRequest {
|
|
3721
3738
|
/**
|
|
3722
|
-
* The ID of the Amazon Web Services account
|
|
3739
|
+
* The ID of the Amazon Web Services account that contains the theme that you're describing.
|
|
3723
3740
|
*/
|
|
3724
3741
|
AwsAccountId: AwsAccountId;
|
|
3725
3742
|
/**
|
|
@@ -3751,7 +3768,7 @@ declare namespace QuickSight {
|
|
|
3751
3768
|
}
|
|
3752
3769
|
export interface DescribeThemeRequest {
|
|
3753
3770
|
/**
|
|
3754
|
-
* The ID of the Amazon Web Services account
|
|
3771
|
+
* The ID of the Amazon Web Services account that contains the theme that you're describing.
|
|
3755
3772
|
*/
|
|
3756
3773
|
AwsAccountId: AwsAndAccountId;
|
|
3757
3774
|
/**
|
|
@@ -3787,7 +3804,7 @@ declare namespace QuickSight {
|
|
|
3787
3804
|
*/
|
|
3788
3805
|
UserName: UserName;
|
|
3789
3806
|
/**
|
|
3790
|
-
* The ID for the Amazon Web Services account
|
|
3807
|
+
* The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
3791
3808
|
*/
|
|
3792
3809
|
AwsAccountId: AwsAccountId;
|
|
3793
3810
|
/**
|
|
@@ -4032,7 +4049,7 @@ declare namespace QuickSight {
|
|
|
4032
4049
|
export type GeoSpatialDataRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"|string;
|
|
4033
4050
|
export interface GetDashboardEmbedUrlRequest {
|
|
4034
4051
|
/**
|
|
4035
|
-
* The ID for the Amazon Web Services account
|
|
4052
|
+
* The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
|
|
4036
4053
|
*/
|
|
4037
4054
|
AwsAccountId: AwsAccountId;
|
|
4038
4055
|
/**
|
|
@@ -4056,19 +4073,19 @@ declare namespace QuickSight {
|
|
|
4056
4073
|
*/
|
|
4057
4074
|
ResetDisabled?: Boolean;
|
|
4058
4075
|
/**
|
|
4059
|
-
* Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
|
|
4076
|
+
* Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
|
|
4060
4077
|
*/
|
|
4061
4078
|
StatePersistenceEnabled?: Boolean;
|
|
4062
4079
|
/**
|
|
4063
|
-
* 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
|
|
4080
|
+
* 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 IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAMfederation. Omit this parameter for users in the third group – IAMusers and IAM role-based sessions.
|
|
4064
4081
|
*/
|
|
4065
4082
|
UserArn?: Arn;
|
|
4066
4083
|
/**
|
|
4067
|
-
* The Amazon QuickSight namespace that the
|
|
4084
|
+
* The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.
|
|
4068
4085
|
*/
|
|
4069
4086
|
Namespace?: Namespace;
|
|
4070
4087
|
/**
|
|
4071
|
-
* A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or
|
|
4088
|
+
* A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as Amazon QuickSight or IAMusers. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
|
|
4072
4089
|
*/
|
|
4073
4090
|
AdditionalDashboardIds?: AdditionalDashboardIdList;
|
|
4074
4091
|
}
|
|
@@ -4088,11 +4105,11 @@ declare namespace QuickSight {
|
|
|
4088
4105
|
}
|
|
4089
4106
|
export interface GetSessionEmbedUrlRequest {
|
|
4090
4107
|
/**
|
|
4091
|
-
* The ID for the Amazon Web Services account
|
|
4108
|
+
* The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
|
|
4092
4109
|
*/
|
|
4093
4110
|
AwsAccountId: AwsAccountId;
|
|
4094
4111
|
/**
|
|
4095
|
-
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths: /start /start/analyses /start/dashboards /start/favorites /dashboards/DashboardId - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard /analyses/AnalysisId - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis
|
|
4112
|
+
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths: /start /start/analyses /start/dashboards /start/favorites /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis
|
|
4096
4113
|
*/
|
|
4097
4114
|
EntryPoint?: EntryPoint;
|
|
4098
4115
|
/**
|
|
@@ -4106,7 +4123,7 @@ declare namespace QuickSight {
|
|
|
4106
4123
|
}
|
|
4107
4124
|
export interface GetSessionEmbedUrlResponse {
|
|
4108
4125
|
/**
|
|
4109
|
-
* A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
|
|
4126
|
+
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
|
|
4110
4127
|
*/
|
|
4111
4128
|
EmbedUrl?: EmbeddingUrl;
|
|
4112
4129
|
/**
|
|
@@ -4161,7 +4178,7 @@ declare namespace QuickSight {
|
|
|
4161
4178
|
export type Host = string;
|
|
4162
4179
|
export interface IAMPolicyAssignment {
|
|
4163
4180
|
/**
|
|
4164
|
-
* The Amazon Web Services account
|
|
4181
|
+
* The Amazon Web Services account ID.
|
|
4165
4182
|
*/
|
|
4166
4183
|
AwsAccountId?: AwsAccountId;
|
|
4167
4184
|
/**
|
|
@@ -4173,7 +4190,7 @@ declare namespace QuickSight {
|
|
|
4173
4190
|
*/
|
|
4174
4191
|
AssignmentName?: IAMPolicyAssignmentName;
|
|
4175
4192
|
/**
|
|
4176
|
-
* The Amazon Resource Name (ARN) for the
|
|
4193
|
+
* The Amazon Resource Name (ARN) for the IAMpolicy.
|
|
4177
4194
|
*/
|
|
4178
4195
|
PolicyArn?: Arn;
|
|
4179
4196
|
/**
|
|
@@ -4307,14 +4324,14 @@ declare namespace QuickSight {
|
|
|
4307
4324
|
}
|
|
4308
4325
|
export interface JoinKeyProperties {
|
|
4309
4326
|
/**
|
|
4310
|
-
* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by QuickSight to optimize query performance.
|
|
4327
|
+
* A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
|
|
4311
4328
|
*/
|
|
4312
4329
|
UniqueKey?: Boolean;
|
|
4313
4330
|
}
|
|
4314
4331
|
export type JoinType = "INNER"|"OUTER"|"LEFT"|"RIGHT"|string;
|
|
4315
4332
|
export interface ListAnalysesRequest {
|
|
4316
4333
|
/**
|
|
4317
|
-
* The ID of the Amazon Web Services account
|
|
4334
|
+
* The ID of the Amazon Web Services account that contains the analyses.
|
|
4318
4335
|
*/
|
|
4319
4336
|
AwsAccountId: AwsAccountId;
|
|
4320
4337
|
/**
|
|
@@ -4346,7 +4363,7 @@ declare namespace QuickSight {
|
|
|
4346
4363
|
}
|
|
4347
4364
|
export interface ListDashboardVersionsRequest {
|
|
4348
4365
|
/**
|
|
4349
|
-
* The ID of the Amazon Web Services account
|
|
4366
|
+
* The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
|
|
4350
4367
|
*/
|
|
4351
4368
|
AwsAccountId: AwsAccountId;
|
|
4352
4369
|
/**
|
|
@@ -4382,7 +4399,7 @@ declare namespace QuickSight {
|
|
|
4382
4399
|
}
|
|
4383
4400
|
export interface ListDashboardsRequest {
|
|
4384
4401
|
/**
|
|
4385
|
-
* The ID of the Amazon Web Services account
|
|
4402
|
+
* The ID of the Amazon Web Services account that contains the dashboards that you're listing.
|
|
4386
4403
|
*/
|
|
4387
4404
|
AwsAccountId: AwsAccountId;
|
|
4388
4405
|
/**
|
|
@@ -4396,7 +4413,7 @@ declare namespace QuickSight {
|
|
|
4396
4413
|
}
|
|
4397
4414
|
export interface ListDashboardsResponse {
|
|
4398
4415
|
/**
|
|
4399
|
-
* A structure that contains all of the dashboards in your Amazon Web Services account
|
|
4416
|
+
* A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.
|
|
4400
4417
|
*/
|
|
4401
4418
|
DashboardSummaryList?: DashboardSummaryList;
|
|
4402
4419
|
/**
|
|
@@ -4414,7 +4431,7 @@ declare namespace QuickSight {
|
|
|
4414
4431
|
}
|
|
4415
4432
|
export interface ListDataSetsRequest {
|
|
4416
4433
|
/**
|
|
4417
|
-
* The Amazon Web Services account
|
|
4434
|
+
* The Amazon Web Services account ID.
|
|
4418
4435
|
*/
|
|
4419
4436
|
AwsAccountId: AwsAccountId;
|
|
4420
4437
|
/**
|
|
@@ -4446,7 +4463,7 @@ declare namespace QuickSight {
|
|
|
4446
4463
|
}
|
|
4447
4464
|
export interface ListDataSourcesRequest {
|
|
4448
4465
|
/**
|
|
4449
|
-
* The Amazon Web Services account
|
|
4466
|
+
* The Amazon Web Services account ID.
|
|
4450
4467
|
*/
|
|
4451
4468
|
AwsAccountId: AwsAccountId;
|
|
4452
4469
|
/**
|
|
@@ -4558,7 +4575,7 @@ declare namespace QuickSight {
|
|
|
4558
4575
|
*/
|
|
4559
4576
|
MaxResults?: MaxResults;
|
|
4560
4577
|
/**
|
|
4561
|
-
* The ID for the Amazon Web Services account
|
|
4578
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
4562
4579
|
*/
|
|
4563
4580
|
AwsAccountId: AwsAccountId;
|
|
4564
4581
|
/**
|
|
@@ -4586,7 +4603,7 @@ declare namespace QuickSight {
|
|
|
4586
4603
|
}
|
|
4587
4604
|
export interface ListGroupsRequest {
|
|
4588
4605
|
/**
|
|
4589
|
-
* The ID for the Amazon Web Services account
|
|
4606
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
4590
4607
|
*/
|
|
4591
4608
|
AwsAccountId: AwsAccountId;
|
|
4592
4609
|
/**
|
|
@@ -4622,7 +4639,7 @@ declare namespace QuickSight {
|
|
|
4622
4639
|
}
|
|
4623
4640
|
export interface ListIAMPolicyAssignmentsForUserRequest {
|
|
4624
4641
|
/**
|
|
4625
|
-
* The ID of the Amazon Web Services account
|
|
4642
|
+
* The ID of the Amazon Web Services account that contains the assignments.
|
|
4626
4643
|
*/
|
|
4627
4644
|
AwsAccountId: AwsAccountId;
|
|
4628
4645
|
/**
|
|
@@ -4662,7 +4679,7 @@ declare namespace QuickSight {
|
|
|
4662
4679
|
}
|
|
4663
4680
|
export interface ListIAMPolicyAssignmentsRequest {
|
|
4664
4681
|
/**
|
|
4665
|
-
* The ID of the Amazon Web Services account
|
|
4682
|
+
* The ID of the Amazon Web Services account that contains these IAMpolicy assignments.
|
|
4666
4683
|
*/
|
|
4667
4684
|
AwsAccountId: AwsAccountId;
|
|
4668
4685
|
/**
|
|
@@ -4684,7 +4701,7 @@ declare namespace QuickSight {
|
|
|
4684
4701
|
}
|
|
4685
4702
|
export interface ListIAMPolicyAssignmentsResponse {
|
|
4686
4703
|
/**
|
|
4687
|
-
* Information describing the
|
|
4704
|
+
* Information describing the IAMpolicy assignments.
|
|
4688
4705
|
*/
|
|
4689
4706
|
IAMPolicyAssignments?: IAMPolicyAssignmentSummaryList;
|
|
4690
4707
|
/**
|
|
@@ -4710,7 +4727,7 @@ declare namespace QuickSight {
|
|
|
4710
4727
|
*/
|
|
4711
4728
|
NextToken?: string;
|
|
4712
4729
|
/**
|
|
4713
|
-
* The Amazon Web Services account
|
|
4730
|
+
* The Amazon Web Services account ID.
|
|
4714
4731
|
*/
|
|
4715
4732
|
AwsAccountId: AwsAccountId;
|
|
4716
4733
|
/**
|
|
@@ -4738,7 +4755,7 @@ declare namespace QuickSight {
|
|
|
4738
4755
|
}
|
|
4739
4756
|
export interface ListNamespacesRequest {
|
|
4740
4757
|
/**
|
|
4741
|
-
* The ID for the Amazon Web Services account
|
|
4758
|
+
* The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
|
|
4742
4759
|
*/
|
|
4743
4760
|
AwsAccountId: AwsAccountId;
|
|
4744
4761
|
/**
|
|
@@ -4752,7 +4769,7 @@ declare namespace QuickSight {
|
|
|
4752
4769
|
}
|
|
4753
4770
|
export interface ListNamespacesResponse {
|
|
4754
4771
|
/**
|
|
4755
|
-
* The information about the namespaces in this Amazon Web Services account
|
|
4772
|
+
* The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region;, notification email address, creation status, and identity store.
|
|
4756
4773
|
*/
|
|
4757
4774
|
Namespaces?: Namespaces;
|
|
4758
4775
|
/**
|
|
@@ -4790,7 +4807,7 @@ declare namespace QuickSight {
|
|
|
4790
4807
|
}
|
|
4791
4808
|
export interface ListTemplateAliasesRequest {
|
|
4792
4809
|
/**
|
|
4793
|
-
* The ID of the Amazon Web Services account
|
|
4810
|
+
* The ID of the Amazon Web Services account that contains the template aliases that you're listing.
|
|
4794
4811
|
*/
|
|
4795
4812
|
AwsAccountId: AwsAccountId;
|
|
4796
4813
|
/**
|
|
@@ -4826,7 +4843,7 @@ declare namespace QuickSight {
|
|
|
4826
4843
|
}
|
|
4827
4844
|
export interface ListTemplateVersionsRequest {
|
|
4828
4845
|
/**
|
|
4829
|
-
* The ID of the Amazon Web Services account
|
|
4846
|
+
* The ID of the Amazon Web Services account that contains the templates that you're listing.
|
|
4830
4847
|
*/
|
|
4831
4848
|
AwsAccountId: AwsAccountId;
|
|
4832
4849
|
/**
|
|
@@ -4862,7 +4879,7 @@ declare namespace QuickSight {
|
|
|
4862
4879
|
}
|
|
4863
4880
|
export interface ListTemplatesRequest {
|
|
4864
4881
|
/**
|
|
4865
|
-
* The ID of the Amazon Web Services account
|
|
4882
|
+
* The ID of the Amazon Web Services account that contains the templates that you're listing.
|
|
4866
4883
|
*/
|
|
4867
4884
|
AwsAccountId: AwsAccountId;
|
|
4868
4885
|
/**
|
|
@@ -4894,7 +4911,7 @@ declare namespace QuickSight {
|
|
|
4894
4911
|
}
|
|
4895
4912
|
export interface ListThemeAliasesRequest {
|
|
4896
4913
|
/**
|
|
4897
|
-
* The ID of the Amazon Web Services account
|
|
4914
|
+
* The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
|
|
4898
4915
|
*/
|
|
4899
4916
|
AwsAccountId: AwsAccountId;
|
|
4900
4917
|
/**
|
|
@@ -4930,7 +4947,7 @@ declare namespace QuickSight {
|
|
|
4930
4947
|
}
|
|
4931
4948
|
export interface ListThemeVersionsRequest {
|
|
4932
4949
|
/**
|
|
4933
|
-
* The ID of the Amazon Web Services account
|
|
4950
|
+
* The ID of the Amazon Web Services account that contains the themes that you're listing.
|
|
4934
4951
|
*/
|
|
4935
4952
|
AwsAccountId: AwsAccountId;
|
|
4936
4953
|
/**
|
|
@@ -4966,7 +4983,7 @@ declare namespace QuickSight {
|
|
|
4966
4983
|
}
|
|
4967
4984
|
export interface ListThemesRequest {
|
|
4968
4985
|
/**
|
|
4969
|
-
* The ID of the Amazon Web Services account
|
|
4986
|
+
* The ID of the Amazon Web Services account that contains the themes that you're listing.
|
|
4970
4987
|
*/
|
|
4971
4988
|
AwsAccountId: AwsAccountId;
|
|
4972
4989
|
/**
|
|
@@ -5006,7 +5023,7 @@ declare namespace QuickSight {
|
|
|
5006
5023
|
*/
|
|
5007
5024
|
UserName: UserName;
|
|
5008
5025
|
/**
|
|
5009
|
-
* The Amazon Web Services account
|
|
5026
|
+
* The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
5010
5027
|
*/
|
|
5011
5028
|
AwsAccountId: AwsAccountId;
|
|
5012
5029
|
/**
|
|
@@ -5042,7 +5059,7 @@ declare namespace QuickSight {
|
|
|
5042
5059
|
}
|
|
5043
5060
|
export interface ListUsersRequest {
|
|
5044
5061
|
/**
|
|
5045
|
-
* The ID for the Amazon Web Services account
|
|
5062
|
+
* The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
5046
5063
|
*/
|
|
5047
5064
|
AwsAccountId: AwsAccountId;
|
|
5048
5065
|
/**
|
|
@@ -5102,6 +5119,10 @@ declare namespace QuickSight {
|
|
|
5102
5119
|
* Physical table ID.
|
|
5103
5120
|
*/
|
|
5104
5121
|
PhysicalTableId?: PhysicalTableId;
|
|
5122
|
+
/**
|
|
5123
|
+
* The Amazon Resource Number (ARN) of the parent dataset.
|
|
5124
|
+
*/
|
|
5125
|
+
DataSetArn?: Arn;
|
|
5105
5126
|
}
|
|
5106
5127
|
export type Long = number;
|
|
5107
5128
|
export type LongList = Long[];
|
|
@@ -5235,19 +5256,19 @@ declare namespace QuickSight {
|
|
|
5235
5256
|
export type OutputColumnList = OutputColumn[];
|
|
5236
5257
|
export interface Parameters {
|
|
5237
5258
|
/**
|
|
5238
|
-
*
|
|
5259
|
+
* The parameters that have a data type of string.
|
|
5239
5260
|
*/
|
|
5240
5261
|
StringParameters?: StringParameterList;
|
|
5241
5262
|
/**
|
|
5242
|
-
*
|
|
5263
|
+
* The parameters that have a data type of integer.
|
|
5243
5264
|
*/
|
|
5244
5265
|
IntegerParameters?: IntegerParameterList;
|
|
5245
5266
|
/**
|
|
5246
|
-
*
|
|
5267
|
+
* The parameters that have a data type of decimal.
|
|
5247
5268
|
*/
|
|
5248
5269
|
DecimalParameters?: DecimalParameterList;
|
|
5249
5270
|
/**
|
|
5250
|
-
*
|
|
5271
|
+
* The parameters that have a data type of date-time.
|
|
5251
5272
|
*/
|
|
5252
5273
|
DateTimeParameters?: DateTimeParameterList;
|
|
5253
5274
|
}
|
|
@@ -5350,7 +5371,7 @@ declare namespace QuickSight {
|
|
|
5350
5371
|
}
|
|
5351
5372
|
export interface RegisterUserRequest {
|
|
5352
5373
|
/**
|
|
5353
|
-
* 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
|
|
5374
|
+
* 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 IAMuser or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
|
|
5354
5375
|
*/
|
|
5355
5376
|
IdentityType: IdentityType;
|
|
5356
5377
|
/**
|
|
@@ -5362,15 +5383,15 @@ declare namespace QuickSight {
|
|
|
5362
5383
|
*/
|
|
5363
5384
|
UserRole: UserRole;
|
|
5364
5385
|
/**
|
|
5365
|
-
* The ARN of the
|
|
5386
|
+
* The ARN of the IAMuser or role that you are registering with Amazon QuickSight.
|
|
5366
5387
|
*/
|
|
5367
5388
|
IamArn?: String;
|
|
5368
5389
|
/**
|
|
5369
|
-
* You need to use this parameter only when you register one or more users using an assumed
|
|
5390
|
+
* You need to use this parameter only when you register one or more users using an assumed IAMrole. You don't need to provide the session name for other scenarios, for example when you are registering an IAMuser or an Amazon QuickSight user. You can register multiple users using the same IAMrole if each user has a different session name. For more information on assuming IAMroles, see assume-role in the AWS CLI Reference.
|
|
5370
5391
|
*/
|
|
5371
5392
|
SessionName?: RoleSessionName;
|
|
5372
5393
|
/**
|
|
5373
|
-
* The ID for the Amazon Web Services account
|
|
5394
|
+
* The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
5374
5395
|
*/
|
|
5375
5396
|
AwsAccountId: AwsAccountId;
|
|
5376
5397
|
/**
|
|
@@ -5382,15 +5403,15 @@ declare namespace QuickSight {
|
|
|
5382
5403
|
*/
|
|
5383
5404
|
UserName?: UserName;
|
|
5384
5405
|
/**
|
|
5385
|
-
* (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports To add custom permissions to an existing user, use UpdateUser instead. A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user. QuickSight custom permissions are applied through
|
|
5406
|
+
* (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports To add custom permissions to an existing user, use UpdateUser instead. A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader). This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
|
|
5386
5407
|
*/
|
|
5387
5408
|
CustomPermissionsName?: RoleName;
|
|
5388
5409
|
/**
|
|
5389
|
-
* The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated
|
|
5410
|
+
* The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
|
|
5390
5411
|
*/
|
|
5391
5412
|
ExternalLoginFederationProviderType?: String;
|
|
5392
5413
|
/**
|
|
5393
|
-
* The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated
|
|
5414
|
+
* The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
|
|
5394
5415
|
*/
|
|
5395
5416
|
CustomFederationProviderUrl?: String;
|
|
5396
5417
|
/**
|
|
@@ -5477,11 +5498,11 @@ declare namespace QuickSight {
|
|
|
5477
5498
|
export type ResourceName = string;
|
|
5478
5499
|
export interface ResourcePermission {
|
|
5479
5500
|
/**
|
|
5480
|
-
* The Amazon Resource Name (ARN) of the principal. This can be one of the following: The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) The ARN of an Amazon Web Services account
|
|
5501
|
+
* The Amazon Resource Name (ARN) of the principal. This can be one of the following: The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) The ARN of an Amazon Web Services account root: This is an IAMARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
|
|
5481
5502
|
*/
|
|
5482
5503
|
Principal: Principal;
|
|
5483
5504
|
/**
|
|
5484
|
-
* The
|
|
5505
|
+
* The IAMaction to grant or revoke permissions on.
|
|
5485
5506
|
*/
|
|
5486
5507
|
Actions: ActionList;
|
|
5487
5508
|
}
|
|
@@ -5489,7 +5510,7 @@ declare namespace QuickSight {
|
|
|
5489
5510
|
export type ResourceStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED"|string;
|
|
5490
5511
|
export interface RestoreAnalysisRequest {
|
|
5491
5512
|
/**
|
|
5492
|
-
* The ID of the Amazon Web Services account
|
|
5513
|
+
* The ID of the Amazon Web Services account that contains the analysis.
|
|
5493
5514
|
*/
|
|
5494
5515
|
AwsAccountId: AwsAccountId;
|
|
5495
5516
|
/**
|
|
@@ -5538,7 +5559,7 @@ declare namespace QuickSight {
|
|
|
5538
5559
|
*/
|
|
5539
5560
|
Arn: Arn;
|
|
5540
5561
|
/**
|
|
5541
|
-
* The type of permissions to use when
|
|
5562
|
+
* The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
|
|
5542
5563
|
*/
|
|
5543
5564
|
PermissionPolicy: RowLevelPermissionPolicy;
|
|
5544
5565
|
/**
|
|
@@ -5586,7 +5607,7 @@ declare namespace QuickSight {
|
|
|
5586
5607
|
export type S3Key = string;
|
|
5587
5608
|
export interface S3Parameters {
|
|
5588
5609
|
/**
|
|
5589
|
-
* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into QuickSight.
|
|
5610
|
+
* Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
|
|
5590
5611
|
*/
|
|
5591
5612
|
ManifestFileLocation: ManifestFileLocation;
|
|
5592
5613
|
}
|
|
@@ -5600,13 +5621,13 @@ declare namespace QuickSight {
|
|
|
5600
5621
|
*/
|
|
5601
5622
|
UploadSettings?: UploadSettings;
|
|
5602
5623
|
/**
|
|
5603
|
-
* A physical table type for an S3 data source. For
|
|
5624
|
+
* A physical table type for an S3 data source. For files that aren't JSON, only STRING data types are supported in input columns.
|
|
5604
5625
|
*/
|
|
5605
5626
|
InputColumns: InputColumnList;
|
|
5606
5627
|
}
|
|
5607
5628
|
export interface SearchAnalysesRequest {
|
|
5608
5629
|
/**
|
|
5609
|
-
* The ID of the Amazon Web Services account
|
|
5630
|
+
* The ID of the Amazon Web Services account that contains the analyses that you're searching for.
|
|
5610
5631
|
*/
|
|
5611
5632
|
AwsAccountId: AwsAccountId;
|
|
5612
5633
|
/**
|
|
@@ -5642,7 +5663,7 @@ declare namespace QuickSight {
|
|
|
5642
5663
|
}
|
|
5643
5664
|
export interface SearchDashboardsRequest {
|
|
5644
5665
|
/**
|
|
5645
|
-
* The ID of the Amazon Web Services account
|
|
5666
|
+
* The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
|
|
5646
5667
|
*/
|
|
5647
5668
|
AwsAccountId: AwsAccountId;
|
|
5648
5669
|
/**
|
|
@@ -5738,7 +5759,7 @@ declare namespace QuickSight {
|
|
|
5738
5759
|
*/
|
|
5739
5760
|
SheetId?: RestrictiveResourceId;
|
|
5740
5761
|
/**
|
|
5741
|
-
* The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.
|
|
5762
|
+
* The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
|
|
5742
5763
|
*/
|
|
5743
5764
|
Name?: NonEmptyString;
|
|
5744
5765
|
}
|
|
@@ -5878,7 +5899,7 @@ declare namespace QuickSight {
|
|
|
5878
5899
|
*/
|
|
5879
5900
|
Version?: TemplateVersion;
|
|
5880
5901
|
/**
|
|
5881
|
-
* The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
5902
|
+
* The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
5882
5903
|
*/
|
|
5883
5904
|
TemplateId?: RestrictiveResourceId;
|
|
5884
5905
|
/**
|
|
@@ -5950,7 +5971,7 @@ declare namespace QuickSight {
|
|
|
5950
5971
|
*/
|
|
5951
5972
|
Arn?: Arn;
|
|
5952
5973
|
/**
|
|
5953
|
-
* The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
5974
|
+
* The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
5954
5975
|
*/
|
|
5955
5976
|
TemplateId?: RestrictiveResourceId;
|
|
5956
5977
|
/**
|
|
@@ -6126,7 +6147,7 @@ declare namespace QuickSight {
|
|
|
6126
6147
|
*/
|
|
6127
6148
|
Name?: ThemeName;
|
|
6128
6149
|
/**
|
|
6129
|
-
* The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6150
|
+
* The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6130
6151
|
*/
|
|
6131
6152
|
ThemeId?: RestrictiveResourceId;
|
|
6132
6153
|
/**
|
|
@@ -6158,7 +6179,7 @@ declare namespace QuickSight {
|
|
|
6158
6179
|
*/
|
|
6159
6180
|
Description?: VersionDescription;
|
|
6160
6181
|
/**
|
|
6161
|
-
* The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
|
|
6182
|
+
* The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
|
|
6162
6183
|
*/
|
|
6163
6184
|
BaseThemeId?: RestrictiveResourceId;
|
|
6164
6185
|
/**
|
|
@@ -6244,6 +6265,7 @@ declare namespace QuickSight {
|
|
|
6244
6265
|
* An operation that tags a column with additional information.
|
|
6245
6266
|
*/
|
|
6246
6267
|
TagColumnOperation?: TagColumnOperation;
|
|
6268
|
+
UntagColumnOperation?: UntagColumnOperation;
|
|
6247
6269
|
}
|
|
6248
6270
|
export type TransformOperationList = TransformOperation[];
|
|
6249
6271
|
export interface TwitterParameters {
|
|
@@ -6323,6 +6345,16 @@ declare namespace QuickSight {
|
|
|
6323
6345
|
*/
|
|
6324
6346
|
MeasureForeground?: HexColor;
|
|
6325
6347
|
}
|
|
6348
|
+
export interface UntagColumnOperation {
|
|
6349
|
+
/**
|
|
6350
|
+
* The column that this operation acts on.
|
|
6351
|
+
*/
|
|
6352
|
+
ColumnName: ColumnName;
|
|
6353
|
+
/**
|
|
6354
|
+
* The column tags to remove from this column.
|
|
6355
|
+
*/
|
|
6356
|
+
TagNames: ColumnTagNames;
|
|
6357
|
+
}
|
|
6326
6358
|
export interface UntagResourceRequest {
|
|
6327
6359
|
/**
|
|
6328
6360
|
* The Amazon Resource Name (ARN) of the resource that you want to untag.
|
|
@@ -6345,25 +6377,25 @@ declare namespace QuickSight {
|
|
|
6345
6377
|
}
|
|
6346
6378
|
export interface UpdateAccountCustomizationRequest {
|
|
6347
6379
|
/**
|
|
6348
|
-
* The ID for the Amazon Web Services account
|
|
6380
|
+
* The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
|
|
6349
6381
|
*/
|
|
6350
6382
|
AwsAccountId: AwsAccountId;
|
|
6351
6383
|
/**
|
|
6352
|
-
* The namespace that you want to update QuickSight customizations for.
|
|
6384
|
+
* The namespace that you want to update Amazon QuickSight customizations for.
|
|
6353
6385
|
*/
|
|
6354
6386
|
Namespace?: Namespace;
|
|
6355
6387
|
/**
|
|
6356
|
-
* The QuickSight customizations you're updating in the current Amazon Web Services Region;.
|
|
6388
|
+
* The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
|
|
6357
6389
|
*/
|
|
6358
6390
|
AccountCustomization: AccountCustomization;
|
|
6359
6391
|
}
|
|
6360
6392
|
export interface UpdateAccountCustomizationResponse {
|
|
6361
6393
|
/**
|
|
6362
|
-
* The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account
|
|
6394
|
+
* The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.
|
|
6363
6395
|
*/
|
|
6364
6396
|
Arn?: Arn;
|
|
6365
6397
|
/**
|
|
6366
|
-
* The ID for the Amazon Web Services account
|
|
6398
|
+
* The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
|
|
6367
6399
|
*/
|
|
6368
6400
|
AwsAccountId?: AwsAccountId;
|
|
6369
6401
|
/**
|
|
@@ -6371,7 +6403,7 @@ declare namespace QuickSight {
|
|
|
6371
6403
|
*/
|
|
6372
6404
|
Namespace?: Namespace;
|
|
6373
6405
|
/**
|
|
6374
|
-
* The QuickSight customizations you're updating in the current Amazon Web Services Region;.
|
|
6406
|
+
* The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
|
|
6375
6407
|
*/
|
|
6376
6408
|
AccountCustomization?: AccountCustomization;
|
|
6377
6409
|
/**
|
|
@@ -6385,15 +6417,15 @@ declare namespace QuickSight {
|
|
|
6385
6417
|
}
|
|
6386
6418
|
export interface UpdateAccountSettingsRequest {
|
|
6387
6419
|
/**
|
|
6388
|
-
* The ID for the Amazon Web Services account
|
|
6420
|
+
* The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
|
|
6389
6421
|
*/
|
|
6390
6422
|
AwsAccountId: AwsAccountId;
|
|
6391
6423
|
/**
|
|
6392
|
-
* The default namespace for this Amazon Web Services account
|
|
6424
|
+
* The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email that becomes associated with the default namespace.
|
|
6393
6425
|
*/
|
|
6394
6426
|
DefaultNamespace: Namespace;
|
|
6395
6427
|
/**
|
|
6396
|
-
* The email address that you want QuickSight to send notifications to regarding your Amazon Web Services account
|
|
6428
|
+
* The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
|
|
6397
6429
|
*/
|
|
6398
6430
|
NotificationEmail?: String;
|
|
6399
6431
|
}
|
|
@@ -6409,7 +6441,7 @@ declare namespace QuickSight {
|
|
|
6409
6441
|
}
|
|
6410
6442
|
export interface UpdateAnalysisPermissionsRequest {
|
|
6411
6443
|
/**
|
|
6412
|
-
* The ID of the Amazon Web Services account
|
|
6444
|
+
* The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.
|
|
6413
6445
|
*/
|
|
6414
6446
|
AwsAccountId: AwsAccountId;
|
|
6415
6447
|
/**
|
|
@@ -6449,7 +6481,7 @@ declare namespace QuickSight {
|
|
|
6449
6481
|
}
|
|
6450
6482
|
export interface UpdateAnalysisRequest {
|
|
6451
6483
|
/**
|
|
6452
|
-
* The ID of the Amazon Web Services account
|
|
6484
|
+
* The ID of the Amazon Web Services account that contains the analysis that you're updating.
|
|
6453
6485
|
*/
|
|
6454
6486
|
AwsAccountId: AwsAccountId;
|
|
6455
6487
|
/**
|
|
@@ -6457,7 +6489,7 @@ declare namespace QuickSight {
|
|
|
6457
6489
|
*/
|
|
6458
6490
|
AnalysisId: RestrictiveResourceId;
|
|
6459
6491
|
/**
|
|
6460
|
-
* A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
|
|
6492
|
+
* A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
|
|
6461
6493
|
*/
|
|
6462
6494
|
Name: AnalysisName;
|
|
6463
6495
|
/**
|
|
@@ -6469,7 +6501,7 @@ declare namespace QuickSight {
|
|
|
6469
6501
|
*/
|
|
6470
6502
|
SourceEntity: AnalysisSourceEntity;
|
|
6471
6503
|
/**
|
|
6472
|
-
* The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
|
|
6504
|
+
* The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
|
|
6473
6505
|
*/
|
|
6474
6506
|
ThemeArn?: Arn;
|
|
6475
6507
|
}
|
|
@@ -6497,7 +6529,7 @@ declare namespace QuickSight {
|
|
|
6497
6529
|
}
|
|
6498
6530
|
export interface UpdateDashboardPermissionsRequest {
|
|
6499
6531
|
/**
|
|
6500
|
-
* The ID of the Amazon Web Services account
|
|
6532
|
+
* The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
|
|
6501
6533
|
*/
|
|
6502
6534
|
AwsAccountId: AwsAccountId;
|
|
6503
6535
|
/**
|
|
@@ -6537,7 +6569,7 @@ declare namespace QuickSight {
|
|
|
6537
6569
|
}
|
|
6538
6570
|
export interface UpdateDashboardPublishedVersionRequest {
|
|
6539
6571
|
/**
|
|
6540
|
-
* The ID of the Amazon Web Services account
|
|
6572
|
+
* The ID of the Amazon Web Services account that contains the dashboard that you're updating.
|
|
6541
6573
|
*/
|
|
6542
6574
|
AwsAccountId: AwsAccountId;
|
|
6543
6575
|
/**
|
|
@@ -6569,7 +6601,7 @@ declare namespace QuickSight {
|
|
|
6569
6601
|
}
|
|
6570
6602
|
export interface UpdateDashboardRequest {
|
|
6571
6603
|
/**
|
|
6572
|
-
* The ID of the Amazon Web Services account
|
|
6604
|
+
* The ID of the Amazon Web Services account that contains the dashboard that you're updating.
|
|
6573
6605
|
*/
|
|
6574
6606
|
AwsAccountId: AwsAccountId;
|
|
6575
6607
|
/**
|
|
@@ -6581,7 +6613,7 @@ declare namespace QuickSight {
|
|
|
6581
6613
|
*/
|
|
6582
6614
|
Name: DashboardName;
|
|
6583
6615
|
/**
|
|
6584
|
-
* The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account
|
|
6616
|
+
* The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
|
|
6585
6617
|
*/
|
|
6586
6618
|
SourceEntity: DashboardSourceEntity;
|
|
6587
6619
|
/**
|
|
@@ -6593,11 +6625,11 @@ declare namespace QuickSight {
|
|
|
6593
6625
|
*/
|
|
6594
6626
|
VersionDescription?: VersionDescription;
|
|
6595
6627
|
/**
|
|
6596
|
-
* 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. This option is COLLAPSED by default.
|
|
6628
|
+
* 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, Amazon 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. This option is COLLAPSED by default.
|
|
6597
6629
|
*/
|
|
6598
6630
|
DashboardPublishOptions?: DashboardPublishOptions;
|
|
6599
6631
|
/**
|
|
6600
|
-
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account
|
|
6632
|
+
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
|
|
6601
6633
|
*/
|
|
6602
6634
|
ThemeArn?: Arn;
|
|
6603
6635
|
}
|
|
@@ -6629,11 +6661,11 @@ declare namespace QuickSight {
|
|
|
6629
6661
|
}
|
|
6630
6662
|
export interface UpdateDataSetPermissionsRequest {
|
|
6631
6663
|
/**
|
|
6632
|
-
* The Amazon Web Services account
|
|
6664
|
+
* The Amazon Web Services account ID.
|
|
6633
6665
|
*/
|
|
6634
6666
|
AwsAccountId: AwsAccountId;
|
|
6635
6667
|
/**
|
|
6636
|
-
* The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6668
|
+
* The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6637
6669
|
*/
|
|
6638
6670
|
DataSetId: ResourceId;
|
|
6639
6671
|
/**
|
|
@@ -6651,7 +6683,7 @@ declare namespace QuickSight {
|
|
|
6651
6683
|
*/
|
|
6652
6684
|
DataSetArn?: Arn;
|
|
6653
6685
|
/**
|
|
6654
|
-
* The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6686
|
+
* The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6655
6687
|
*/
|
|
6656
6688
|
DataSetId?: ResourceId;
|
|
6657
6689
|
/**
|
|
@@ -6665,11 +6697,11 @@ declare namespace QuickSight {
|
|
|
6665
6697
|
}
|
|
6666
6698
|
export interface UpdateDataSetRequest {
|
|
6667
6699
|
/**
|
|
6668
|
-
* The Amazon Web Services account
|
|
6700
|
+
* The Amazon Web Services account ID.
|
|
6669
6701
|
*/
|
|
6670
6702
|
AwsAccountId: AwsAccountId;
|
|
6671
6703
|
/**
|
|
6672
|
-
* The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6704
|
+
* The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6673
6705
|
*/
|
|
6674
6706
|
DataSetId: ResourceId;
|
|
6675
6707
|
/**
|
|
@@ -6689,7 +6721,7 @@ declare namespace QuickSight {
|
|
|
6689
6721
|
*/
|
|
6690
6722
|
ImportMode: DataSetImportMode;
|
|
6691
6723
|
/**
|
|
6692
|
-
* Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
|
|
6724
|
+
* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
|
|
6693
6725
|
*/
|
|
6694
6726
|
ColumnGroups?: ColumnGroupList;
|
|
6695
6727
|
/**
|
|
@@ -6708,6 +6740,7 @@ declare namespace QuickSight {
|
|
|
6708
6740
|
* A set of one or more definitions of a ColumnLevelPermissionRule .
|
|
6709
6741
|
*/
|
|
6710
6742
|
ColumnLevelPermissionRules?: ColumnLevelPermissionRuleList;
|
|
6743
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
6711
6744
|
}
|
|
6712
6745
|
export interface UpdateDataSetResponse {
|
|
6713
6746
|
/**
|
|
@@ -6715,7 +6748,7 @@ declare namespace QuickSight {
|
|
|
6715
6748
|
*/
|
|
6716
6749
|
Arn?: Arn;
|
|
6717
6750
|
/**
|
|
6718
|
-
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6751
|
+
* The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6719
6752
|
*/
|
|
6720
6753
|
DataSetId?: ResourceId;
|
|
6721
6754
|
/**
|
|
@@ -6737,11 +6770,11 @@ declare namespace QuickSight {
|
|
|
6737
6770
|
}
|
|
6738
6771
|
export interface UpdateDataSourcePermissionsRequest {
|
|
6739
6772
|
/**
|
|
6740
|
-
* The Amazon Web Services account
|
|
6773
|
+
* The Amazon Web Services account ID.
|
|
6741
6774
|
*/
|
|
6742
6775
|
AwsAccountId: AwsAccountId;
|
|
6743
6776
|
/**
|
|
6744
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6777
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6745
6778
|
*/
|
|
6746
6779
|
DataSourceId: ResourceId;
|
|
6747
6780
|
/**
|
|
@@ -6759,7 +6792,7 @@ declare namespace QuickSight {
|
|
|
6759
6792
|
*/
|
|
6760
6793
|
DataSourceArn?: Arn;
|
|
6761
6794
|
/**
|
|
6762
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6795
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6763
6796
|
*/
|
|
6764
6797
|
DataSourceId?: ResourceId;
|
|
6765
6798
|
/**
|
|
@@ -6773,11 +6806,11 @@ declare namespace QuickSight {
|
|
|
6773
6806
|
}
|
|
6774
6807
|
export interface UpdateDataSourceRequest {
|
|
6775
6808
|
/**
|
|
6776
|
-
* The Amazon Web Services account
|
|
6809
|
+
* The Amazon Web Services account ID.
|
|
6777
6810
|
*/
|
|
6778
6811
|
AwsAccountId: AwsAccountId;
|
|
6779
6812
|
/**
|
|
6780
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6813
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6781
6814
|
*/
|
|
6782
6815
|
DataSourceId: ResourceId;
|
|
6783
6816
|
/**
|
|
@@ -6785,19 +6818,19 @@ declare namespace QuickSight {
|
|
|
6785
6818
|
*/
|
|
6786
6819
|
Name: ResourceName;
|
|
6787
6820
|
/**
|
|
6788
|
-
* The parameters that QuickSight uses to connect to your underlying source.
|
|
6821
|
+
* The parameters that Amazon QuickSight uses to connect to your underlying source.
|
|
6789
6822
|
*/
|
|
6790
6823
|
DataSourceParameters?: DataSourceParameters;
|
|
6791
6824
|
/**
|
|
6792
|
-
* The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
|
|
6825
|
+
* The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
|
|
6793
6826
|
*/
|
|
6794
6827
|
Credentials?: DataSourceCredentials;
|
|
6795
6828
|
/**
|
|
6796
|
-
* Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
|
|
6829
|
+
* Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
|
6797
6830
|
*/
|
|
6798
6831
|
VpcConnectionProperties?: VpcConnectionProperties;
|
|
6799
6832
|
/**
|
|
6800
|
-
* Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
|
|
6833
|
+
* Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
|
6801
6834
|
*/
|
|
6802
6835
|
SslProperties?: SslProperties;
|
|
6803
6836
|
}
|
|
@@ -6807,7 +6840,7 @@ declare namespace QuickSight {
|
|
|
6807
6840
|
*/
|
|
6808
6841
|
Arn?: Arn;
|
|
6809
6842
|
/**
|
|
6810
|
-
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
6843
|
+
* The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
|
|
6811
6844
|
*/
|
|
6812
6845
|
DataSourceId?: ResourceId;
|
|
6813
6846
|
/**
|
|
@@ -6905,7 +6938,7 @@ declare namespace QuickSight {
|
|
|
6905
6938
|
*/
|
|
6906
6939
|
Description?: GroupDescription;
|
|
6907
6940
|
/**
|
|
6908
|
-
* The ID for the Amazon Web Services account
|
|
6941
|
+
* The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
6909
6942
|
*/
|
|
6910
6943
|
AwsAccountId: AwsAccountId;
|
|
6911
6944
|
/**
|
|
@@ -6929,11 +6962,11 @@ declare namespace QuickSight {
|
|
|
6929
6962
|
}
|
|
6930
6963
|
export interface UpdateIAMPolicyAssignmentRequest {
|
|
6931
6964
|
/**
|
|
6932
|
-
* The ID of the Amazon Web Services account
|
|
6965
|
+
* The ID of the Amazon Web Services account that contains the IAMpolicy assignment.
|
|
6933
6966
|
*/
|
|
6934
6967
|
AwsAccountId: AwsAccountId;
|
|
6935
6968
|
/**
|
|
6936
|
-
* The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account
|
|
6969
|
+
* The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.
|
|
6937
6970
|
*/
|
|
6938
6971
|
AssignmentName: IAMPolicyAssignmentName;
|
|
6939
6972
|
/**
|
|
@@ -6945,11 +6978,11 @@ declare namespace QuickSight {
|
|
|
6945
6978
|
*/
|
|
6946
6979
|
AssignmentStatus?: AssignmentStatus;
|
|
6947
6980
|
/**
|
|
6948
|
-
* The ARN for the
|
|
6981
|
+
* The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups specified in this assignment.
|
|
6949
6982
|
*/
|
|
6950
6983
|
PolicyArn?: Arn;
|
|
6951
6984
|
/**
|
|
6952
|
-
* The QuickSight users, groups, or both that you want to assign the policy to.
|
|
6985
|
+
* The Amazon QuickSight users, groups, or both that you want to assign the policy to.
|
|
6953
6986
|
*/
|
|
6954
6987
|
Identities?: IdentityMap;
|
|
6955
6988
|
}
|
|
@@ -6963,11 +6996,11 @@ declare namespace QuickSight {
|
|
|
6963
6996
|
*/
|
|
6964
6997
|
AssignmentId?: String;
|
|
6965
6998
|
/**
|
|
6966
|
-
* The ARN for the
|
|
6999
|
+
* The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this assignment.
|
|
6967
7000
|
*/
|
|
6968
7001
|
PolicyArn?: Arn;
|
|
6969
7002
|
/**
|
|
6970
|
-
* The QuickSight users, groups, or both that the
|
|
7003
|
+
* The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.
|
|
6971
7004
|
*/
|
|
6972
7005
|
Identities?: IdentityMap;
|
|
6973
7006
|
/**
|
|
@@ -6986,7 +7019,7 @@ declare namespace QuickSight {
|
|
|
6986
7019
|
export type UpdateResourcePermissionList = ResourcePermission[];
|
|
6987
7020
|
export interface UpdateTemplateAliasRequest {
|
|
6988
7021
|
/**
|
|
6989
|
-
* The ID of the Amazon Web Services account
|
|
7022
|
+
* The ID of the Amazon Web Services account that contains the template alias that you're updating.
|
|
6990
7023
|
*/
|
|
6991
7024
|
AwsAccountId: AwsAccountId;
|
|
6992
7025
|
/**
|
|
@@ -7018,7 +7051,7 @@ declare namespace QuickSight {
|
|
|
7018
7051
|
}
|
|
7019
7052
|
export interface UpdateTemplatePermissionsRequest {
|
|
7020
7053
|
/**
|
|
7021
|
-
* The ID of the Amazon Web Services account
|
|
7054
|
+
* The ID of the Amazon Web Services account that contains the template.
|
|
7022
7055
|
*/
|
|
7023
7056
|
AwsAccountId: AwsAccountId;
|
|
7024
7057
|
/**
|
|
@@ -7058,7 +7091,7 @@ declare namespace QuickSight {
|
|
|
7058
7091
|
}
|
|
7059
7092
|
export interface UpdateTemplateRequest {
|
|
7060
7093
|
/**
|
|
7061
|
-
* The ID of the Amazon Web Services account
|
|
7094
|
+
* The ID of the Amazon Web Services account that contains the template that you're updating.
|
|
7062
7095
|
*/
|
|
7063
7096
|
AwsAccountId: AwsAccountId;
|
|
7064
7097
|
/**
|
|
@@ -7066,7 +7099,7 @@ declare namespace QuickSight {
|
|
|
7066
7099
|
*/
|
|
7067
7100
|
TemplateId: RestrictiveResourceId;
|
|
7068
7101
|
/**
|
|
7069
|
-
* The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account
|
|
7102
|
+
* The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
|
|
7070
7103
|
*/
|
|
7071
7104
|
SourceEntity: TemplateSourceEntity;
|
|
7072
7105
|
/**
|
|
@@ -7106,7 +7139,7 @@ declare namespace QuickSight {
|
|
|
7106
7139
|
}
|
|
7107
7140
|
export interface UpdateThemeAliasRequest {
|
|
7108
7141
|
/**
|
|
7109
|
-
* The ID of the Amazon Web Services account
|
|
7142
|
+
* The ID of the Amazon Web Services account that contains the theme alias that you're updating.
|
|
7110
7143
|
*/
|
|
7111
7144
|
AwsAccountId: AwsAccountId;
|
|
7112
7145
|
/**
|
|
@@ -7138,7 +7171,7 @@ declare namespace QuickSight {
|
|
|
7138
7171
|
}
|
|
7139
7172
|
export interface UpdateThemePermissionsRequest {
|
|
7140
7173
|
/**
|
|
7141
|
-
* The ID of the Amazon Web Services account
|
|
7174
|
+
* The ID of the Amazon Web Services account that contains the theme.
|
|
7142
7175
|
*/
|
|
7143
7176
|
AwsAccountId: AwsAccountId;
|
|
7144
7177
|
/**
|
|
@@ -7178,7 +7211,7 @@ declare namespace QuickSight {
|
|
|
7178
7211
|
}
|
|
7179
7212
|
export interface UpdateThemeRequest {
|
|
7180
7213
|
/**
|
|
7181
|
-
* The ID of the Amazon Web Services account
|
|
7214
|
+
* The ID of the Amazon Web Services account that contains the theme that you're updating.
|
|
7182
7215
|
*/
|
|
7183
7216
|
AwsAccountId: AwsAccountId;
|
|
7184
7217
|
/**
|
|
@@ -7234,7 +7267,7 @@ declare namespace QuickSight {
|
|
|
7234
7267
|
*/
|
|
7235
7268
|
UserName: UserName;
|
|
7236
7269
|
/**
|
|
7237
|
-
* The ID for the Amazon Web Services account
|
|
7270
|
+
* The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
|
|
7238
7271
|
*/
|
|
7239
7272
|
AwsAccountId: AwsAccountId;
|
|
7240
7273
|
/**
|
|
@@ -7246,11 +7279,11 @@ declare namespace QuickSight {
|
|
|
7246
7279
|
*/
|
|
7247
7280
|
Email: String;
|
|
7248
7281
|
/**
|
|
7249
|
-
* The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: 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. The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.
|
|
7282
|
+
* The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: 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. The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
|
|
7250
7283
|
*/
|
|
7251
7284
|
Role: UserRole;
|
|
7252
7285
|
/**
|
|
7253
|
-
* (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user. QuickSight custom permissions are applied through
|
|
7286
|
+
* (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader). This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
|
|
7254
7287
|
*/
|
|
7255
7288
|
CustomPermissionsName?: RoleName;
|
|
7256
7289
|
/**
|
|
@@ -7258,11 +7291,11 @@ declare namespace QuickSight {
|
|
|
7258
7291
|
*/
|
|
7259
7292
|
UnapplyCustomPermissions?: Boolean;
|
|
7260
7293
|
/**
|
|
7261
|
-
* The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated
|
|
7294
|
+
* The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL. NONE: This clears all the previously saved external login information for a user. Use DescribeUser API to check the external login information.
|
|
7262
7295
|
*/
|
|
7263
7296
|
ExternalLoginFederationProviderType?: String;
|
|
7264
7297
|
/**
|
|
7265
|
-
* The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated
|
|
7298
|
+
* The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
|
|
7266
7299
|
*/
|
|
7267
7300
|
CustomFederationProviderUrl?: String;
|
|
7268
7301
|
/**
|
|
@@ -7320,7 +7353,7 @@ declare namespace QuickSight {
|
|
|
7320
7353
|
*/
|
|
7321
7354
|
Email?: String;
|
|
7322
7355
|
/**
|
|
7323
|
-
* 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.
|
|
7356
|
+
* 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 Amazon QuickSight settings. RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This role isn't currently available for use.
|
|
7324
7357
|
*/
|
|
7325
7358
|
Role?: UserRole;
|
|
7326
7359
|
/**
|
|
@@ -7340,7 +7373,7 @@ declare namespace QuickSight {
|
|
|
7340
7373
|
*/
|
|
7341
7374
|
CustomPermissionsName?: RoleName;
|
|
7342
7375
|
/**
|
|
7343
|
-
* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated
|
|
7376
|
+
* The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAMrole. The type can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
|
|
7344
7377
|
*/
|
|
7345
7378
|
ExternalLoginFederationProviderType?: String;
|
|
7346
7379
|
/**
|