DescribeTopic
Describes a topic.
Request Syntax
GET /accounts/AwsAccountId/topics/TopicId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The AWS account ID.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$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
{
"Arn": "string",
"RequestId": "string",
"Topic": {
"ConfigOptions": {
"QBusinessInsightsEnabled": boolean
},
"DataSets": [
{
"CalculatedFields": [
{
"Aggregation": "string",
"AllowedAggregations": [ "string" ],
"CalculatedFieldDescription": "string",
"CalculatedFieldName": "string",
"CalculatedFieldSynonyms": [ "string" ],
"CellValueSynonyms": [
{
"CellValue": "string",
"Synonyms": [ "string" ]
}
],
"ColumnDataRole": "string",
"ComparativeOrder": {
"SpecifedOrder": [ "string" ],
"TreatUndefinedSpecifiedValues": "string",
"UseOrdering": "string"
},
"DefaultFormatting": {
"DisplayFormat": "string",
"DisplayFormatOptions": {
"BlankCellFormat": "string",
"CurrencySymbol": "string",
"DateFormat": "string",
"DecimalSeparator": "string",
"FractionDigits": number,
"GroupingSeparator": "string",
"NegativeFormat": {
"Prefix": "string",
"Suffix": "string"
},
"Prefix": "string",
"Suffix": "string",
"UnitScaler": "string",
"UseBlankCellFormat": boolean,
"UseGrouping": boolean
}
},
"DisableIndexing": boolean,
"Expression": "string",
"IsIncludedInTopic": boolean,
"NeverAggregateInFilter": boolean,
"NonAdditive": boolean,
"NotAllowedAggregations": [ "string" ],
"SemanticType": {
"FalseyCellValue": "string",
"FalseyCellValueSynonyms": [ "string" ],
"SubTypeName": "string",
"TruthyCellValue": "string",
"TruthyCellValueSynonyms": [ "string" ],
"TypeName": "string",
"TypeParameters": {
"string" : "string"
}
},
"TimeGranularity": "string"
}
],
"Columns": [
{
"Aggregation": "string",
"AllowedAggregations": [ "string" ],
"CellValueSynonyms": [
{
"CellValue": "string",
"Synonyms": [ "string" ]
}
],
"ColumnDataRole": "string",
"ColumnDescription": "string",
"ColumnFriendlyName": "string",
"ColumnName": "string",
"ColumnSynonyms": [ "string" ],
"ComparativeOrder": {
"SpecifedOrder": [ "string" ],
"TreatUndefinedSpecifiedValues": "string",
"UseOrdering": "string"
},
"DefaultFormatting": {
"DisplayFormat": "string",
"DisplayFormatOptions": {
"BlankCellFormat": "string",
"CurrencySymbol": "string",
"DateFormat": "string",
"DecimalSeparator": "string",
"FractionDigits": number,
"GroupingSeparator": "string",
"NegativeFormat": {
"Prefix": "string",
"Suffix": "string"
},
"Prefix": "string",
"Suffix": "string",
"UnitScaler": "string",
"UseBlankCellFormat": boolean,
"UseGrouping": boolean
}
},
"DisableIndexing": boolean,
"IsIncludedInTopic": boolean,
"NeverAggregateInFilter": boolean,
"NonAdditive": boolean,
"NotAllowedAggregations": [ "string" ],
"SemanticType": {
"FalseyCellValue": "string",
"FalseyCellValueSynonyms": [ "string" ],
"SubTypeName": "string",
"TruthyCellValue": "string",
"TruthyCellValueSynonyms": [ "string" ],
"TypeName": "string",
"TypeParameters": {
"string" : "string"
}
},
"TimeGranularity": "string"
}
],
"DataAggregation": {
"DatasetRowDateGranularity": "string",
"DefaultDateColumnName": "string"
},
"DatasetArn": "string",
"DatasetDescription": "string",
"DatasetName": "string",
"Filters": [
{
"CategoryFilter": {
"CategoryFilterFunction": "string",
"CategoryFilterType": "string",
"Constant": {
"CollectiveConstant": {
"ValueList": [ "string" ]
},
"ConstantType": "string",
"SingularConstant": "string"
},
"Inverse": boolean
},
"DateRangeFilter": {
"Constant": {
"ConstantType": "string",
"RangeConstant": {
"Maximum": "string",
"Minimum": "string"
}
},
"Inclusive": boolean
},
"FilterClass": "string",
"FilterDescription": "string",
"FilterName": "string",
"FilterSynonyms": [ "string" ],
"FilterType": "string",
"NumericEqualityFilter": {
"Aggregation": "string",
"Constant": {
"ConstantType": "string",
"SingularConstant": "string"
}
},
"NumericRangeFilter": {
"Aggregation": "string",
"Constant": {
"ConstantType": "string",
"RangeConstant": {
"Maximum": "string",
"Minimum": "string"
}
},
"Inclusive": boolean
},
"OperandFieldName": "string",
"RelativeDateFilter": {
"Constant": {
"ConstantType": "string",
"SingularConstant": "string"
},
"RelativeDateFilterFunction": "string",
"TimeGranularity": "string"
}
}
],
"NamedEntities": [
{
"Definition": [
{
"FieldName": "string",
"Metric": {
"Aggregation": "string",
"AggregationFunctionParameters": {
"string" : "string"
}
},
"PropertyName": "string",
"PropertyRole": "string",
"PropertyUsage": "string"
}
],
"EntityDescription": "string",
"EntityName": "string",
"EntitySynonyms": [ "string" ],
"SemanticEntityType": {
"SubTypeName": "string",
"TypeName": "string",
"TypeParameters": {
"string" : "string"
}
}
}
]
}
],
"Description": "string",
"Name": "string",
"UserExperienceVersion": "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.
- Arn
-
The Amazon Resource Name (ARN) of the topic.
Type: String
- RequestId
-
The AWS request ID for this operation.
Type: String
- Topic
-
The definition of a topic.
Type: TopicDetails object
- TopicId
-
The ID of the topic that you want to describe. 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
- 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 DescribeTopic.
Sample Request
GET /accounts/{AwsAccountId}/topics/{TopicId} 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:
