Skip to content

Describe Topic Refresh

quicksight_describe_topic_refresh R Documentation

Describes the status of a topic refresh

Description

Describes the status of a topic refresh.

Usage

quicksight_describe_topic_refresh(AwsAccountId, TopicId, RefreshId)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.

TopicId

[required] The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

RefreshId

[required] The ID of the refresh, which is performed when the topic is created or updated.

Value

A list with the following syntax:

list(
  RefreshDetails = list(
    RefreshArn = "string",
    RefreshId = "string",
    RefreshStatus = "INITIALIZED"|"RUNNING"|"FAILED"|"COMPLETED"|"CANCELLED"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

svc$describe_topic_refresh(
  AwsAccountId = "string",
  TopicId = "string",
  RefreshId = "string"
)