Skip to content

DescribeDashboardSnapshotJobResponse

Source code in docs_src/capo_quicksight/types/describe_dashboard_snapshot_job_response.py
class DescribeDashboardSnapshotJobResponse(TypedDict, closed=True):
    aws_account_id: NotRequired["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: NotRequired[
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    ]
    """<p>The ID of the dashboard that you have started a snapshot job for.</p>"""
    snapshot_job_id: NotRequired[
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    ]
    """<p>The ID of the job to be described. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>"""
    user_configuration: NotRequired[
        "capo_quicksight.types.snapshot_user_configuration_redacted.SnapshotUserConfigurationRedacted"
    ]
    """<p>The user configuration for the snapshot job. This information is provided when you make a <code>StartDashboardSnapshotJob</code> API call.</p>"""
    snapshot_configuration: NotRequired[
        "capo_quicksight.types.snapshot_configuration.SnapshotConfiguration"
    ]
    """<p>The snapshot configuration of the job. This information is provided when you make a <code>StartDashboardSnapshotJob</code> API call.</p>"""
    arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>"""
    job_status: NotRequired[
        "capo_quicksight.types.snapshot_job_status.SnapshotJobStatus"
    ]
    """<p>Indicates the status of a job. The status updates as the job executes. This shows one of the following values.</p> <ul> <li> <p> <code>COMPLETED</code> - The job was completed successfully.</p> </li> <li> <p> <code>FAILED</code> - The job failed to execute.</p> </li> <li> <p> <code>QUEUED</code> - The job is queued and hasn't started yet.</p> </li> <li> <p> <code>RUNNING</code> - The job is still running.</p> </li> </ul>"""
    created_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p> The time that the snapshot job was created. </p>"""
    last_updated_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p> The time that the snapshot job status was last updated. </p>"""
    request_id: NotRequired["capo_quicksight.types.non_empty_string.NonEmptyString"]
    """<p> The Amazon Web Services request ID for this operation. </p>"""
    status: "capo_quicksight.types.status_code.StatusCode"
    """<p>The HTTP status of the request</p>"""

arn instance-attribute

arn: NotRequired[Arn]

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

aws_account_id instance-attribute

aws_account_id: NotRequired[AwsAccountId]

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

created_time instance-attribute

created_time: NotRequired[Timestamp]

The time that the snapshot job was created.

dashboard_id instance-attribute

dashboard_id: NotRequired[ShortRestrictiveResourceId]

The ID of the dashboard that you have started a snapshot job for.

job_status instance-attribute

job_status: NotRequired[SnapshotJobStatus]

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

  • COMPLETED - The job was completed successfully.

  • FAILED - The job failed to execute.

  • QUEUED - The job is queued and hasn't started yet.

  • RUNNING - The job is still running.

last_updated_time instance-attribute

last_updated_time: NotRequired[Timestamp]

The time that the snapshot job status was last updated.

request_id instance-attribute

request_id: NotRequired[NonEmptyString]

The Amazon Web Services request ID for this operation.

snapshot_configuration instance-attribute

snapshot_configuration: NotRequired[SnapshotConfiguration]

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

snapshot_job_id instance-attribute

snapshot_job_id: NotRequired[ShortRestrictiveResourceId]

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

status instance-attribute

status: StatusCode

The HTTP status of the request

user_configuration instance-attribute

user_configuration: NotRequired[SnapshotUserConfigurationRedacted]

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.