Describe Dashboard Snapshot Job

quicksight_describe_dashboard_snapshot_job

R Documentation

Describes an existing snapshot job

Description

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

Registered user support

This API can be called as before to get status of a job started by the same Quick Sight user.

Possible error scenarios

Request will fail with an Access Denied error in the following scenarios:

• The credentials have expired.

• Job has been started by a different user.

• Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.

Usage

quicksight_describe_dashboard_snapshot_job(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(
  AwsAccountId = "string",
  DashboardId = "string",
  SnapshotJobId = "string",
  UserConfiguration = list(
    AnonymousUsers = list(
      list(
        RowLevelPermissionTagKeys = list(
          "string"
        )
      )
    )
  ),
  SnapshotConfiguration = list(
    FileGroups = list(
      list(
        Files = list(
          list(
            SheetSelections = list(
              list(
                SheetId = "string",
                SelectionScope = "ALL_VISUALS"|"SELECTED_VISUALS",
                VisualIds = list(
                  "string"
                )
              )
            ),
            FormatType = "CSV"|"PDF"|"EXCEL"
          )
        )
      )
    ),
    DestinationConfiguration = list(
      S3Destinations = list(
        list(
          BucketConfiguration = list(
            BucketName = "string",
            BucketPrefix = "string",
            BucketRegion = "string"
          )
        )
      )
    ),
    Parameters = list(
      StringParameters = list(
        list(
          Name = "string",
          Values = list(
            "string"
          )
        )
      ),
      IntegerParameters = list(
        list(
          Name = "string",
          Values = list(
            123
          )
        )
      ),
      DecimalParameters = list(
        list(
          Name = "string",
          Values = list(
            123.0
          )
        )
      ),
      DateTimeParameters = list(
        list(
          Name = "string",
          Values = list(
            as.POSIXct(
              "2015-01-01"
            )
          )
        )
      )
    )
  ),
  Arn = "string",
  JobStatus = "QUEUED"|"RUNNING"|"COMPLETED"|"FAILED",
  CreatedTime = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedTime = as.POSIXct(
    "2015-01-01"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

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