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.
.
Usage¶
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"
)
)
)
)
)
)
)
)
),
ErrorInfo = list(
ErrorMessage = "string",
ErrorType = "string"
),
RequestId = "string",
Status = 123
)