Skip to content

Describe Dashboard Snapshot Job Result

quicksight_describe_dashboard_snapshot_job_result R Documentation

Describes the result of an existing snapshot job that has finished running

Description

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a describe_dashboard_snapshot_job API call.

If the job has not finished running, this operation returns a message that says ⁠Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.⁠.

Registered user support

This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it.

Possible error scenarios

The request fails with an Access Denied error in the following scenarios:

  • The credentials have expired.

  • The job was started by a different user.

  • The registered user doesn't have access to the specified dashboard.

The request succeeds but the job fails in the following scenarios:

  • DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard.

  • CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats.

The request succeeds but the response contains an error code in the following scenarios:

  • CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats.

  • RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings.

  • CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings.

  • DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.

Usage

quicksight_describe_dashboard_snapshot_job_result(AwsAccountId,
  DashboardId, SnapshotJobId)

Arguments

AwsAccountId

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

[required] The ID of the dashboard that you have started a snapshot job for.
SnapshotJobId

[required] The ID of the job to be described. The job ID is set when you start a new job with a start_dashboard_snapshot_job API call.

Value

A list with the following syntax:

list(
  Arn = "string",
  JobStatus = "QUEUED"|"RUNNING"|"COMPLETED"|"FAILED",
  CreatedTime = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedTime = as.POSIXct(
    "2015-01-01"
  ),
  Result = list(
    AnonymousUsers = list(
      list(
        FileGroups = list(
          list(
            Files = list(
              list(
                SheetSelections = list(
                  list(
                    SheetId = "string",
                    SelectionScope = "ALL_VISUALS"|"SELECTED_VISUALS",
                    VisualIds = list(
                      "string"
                    )
                  )
                ),
                FormatType = "CSV"|"PDF"|"EXCEL"
              )
            ),
            S3Results = list(
              list(
                S3DestinationConfiguration = list(
                  BucketConfiguration = list(
                    BucketName = "string",
                    BucketPrefix = "string",
                    BucketRegion = "string"
                  )
                ),
                S3Uri = "string",
                ErrorInfo = list(
                  list(
                    ErrorMessage = "string",
                    ErrorType = "string"
                  )
                )
              )
            )
          )
        )
      )
    ),
    RegisteredUsers = list(
      list(
        FileGroups = list(
          list(
            Files = list(
              list(
                SheetSelections = list(
                  list(
                    SheetId = "string",
                    SelectionScope = "ALL_VISUALS"|"SELECTED_VISUALS",
                    VisualIds = list(
                      "string"
                    )
                  )
                ),
                FormatType = "CSV"|"PDF"|"EXCEL"
              )
            ),
            S3Results = list(
              list(
                S3DestinationConfiguration = list(
                  BucketConfiguration = list(
                    BucketName = "string",
                    BucketPrefix = "string",
                    BucketRegion = "string"
                  )
                ),
                S3Uri = "string",
                ErrorInfo = list(
                  list(
                    ErrorMessage = "string",
                    ErrorType = "string"
                  )
                )
              )
            )
          )
        )
      )
    )
  ),
  ErrorInfo = list(
    ErrorMessage = "string",
    ErrorType = "string"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

svc$describe_dashboard_snapshot_job_result(
  AwsAccountId = "string",
  DashboardId = "string",
  SnapshotJobId = "string"
)