sync_dashboards

QuicksightApi.sync_dashboards(role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sync user-accessible QuickSight dashboards

Starts an asynchronous Step Functions sync of QuickSight dashboards accessible to the caller. Requires BI registration and dashboards.fullaccess on role_id. On success returns Message “Successfully triggered dashboard sync process”. Completion is notified asynchronously (for example by email). If a sync is already in progress, the API fails with GE-1034.

Parameters:

  • role_id (str) – Amorphic role ID the request is authorized against. Must hold dashboards.fullaccess. (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DashboardSyncResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /dashboards/sync

Success (HTTP 200)

Sync process triggered successfully. This does not mean dashboards are already updated; wait for async completion.

Request / response example

{
  "Message": "Successfully triggered dashboard sync process"
}

Errors

Documented error codes: AUTH-1001, AUTH-1030, GE-1003, GE-1034, RTE-1001, EMF-1001.

HTTP 400

Invalid input, unauthorized user, missing dashboards.fullaccess, invalid user, or sync already in progress. On the QuickSight Lambda both InvalidInputException and UnauthorizedUserException map to HTTP 400. Codes include AUTH-1001, AUTH-1030, GE-1003, GE-1034.

syncInProgress

{
  "Message": "GE-1034 - BI Application Dashboard Sync is already in progress for the user"
}

HTTP 500

Backend/generic failure (for example Step Functions trigger failure or user not registered in BI). Body is {“Message”: “<CODE> - <text>”} (often RTE-1001 / EMF-1001 wrapping).

notRegistered

{
  "Message": "RTE-1001 - User is not registered in BI Application."
}