# UpdateTopicRefreshSchedule
<a name="API_UpdateTopicRefreshSchedule"></a>

Updates a topic refresh schedule.

## Request Syntax
<a name="API_UpdateTopicRefreshSchedule_RequestSyntax"></a>

```
PUT /accounts/AwsAccountId/topics/TopicId/schedules/DatasetId HTTP/1.1
Content-type: application/json

{
   "RefreshSchedule": { 
      "BasedOnSpiceSchedule": boolean,
      "IsEnabled": boolean,
      "RepeatAt": "string",
      "StartingAt": number,
      "Timezone": "string",
      "TopicScheduleType": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateTopicRefreshSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AwsAccountId](#API_UpdateTopicRefreshSchedule_RequestSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-request-uri-AwsAccountId"></a>
The ID of the Amazon account that contains the topic whose refresh schedule you want to update.  
Length Constraints: Fixed length of 12.  
Pattern: `^[0-9]{12}$`   
Required: Yes

 ** [DatasetId](#API_UpdateTopicRefreshSchedule_RequestSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-request-uri-DatasetId"></a>
The ID of the dataset.  
Required: Yes

 ** [TopicId](#API_UpdateTopicRefreshSchedule_RequestSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-request-uri-TopicId"></a>
The ID of the topic that you want to modify. 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
<a name="API_UpdateTopicRefreshSchedule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RefreshSchedule](#API_UpdateTopicRefreshSchedule_RequestSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-request-RefreshSchedule"></a>
The definition of a refresh schedule.  
Type: [TopicRefreshSchedule](API_TopicRefreshSchedule.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateTopicRefreshSchedule_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

{
   "DatasetArn": "string",
   "RequestId": "string",
   "TopicArn": "string",
   "TopicId": "string"
}
```

## Response Elements
<a name="API_UpdateTopicRefreshSchedule_ResponseElements"></a>

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

 ** [Status](#API_UpdateTopicRefreshSchedule_ResponseSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-response-Status"></a>
The HTTP status of the request.

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

 ** [DatasetArn](#API_UpdateTopicRefreshSchedule_ResponseSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-response-DatasetArn"></a>
The Amazon Resource Name (ARN) of the dataset.  
Type: String

 ** [RequestId](#API_UpdateTopicRefreshSchedule_ResponseSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-response-RequestId"></a>
The Amazon request ID for this operation.  
Type: String

 ** [TopicArn](#API_UpdateTopicRefreshSchedule_ResponseSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-response-TopicArn"></a>
The Amazon Resource Name (ARN) of the topic.  
Type: String

 ** [TopicId](#API_UpdateTopicRefreshSchedule_ResponseSyntax) **   <a name="QS-UpdateTopicRefreshSchedule-response-TopicId"></a>
The ID of the topic that you want to modify. 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
<a name="API_UpdateTopicRefreshSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateTopicRefreshSchedule_Examples"></a>

### Example
<a name="API_UpdateTopicRefreshSchedule_Example_1"></a>

This example illustrates one usage of UpdateTopicRefreshSchedule.

#### Sample Request
<a name="API_UpdateTopicRefreshSchedule_Example_1_Request"></a>

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

## See Also
<a name="API_UpdateTopicRefreshSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/quicksight-2018-04-01/UpdateTopicRefreshSchedule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateTopicRefreshSchedule)