- 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.
ListTopicRefreshSchedulesCommand
Lists all of the refresh schedules for a topic.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, ListTopicRefreshSchedulesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, ListTopicRefreshSchedulesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // ListTopicRefreshSchedulesRequest
AwsAccountId: "STRING_VALUE", // required
TopicId: "STRING_VALUE", // required
};
const command = new ListTopicRefreshSchedulesCommand(input);
const response = await client.send(command);
// { // ListTopicRefreshSchedulesResponse
// TopicId: "STRING_VALUE",
// TopicArn: "STRING_VALUE",
// RefreshSchedules: [ // TopicRefreshScheduleSummaries
// { // TopicRefreshScheduleSummary
// DatasetId: "STRING_VALUE",
// DatasetArn: "STRING_VALUE",
// DatasetName: "STRING_VALUE",
// RefreshSchedule: { // TopicRefreshSchedule
// IsEnabled: true || false, // required
// BasedOnSpiceSchedule: true || false, // required
// StartingAt: new Date("TIMESTAMP"),
// Timezone: "STRING_VALUE",
// RepeatAt: "STRING_VALUE",
// TopicScheduleType: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY",
// },
// },
// ],
// Status: Number("int"),
// RequestId: "STRING_VALUE",
// };
ListTopicRefreshSchedulesCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described. |
TopicId Required | string | undefined | The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
ListTopicRefreshSchedulesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
RefreshSchedules | TopicRefreshScheduleSummary[] | undefined | The list of topic refresh schedules. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
TopicArn | string | undefined | The Amazon Resource Name (ARN) of the topic. |
TopicId | string | undefined | The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
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. |
ConflictException | client | Updating or deleting a resource can cause an inconsistent state. |
InternalFailureException | server | An internal failure occurred. |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
LimitExceededException | client | A limit is exceeded. |
ResourceExistsException | client | The resource specified already exists. |
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. |