Amazon QuickSight Update: Add StartDashboardSnapshotJobSchedule API. RestoreAnalysis now supports restoring analysis to folders.

Author: AWS

.changes/next-release/feature-AmazonQuickSight-cdc3363.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon QuickSight",
+    "contributor": "",
+    "description": "Add StartDashboardSnapshotJobSchedule API. RestoreAnalysis now supports restoring analysis to folders."
+}

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

@@ -2510,6 +2510,8 @@
         {"shape":"ConflictException"},
         {"shape":"ResourceNotFoundException"},
         {"shape":"UnsupportedUserEditionException"},
+        {"shape":"LimitExceededException"},
+        {"shape":"PreconditionNotMetException"},
         {"shape":"InternalFailureException"}
       ],
       "documentation":"<p>Restores an analysis.</p>"
@@ -2685,6 +2687,25 @@
       ],
       "documentation":"<p>Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.</p> <ul> <li> <p>1 Paginated PDF</p> </li> <li> <p>1 Excel workbook that includes up to 5 table or pivot table visuals</p> </li> <li> <p>5 CSVs from table or pivot table visuals</p> </li> </ul> <p>The status of a submitted job can be polled with the <code>DescribeDashboardSnapshotJob</code> API. When you call the <code>DescribeDashboardSnapshotJob</code> API, check the <code>JobStatus</code> field in the response. Once the job reaches a <code>COMPLETED</code> or <code>FAILED</code> status, use the <code>DescribeDashboardSnapshotJobResult</code> API to obtain the URLs for the generated files. If the job fails, the <code>DescribeDashboardSnapshotJobResult</code> API returns detailed information about the error that occurred.</p> <p> <b>StartDashboardSnapshotJob API throttling</b> </p> <p>Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the <code>StartDashboardSnapshotJob</code>. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.</p> <p> <b>Common throttling scenarios</b> </p> <p>The following list provides information about the most commin throttling scenarios that can occur.</p> <ul> <li> <p> <b>A large number of <code>SnapshotExport</code> API jobs are running simultaneously on an Amazon Web Services account.</b> When a new <code>StartDashboardSnapshotJob</code> is created and there are already 12 jobs with the <code>RUNNING</code> status, the new job request fails and returns a <code>LimitExceededException</code> error. Wait for a current job to comlpete before you resubmit the new job.</p> </li> <li> <p> <b>A large number of API requests are submitted on an Amazon Web Services account.</b> When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a <code>ThrottlingException</code> is returned.</p> </li> </ul> <p>If your use case requires a higher throttling limit, contact your account admin or <a href=\"http://aws.amazon.com/contact-us/\">Amazon Web ServicesSupport</a> to explore options to tailor a more optimal expereince for your account.</p> <p> <b>Best practices to handle throttling</b> </p> <p>If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example <code>(12 minutes * 9 = 108 minutes)</code>. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.</p> <p>The time that it takes to process a job can be impacted by the following factors:</p> <ul> <li> <p>The dataset type (Direct Query or SPICE).</p> </li> <li> <p>The size of the dataset.</p> </li> <li> <p>The complexity of the calculated fields that are used in the dashboard.</p> </li> <li> <p>The number of visuals that are on a sheet.</p> </li> <li> <p>The types of visuals that are on the sheet.</p> </li> <li> <p>The number of formats and snapshots that are requested in the job configuration.</p> </li> <li> <p>The size of the generated snapshots.</p> </li> </ul>"
     },
+    "StartDashboardSnapshotJobSchedule":{
+      "name":"StartDashboardSnapshotJobSchedule",
+      "http":{
+        "method":"POST",
+        "requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/schedules/{ScheduleId}"
+      },
+      "input":{"shape":"StartDashboardSnapshotJobScheduleRequest"},
+      "output":{"shape":"StartDashboardSnapshotJobScheduleResponse"},
+      "errors":[
+        {"shape":"AccessDeniedException"},
+        {"shape":"InvalidParameterValueException"},
+        {"shape":"LimitExceededException"},
+        {"shape":"ResourceNotFoundException"},
+        {"shape":"ThrottlingException"},
+        {"shape":"UnsupportedUserEditionException"},
+        {"shape":"InternalFailureException"}
+      ],
+      "documentation":"<p>Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. </p> <p>Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a <code>202</code> HTTP status code.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/sending-reports.html\">Scheduling and sending Amazon QuickSight reports by email</a> and <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/email-reports-from-dashboard.html\">Configuring email report settings for a Amazon QuickSight dashboard</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
+    },
     "TagResource":{
       "name":"TagResource",
       "http":{
@@ -13416,7 +13437,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis.</p>"
         },
         "Status":{
@@ -13771,7 +13792,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) of the dashboard.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>A structure that contains the permissions for the dashboard.</p>"
         },
         "Status":{
@@ -14960,7 +14981,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>A list of resource permissions to be set on the template. </p>"
         },
         "RequestId":{
@@ -15104,7 +15125,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>A list of resource permissions set on the theme. </p>"
         },
         "RequestId":{
@@ -25649,6 +25670,12 @@
           "documentation":"<p>The ID of the analysis that you're restoring.</p>",
           "location":"uri",
           "locationName":"AnalysisId"
+        },
+        "RestoreToFolders":{
+          "shape":"Boolean",
+          "documentation":"<p>A boolean value that determines if the analysis will be restored to folders that it previously resided in. A <code>True</code> value restores analysis back to all folders that it previously resided in. A <code>False</code> value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to <code>True</code>.</p>",
+          "location":"querystring",
+          "locationName":"restore-to-folders"
         }
       }
     },
@@ -25671,6 +25698,10 @@
         "RequestId":{
           "shape":"String",
           "documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
+        },
+        "RestorationFailedFolderArns":{
+          "shape":"FolderArnList",
+          "documentation":"<p>A list of folder arns thatthe analysis failed to be restored to.</p>"
         }
       }
     },
@@ -28111,6 +28142,48 @@
         }
       }
     },
+    "StartDashboardSnapshotJobScheduleRequest":{
+      "type":"structure",
+      "required":[
+        "AwsAccountId",
+        "DashboardId",
+        "ScheduleId"
+      ],
+      "members":{
+        "AwsAccountId":{
+          "shape":"AwsAccountId",
+          "documentation":"<p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>",
+          "location":"uri",
+          "locationName":"AwsAccountId"
+        },
+        "DashboardId":{
+          "shape":"ShortRestrictiveResourceId",
+          "documentation":"<p>The ID of the dashboard that you want to start a snapshot job schedule for. </p>",
+          "location":"uri",
+          "locationName":"DashboardId"
+        },
+        "ScheduleId":{
+          "shape":"ShortRestrictiveResourceId",
+          "documentation":"<p>The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the <b>Schedules</b> pane of the dashboard that the schedule is configured for.</p>",
+          "location":"uri",
+          "locationName":"ScheduleId"
+        }
+      }
+    },
+    "StartDashboardSnapshotJobScheduleResponse":{
+      "type":"structure",
+      "members":{
+        "RequestId":{
+          "shape":"NonEmptyString",
+          "documentation":"<p> The Amazon Web Services request ID for this operation. </p>"
+        },
+        "Status":{
+          "shape":"StatusCode",
+          "documentation":"<p>The HTTP status of the request</p>",
+          "location":"statusCode"
+        }
+      }
+    },
     "StatePersistenceConfigurations":{
       "type":"structure",
       "required":["Enabled"],
@@ -31712,7 +31785,7 @@
           "documentation":"<p>The ID of the analysis that you updated permissions for.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis.</p>"
         },
         "RequestId":{
@@ -31895,7 +31968,7 @@
           "documentation":"<p>The ID for the dashboard.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>Information about the permissions on the dashboard.</p>"
         },
         "RequestId":{
@@ -32954,7 +33027,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>A list of resource permissions to be set on the template.</p>"
         },
         "RequestId":{
@@ -33131,7 +33204,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
         },
         "Permissions":{
-          "shape":"ResourcePermissionList",
+          "shape":"UpdateResourcePermissionList",
           "documentation":"<p>The resulting list of resource permissions for the theme.</p>"
         },
         "RequestId":{