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

DescribeTopicRefresh

Describes the status of a topic refresh.

Request Syntax


GET /accounts/AwsAccountId/topics/TopicId/refresh/RefreshId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the topic whose refresh you want to describe.

Length Constraints: Fixed length of 12.

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

Required: Yes

RefreshId

The ID of the refresh, which is performed when the topic is created or updated.

Required: Yes

TopicId

The ID of the topic that you want to describe. 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 does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "RefreshDetails": { 
      "RefreshArn": "string",
      "RefreshId": "string",
      "RefreshStatus": "string"
   },
   "RequestId": "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.

RefreshDetails

Details of the refresh, which is performed when the topic is created or updated.

Type: TopicRefreshDetails object

RequestId

The AWS request ID for this operation.

Type: String

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

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

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 DescribeTopicRefresh.

Sample Request


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