Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListTopicRefreshSchedules

Lists all of the refresh schedules for a topic.

Request Syntax


GET /accounts/AwsAccountId/topics/TopicId/schedules HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the Amazon account that contains the topic whose refresh schedule you want described.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

TopicId

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

Length Constraints: Maximum length of 256.

Pattern: ^[A-Za-z0-9-_.\\+]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "RefreshSchedules": [ 
      { 
         "DatasetArn": "string",
         "DatasetId": "string",
         "DatasetName": "string",
         "RefreshSchedule": { 
            "BasedOnSpiceSchedule": boolean,
            "IsEnabled": boolean,
            "RepeatAt": "string",
            "StartingAt": number,
            "Timezone": "string",
            "TopicScheduleType": "string"
         }
      }
   ],
   "RequestId": "string",
   "TopicArn": "string",
   "TopicId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

RefreshSchedules

The list of topic refresh schedules.

Type: Array of TopicRefreshScheduleSummary objects

RequestId

The Amazon request ID for this operation.

Type: String

TopicArn

The Amazon Resource Name (ARN) of the topic.

Type: String

TopicId

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[A-Za-z0-9-_.\\+]*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The Amazon request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of ListTopicRefreshSchedules.

Sample Request


GET /accounts/{AwsAccountId}/topics/{TopicId}/schedules HTTP/1.1
Content-type: application/json