- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeTopicRefreshCommand
Describes the status of a topic refresh.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, DescribeTopicRefreshCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DescribeTopicRefreshCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DescribeTopicRefreshRequest
AwsAccountId: "STRING_VALUE", // required
TopicId: "STRING_VALUE", // required
RefreshId: "STRING_VALUE", // required
};
const command = new DescribeTopicRefreshCommand(input);
const response = await client.send(command);
// { // DescribeTopicRefreshResponse
// RefreshDetails: { // TopicRefreshDetails
// RefreshArn: "STRING_VALUE",
// RefreshId: "STRING_VALUE",
// RefreshStatus: "INITIALIZED" || "RUNNING" || "FAILED" || "COMPLETED" || "CANCELLED",
// },
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
DescribeTopicRefreshCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
AwsAccountIdRequired | string | undefined | The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe. |
RefreshIdRequired | string | undefined | The ID of the refresh, which is performed when the topic is created or updated. |
TopicIdRequired | string | undefined | 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. |
DescribeTopicRefreshCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
RefreshDetails | TopicRefreshDetails | undefined | Details of the refresh, which is performed when the topic is created or updated. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | 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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials. |
| InternalFailureException | server | An internal failure occurred. |
| InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
| ResourceNotFoundException | client | One or more resources can't be found. |
| ThrottlingException | client | Access is throttled. |
| QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |