CreateTopicRefreshSchedule
Creates a topic refresh schedule.
Request Syntax
POST /accounts/AwsAccountId/topics/TopicId/schedules HTTP/1.1
Content-type: application/json
{
"DatasetArn": "string",
"DatasetName": "string",
"RefreshSchedule": {
"BasedOnSpiceSchedule": boolean,
"IsEnabled": boolean,
"RepeatAt": "string",
"StartingAt": number,
"Timezone": "string",
"TopicScheduleType": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that contains the topic you're creating a refresh schedule for.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- TopicId
-
The ID of the topic that you want to modify. This ID is unique per AWS Region for each AWS account.
Length Constraints: Maximum length of 256.
Pattern:
^[A-Za-z0-9-_.\\+]*$Required: Yes
Request Body
The request accepts the following data in JSON format.
- DatasetArn
-
The Amazon Resource Name (ARN) of the dataset.
Type: String
Required: Yes
- RefreshSchedule
-
The definition of a refresh schedule.
Type: TopicRefreshSchedule object
Required: Yes
- DatasetName
-
The name of the dataset.
Type: String
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"DatasetArn": "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.
- DatasetArn
-
The Amazon Resource Name (ARN) of the dataset.
Type: String
- RequestId
-
The AWS request ID for this operation.
Type: String
- TopicArn
-
The Amazon Resource Name (ARN) of the topic.
Type: String
- TopicId
-
The ID of the topic that you want to modify. This ID is unique per AWS Region for each AWS 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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
HTTP Status Code: 409
- ResourceExistsException
-
The resource specified already exists.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
Examples
Example
This example illustrates one usage of CreateTopicRefreshSchedule.
Sample Request
POST /accounts/{AwsAccountId}/topics/{TopicId}/schedules HTTP/1.1
Content-type: application/jsonSee Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
