describe_dashboard_snapshot_job ¶

def describe_dashboard_snapshot_job(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    dashboard_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    snapshot_job_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_dashboard_snapshot_job_response.DescribeDashboardSnapshotJobResponse":
    """<p>Describes an existing snapshot job.</p> <p>Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see <code>JobStatus</code>.</p> <p> <b>Registered user support</b> </p> <p>This API can be called as before to get status of a job started by the same Quick Sight user.</p> <p> <b>Possible error scenarios</b> </p> <p>Request will fail with an Access Denied error in the following scenarios:</p> <ul> <li> <p>The credentials have expired.</p> </li> <li> <p>Job has been started by a different user.</p> </li> <li> <p>Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.</p> </li> </ul>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
        dashboard_id: <p>The ID of the dashboard that you have started a snapshot job for.</p>
        snapshot_job_id: <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>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_dashboard_snapshot_job_request.DescribeDashboardSnapshotJobRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_dashboard_snapshot_job_response.DescribeDashboardSnapshotJobResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_dashboard_snapshot_job

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_dashboard_snapshot_job.describe_dashboard_snapshot_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_quicksight.types.describe_dashboard_snapshot_job_response.DescribeDashboardSnapshotJobResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.describe_dashboard_snapshot_job_response

        return capo_quicksight.types.describe_dashboard_snapshot_job_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeDashboardSnapshotJob", redact_output=_redact_output
        ),
    )
    input_: capo_quicksight.types.describe_dashboard_snapshot_job_request.DescribeDashboardSnapshotJobRequest = {
        "aws_account_id": aws_account_id,
        "dashboard_id": dashboard_id,
        "snapshot_job_id": snapshot_job_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output