Skip to content

Commit f7d5348

Browse files
author
AWS
committed
Amazon QuickSight Update: added warnings to a few CLI pages
1 parent 0048631 commit f7d5348

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon QuickSight",
4+
"contributor": "",
5+
"description": "added warnings to a few CLI pages"
6+
}

services/quicksight/src/main/resources/codegen-resources/service-2.json

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@
587587
{"shape":"InternalFailureException"},
588588
{"shape":"ResourceUnavailableException"}
589589
],
590-
"documentation":"<p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and QuickSight namespace.</p>"
590+
"documentation":"<important> <p>This API permanently deletes all QuickSight customizations for the specified Amazon Web Services account and namespace in this Amazon Web Services Region. When you delete account customizations:</p> <ul> <li> <p>All customizations are removed including themes, branding, and visual settings</p> </li> <li> <p>The deletion affects only the specified Amazon Web Services Region - customizations in other regions remain unchanged</p> </li> <li> <p>This action cannot be undone through the API</p> </li> <li> <p>Users will see default QuickSight styling after customizations are deleted</p> </li> </ul> <p> <b>Before proceeding:</b> Ensure you have backups of any custom themes or branding elements you may want to recreate.</p> </important> <p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and QuickSight namespace.</p>"
591591
},
592592
"DeleteAccountSubscription":{
593593
"name":"DeleteAccountSubscription",
@@ -606,7 +606,7 @@
606606
{"shape":"InternalFailureException"},
607607
{"shape":"ResourceUnavailableException"}
608608
],
609-
"documentation":"<p>Use the <code>DeleteAccountSubscription</code> operation to delete an QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to <code>True</code>. To change this setting and delete your account, call the <code>UpdateAccountSettings</code> API and set the value of the <code>TerminationProtectionEnabled</code> parameter to <code>False</code>, then make another call to the <code>DeleteAccountSubscription</code> API.</p>"
609+
"documentation":"<important> <p>Deleting your QuickSight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:</p> <ul> <li> <p>Global deletion – Running this operation from any single region will delete your QuickSight account and all data in every Amazon Web Services region where you have QuickSight resources.</p> </li> <li> <p>Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.</p> </li> <li> <p>Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.</p> </li> <li> <p>Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.</p> </li> <li> <p>User access terminated – All QuickSight users in your account will lose access immediately, including authors, readers, and administrators.</p> </li> <li> <p> <b>No recovery possible</b> – Once deleted, your QuickSight account and all associated data cannot be restored.</p> </li> </ul> <p>Consider exporting critical dashboards and data before proceeding with account deletion.</p> </important> <p>Use the <code>DeleteAccountSubscription</code> operation to delete an QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to <code>True</code>. To change this setting and delete your account, call the <code>UpdateAccountSettings</code> API and set the value of the <code>TerminationProtectionEnabled</code> parameter to <code>False</code>, then make another call to the <code>DeleteAccountSubscription</code> API.</p>"
610610
},
611611
"DeleteAnalysis":{
612612
"name":"DeleteAnalysis",
@@ -643,7 +643,7 @@
643643
{"shape":"AccessDeniedException"},
644644
{"shape":"InternalServerException"}
645645
],
646-
"documentation":"<p>Deletes an QuickSight brand.</p>",
646+
"documentation":"<important> <p>This API permanently deletes the specified QuickSight brand. When you delete a brand:</p> <ul> <li> <p>The brand and all its associated branding elements are permanently removed</p> </li> <li> <p>Any applications or dashboards using this brand will revert to default styling</p> </li> <li> <p>This action cannot be undone through the API</p> </li> </ul> <p> <b>Before proceeding:</b> Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.</p> </important> <p>Deletes an QuickSight brand.</p>",
647647
"idempotent":true
648648
},
649649
"DeleteBrandAssignment":{
@@ -1323,7 +1323,8 @@
13231323
{"shape":"AccessDeniedException"},
13241324
{"shape":"InternalServerException"}
13251325
],
1326-
"documentation":"<p>Describes a brand.</p>"
1326+
"documentation":"<p>Describes a brand.</p>",
1327+
"readonly":true
13271328
},
13281329
"DescribeBrandAssignment":{
13291330
"name":"DescribeBrandAssignment",
@@ -1342,7 +1343,8 @@
13421343
{"shape":"AccessDeniedException"},
13431344
{"shape":"InternalServerException"}
13441345
],
1345-
"documentation":"<p>Describes a brand assignment.</p>"
1346+
"documentation":"<p>Describes a brand assignment.</p>",
1347+
"readonly":true
13461348
},
13471349
"DescribeBrandPublishedVersion":{
13481350
"name":"DescribeBrandPublishedVersion",
@@ -1361,7 +1363,8 @@
13611363
{"shape":"AccessDeniedException"},
13621364
{"shape":"InternalServerException"}
13631365
],
1364-
"documentation":"<p>Describes the published version of the brand.</p>"
1366+
"documentation":"<p>Describes the published version of the brand.</p>",
1367+
"readonly":true
13651368
},
13661369
"DescribeCustomPermissions":{
13671370
"name":"DescribeCustomPermissions",
@@ -2258,7 +2261,8 @@
22582261
{"shape":"AccessDeniedException"},
22592262
{"shape":"InternalServerException"}
22602263
],
2261-
"documentation":"<p>Lists all brands in an QuickSight account.</p>"
2264+
"documentation":"<p>Lists all brands in an QuickSight account.</p>",
2265+
"readonly":true
22622266
},
22632267
"ListCustomPermissions":{
22642268
"name":"ListCustomPermissions",
@@ -3655,7 +3659,7 @@
36553659
{"shape":"UnsupportedPricingPlanException"},
36563660
{"shape":"InternalFailureException"}
36573661
],
3658-
"documentation":"<p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the public sharing settings of an QuickSight dashboard.</p> <p>To use this operation, turn on session capacity pricing for your QuickSight account.</p> <p>Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html\">Using QuickSight with IAM</a> in the <i>QuickSight User Guide</i>.</p>"
3662+
"documentation":"<important> <p>This API controls public sharing settings for your entire QuickSight account, affecting data security and access. When you enable public sharing:</p> <ul> <li> <p>Dashboards can be shared publicly</p> </li> <li> <p>This setting affects your entire Amazon Web Services account and all QuickSight users</p> </li> </ul> <p> <b>Before proceeding:</b> Ensure you understand the security implications and have proper IAM permissions configured.</p> </important> <p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the public sharing settings of an QuickSight dashboard.</p> <p>To use this operation, turn on session capacity pricing for your QuickSight account.</p> <p>Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html\">Using QuickSight with IAM</a> in the <i>QuickSight User Guide</i>.</p>"
36593663
},
36603664
"UpdateQPersonalizationConfiguration":{
36613665
"name":"UpdateQPersonalizationConfiguration",

0 commit comments

Comments
 (0)