Amazon QuickSight

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide .

See also: AWS API Documentation

Request Syntax

client.start_dashboard_snapshot_job_schedule(
    AwsAccountId='string',
    DashboardId='string',
    ScheduleId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

type DashboardId

string

param DashboardId

[REQUIRED]

The ID of the dashboard that you want to start a snapshot job schedule for.

type ScheduleId

string

param ScheduleId

[REQUIRED]

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 Schedules pane of the dashboard that the schedule is configured for.

rtype

dict

returns

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) --

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

  • Status (integer) --

    The HTTP status of the request

{'RestoreToFolders': 'boolean'}

{'RestorationFailedFolderArns': ['string']}

Restores an analysis.

See also: AWS API Documentation

Request Syntax

client.restore_analysis(
    AwsAccountId='string',
    AnalysisId='string',
    RestoreToFolders=True|False
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account that contains the analysis.

type AnalysisId

string

param AnalysisId

[REQUIRED]

The ID of the analysis that you're restoring.

type RestoreToFolders

boolean

param RestoreToFolders

A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False 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 True .

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'AnalysisId': 'string',
    'RequestId': 'string',
    'RestorationFailedFolderArns': [
        'string',
    ]
}

Response Structure

• (dict) --

  • Status (integer) --

    The HTTP status of the request.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the analysis that you're restoring.

  • AnalysisId (string) --

    The ID of the analysis that you're restoring.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

  • RestorationFailedFolderArns (list) --

    A list of folder arns thatthe analysis failed to be restored to.

    • (string) --