BatchCreateTopicReviewedAnswer - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

BatchCreateTopicReviewedAnswer

Creates new reviewed answers for a Q Topic.

Request Syntax

POST /accounts/AwsAccountId/topics/TopicId/batch-create-reviewed-answers HTTP/1.1 Content-type: application/json { "Answers": [ { "AnswerId": "string", "DatasetArn": "string", "Mir": { "ContributionAnalysis": { "Direction": "string", "Factors": [ { "FieldName": "string" } ], "SortType": "string", "TimeRanges": { "EndRange": { "AggMetrics": [ { "Function": "string", "MetricOperand": { "Identity": "string" }, "SortDirection": "string" } ], "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "AggregationPartitionBy": [ { "FieldName": "string", "TimeGranularity": "string" } ], "Anchor": { "AnchorType": "string", "Offset": number, "TimeGranularity": "string" }, "Constant": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "FilterClass": "string", "FilterType": "string", "Function": "string", "Inclusive": boolean, "Inverse": boolean, "LastNextOffset": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "NullFilter": "string", "OperandField": { "Identity": "string" }, "Range": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "SortDirection": "string", "TimeGranularity": "string", "TopBottomLimit": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] } }, "StartRange": { "AggMetrics": [ { "Function": "string", "MetricOperand": { "Identity": "string" }, "SortDirection": "string" } ], "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "AggregationPartitionBy": [ { "FieldName": "string", "TimeGranularity": "string" } ], "Anchor": { "AnchorType": "string", "Offset": number, "TimeGranularity": "string" }, "Constant": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "FilterClass": "string", "FilterType": "string", "Function": "string", "Inclusive": boolean, "Inverse": boolean, "LastNextOffset": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "NullFilter": "string", "OperandField": { "Identity": "string" }, "Range": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "SortDirection": "string", "TimeGranularity": "string", "TopBottomLimit": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] } } } }, "Filters": [ [ { "AggMetrics": [ { "Function": "string", "MetricOperand": { "Identity": "string" }, "SortDirection": "string" } ], "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "AggregationPartitionBy": [ { "FieldName": "string", "TimeGranularity": "string" } ], "Anchor": { "AnchorType": "string", "Offset": number, "TimeGranularity": "string" }, "Constant": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "FilterClass": "string", "FilterType": "string", "Function": "string", "Inclusive": boolean, "Inverse": boolean, "LastNextOffset": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "NullFilter": "string", "OperandField": { "Identity": "string" }, "Range": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "SortDirection": "string", "TimeGranularity": "string", "TopBottomLimit": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] } } ] ], "GroupByList": [ { "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 }, "FieldName": { "Identity": "string" }, "NamedEntity": { "NamedEntityName": "string" }, "Sort": { "Operand": { "Identity": "string" }, "SortDirection": "string" }, "TimeGranularity": "string" } ], "Metrics": [ { "CalculatedFieldReferences": [ { "Identity": "string" } ], "ComparisonMethod": { "Period": "string", "Type": "string", "WindowSize": number }, "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 }, "Expression": "string", "Function": { "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "Period": "string", "PeriodField": "string" }, "MetricId": { "Identity": "string" }, "NamedEntity": { "NamedEntityName": "string" }, "Operands": [ { "Identity": "string" } ] } ], "Sort": { "Operand": { "Identity": "string" }, "SortDirection": "string" }, "Visual": { "type": "string" } }, "PrimaryVisual": { "Ir": { "ContributionAnalysis": { "Direction": "string", "Factors": [ { "FieldName": "string" } ], "SortType": "string", "TimeRanges": { "EndRange": { "AggMetrics": [ { "Function": "string", "MetricOperand": { "Identity": "string" }, "SortDirection": "string" } ], "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "AggregationPartitionBy": [ { "FieldName": "string", "TimeGranularity": "string" } ], "Anchor": { "AnchorType": "string", "Offset": number, "TimeGranularity": "string" }, "Constant": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "FilterClass": "string", "FilterType": "string", "Function": "string", "Inclusive": boolean, "Inverse": boolean, "LastNextOffset": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "NullFilter": "string", "OperandField": { "Identity": "string" }, "Range": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "SortDirection": "string", "TimeGranularity": "string", "TopBottomLimit": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] } }, "StartRange": { "AggMetrics": [ { "Function": "string", "MetricOperand": { "Identity": "string" }, "SortDirection": "string" } ], "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "AggregationPartitionBy": [ { "FieldName": "string", "TimeGranularity": "string" } ], "Anchor": { "AnchorType": "string", "Offset": number, "TimeGranularity": "string" }, "Constant": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "FilterClass": "string", "FilterType": "string", "Function": "string", "Inclusive": boolean, "Inverse": boolean, "LastNextOffset": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "NullFilter": "string", "OperandField": { "Identity": "string" }, "Range": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "SortDirection": "string", "TimeGranularity": "string", "TopBottomLimit": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] } } } }, "Filters": [ [ { "AggMetrics": [ { "Function": "string", "MetricOperand": { "Identity": "string" }, "SortDirection": "string" } ], "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "AggregationPartitionBy": [ { "FieldName": "string", "TimeGranularity": "string" } ], "Anchor": { "AnchorType": "string", "Offset": number, "TimeGranularity": "string" }, "Constant": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "FilterClass": "string", "FilterType": "string", "Function": "string", "Inclusive": boolean, "Inverse": boolean, "LastNextOffset": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "NullFilter": "string", "OperandField": { "Identity": "string" }, "Range": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] }, "SortDirection": "string", "TimeGranularity": "string", "TopBottomLimit": { "ConstantType": "string", "Maximum": "string", "Minimum": "string", "Value": "string", "ValueList": [ { "ConstantType": "string", "Value": "string" } ] } } ] ], "GroupByList": [ { "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 }, "FieldName": { "Identity": "string" }, "NamedEntity": { "NamedEntityName": "string" }, "Sort": { "Operand": { "Identity": "string" }, "SortDirection": "string" }, "TimeGranularity": "string" } ], "Metrics": [ { "CalculatedFieldReferences": [ { "Identity": "string" } ], "ComparisonMethod": { "Period": "string", "Type": "string", "WindowSize": number }, "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 }, "Expression": "string", "Function": { "Aggregation": "string", "AggregationFunctionParameters": { "string" : "string" }, "Period": "string", "PeriodField": "string" }, "MetricId": { "Identity": "string" }, "NamedEntity": { "NamedEntityName": "string" }, "Operands": [ { "Identity": "string" } ] } ], "Sort": { "Operand": { "Identity": "string" }, "SortDirection": "string" }, "Visual": { "type": "string" } }, "Role": "string", "SupportingVisuals": [ "TopicVisual" ], "VisualId": "string" }, "Question": "string", "Template": { "Slots": [ { "SlotId": "string", "VisualId": "string" } ], "TemplateType": "string" } } ] }

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the Amazon account that you want to create a reviewed answer in.

Length Constraints: Fixed length of 12.

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

Required: Yes

TopicId

The ID for the topic reviewed answer that you want to create. 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 accepts the following data in JSON format.

Answers

The definition of the Answers to be created.

Type: Array of CreateTopicReviewedAnswer objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: Yes

Response Syntax

HTTP/1.1 Status Content-type: application/json { "InvalidAnswers": [ { "AnswerId": "string", "Error": "string" } ], "RequestId": "string", "SucceededAnswers": [ { "AnswerId": "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.

InvalidAnswers

The definition of Answers that are invalid and not created.

Type: Array of InvalidTopicReviewedAnswer objects

RequestId

The Amazon request ID for this operation.

Type: String

SucceededAnswers

The definition of Answers that are successfully created.

Type: Array of SucceededTopicReviewedAnswer objects

TopicArn

The Amazon Resource Name (ARN) of the topic.

Type: String

TopicId

The ID for the topic reviewed answer that you want to create. 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 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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: