Skip to content

StartDashboardSnapshotJobRequest

Source code in docs_src/capo_quicksight/types/start_dashboard_snapshot_job_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class StartDashboardSnapshotJobRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>"""
    dashboard_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The ID of the dashboard that you want to start a snapshot job for. </p>"""
    snapshot_job_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>"""
    user_configuration: NotRequired[
        "capo_quicksight.types.snapshot_user_configuration.SnapshotUserConfiguration"
    ]
    """<p>A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.</p> <important> <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p> </important>"""
    snapshot_configuration: (
        "capo_quicksight.types.snapshot_configuration.SnapshotConfiguration"
    )
    """<p>A structure that describes the configuration of the dashboard snapshot.</p>"""

aws_account_id instance-attribute 

aws_account_id: AwsAccountId

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

dashboard_id instance-attribute 

dashboard_id: ShortRestrictiveResourceId

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

snapshot_configuration instance-attribute 

snapshot_configuration: SnapshotConfiguration

A structure that describes the configuration of the dashboard snapshot.

snapshot_job_id instance-attribute 

snapshot_job_id: ShortRestrictiveResourceId

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

user_configuration instance-attribute 

user_configuration: NotRequired[SnapshotUserConfiguration]

A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.

When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.