2024/07/12 - Amazon QuickSight - 3 new 9 updated api methods
Changes Vega ally control options and Support for Reviewed Answers in Topics
Creates new reviewed answers for a Q Topic.
See also: AWS API Documentation
Request Syntax
client.batch_create_topic_reviewed_answer(
AwsAccountId='string',
TopicId='string',
Answers=[
{
'AnswerId': 'string',
'DatasetArn': 'string',
'Question': 'string',
'Mir': {
'Metrics': [
{
'MetricId': {
'Identity': 'string'
},
'Function': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'PeriodField': 'string'
},
'Operands': [
{
'Identity': 'string'
},
],
'ComparisonMethod': {
'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE',
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'WindowSize': 123
},
'Expression': 'string',
'CalculatedFieldReferences': [
{
'Identity': 'string'
},
],
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'GroupByList': [
{
'FieldName': {
'Identity': 'string'
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'Filters': [
[
{
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
],
],
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'ContributionAnalysis': {
'Factors': [
{
'FieldName': 'string'
},
],
'TimeRanges': {
'StartRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
'EndRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
}
},
'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL',
'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE'
},
'Visual': {
'type': 'string'
}
},
'PrimaryVisual': {
'VisualId': 'string',
'Role': 'PRIMARY'|'COMPLIMENTARY'|'MULTI_INTENT'|'FALLBACK'|'FRAGMENT',
'Ir': {
'Metrics': [
{
'MetricId': {
'Identity': 'string'
},
'Function': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'PeriodField': 'string'
},
'Operands': [
{
'Identity': 'string'
},
],
'ComparisonMethod': {
'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE',
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'WindowSize': 123
},
'Expression': 'string',
'CalculatedFieldReferences': [
{
'Identity': 'string'
},
],
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'GroupByList': [
{
'FieldName': {
'Identity': 'string'
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'Filters': [
[
{
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
],
],
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'ContributionAnalysis': {
'Factors': [
{
'FieldName': 'string'
},
],
'TimeRanges': {
'StartRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
'EndRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
}
},
'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL',
'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE'
},
'Visual': {
'type': 'string'
}
},
'SupportingVisuals': [
{'... recursive ...'},
]
},
'Template': {
'TemplateType': 'string',
'Slots': [
{
'SlotId': 'string',
'VisualId': 'string'
},
]
}
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that you want to create a reviewed answer in.
string
[REQUIRED]
The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
list
[REQUIRED]
The definition of the Answers to be created.
(dict) --
The definition for a CreateTopicReviewedAnswer .
AnswerId (string) -- [REQUIRED]
The answer ID for the CreateTopicReviewedAnswer .
DatasetArn (string) -- [REQUIRED]
The Dataset arn for the CreateTopicReviewedAnswer .
Question (string) -- [REQUIRED]
The Question to be created.
Mir (dict) --
The Mir for the CreateTopicReviewedAnswer .
Metrics (list) --
The metrics for the TopicIR .
(dict) --
The definition for a TopicIRMetric .
MetricId (dict) --
The metric ID for the TopicIRMetric .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (dict) --
The function for the TopicIRMetric .
Aggregation (string) --
The aggregation of an Agg function.
AggregationFunctionParameters (dict) --
The aggregation parameters for an Agg function.
(string) --
(string) --
Period (string) --
The period of an Agg function.
PeriodField (string) --
The period field for an Agg function.
Operands (list) --
The operands for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) -- [REQUIRED]
The identity of the identifier.
ComparisonMethod (dict) --
The comparison method for the TopicIRMetric .
Type (string) --
The type for the TopicIRComparisonMethod .
Period (string) --
The period for the TopicIRComparisonMethod .
WindowSize (integer) --
The window size for the TopicIRComparisonMethod .
Expression (string) --
The expression for the TopicIRMetric .
CalculatedFieldReferences (list) --
The calculated field references for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) -- [REQUIRED]
The identity of the identifier.
DisplayFormat (string) --
The display format for the TopicIRMetric .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRMetric .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
GroupByList (list) --
The GroupBy list for the TopicIR .
(dict) --
The definition for a TopicIRGroupBy .
FieldName (dict) --
The field name for the TopicIRGroupBy .
Identity (string) -- [REQUIRED]
The identity of the identifier.
TimeGranularity (string) --
The time granularity for the TopicIRGroupBy .
Sort (dict) --
The sort for the TopicIRGroupBy .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) -- [REQUIRED]
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
DisplayFormat (string) --
The display format for the TopicIRGroupBy .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRGroupBy .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
Filters (list) --
The filters for the TopicIR .
(list) --
(dict) --
The definition for a TopicIRFilterOption .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Sort (dict) --
The sort for the TopicIR .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) -- [REQUIRED]
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
ContributionAnalysis (dict) --
The contribution analysis for the TopicIR .
Factors (list) --
The factors for a TopicIRContributionAnalysis .
(dict) --
The definition for the ContributionAnalysisFactor .
FieldName (string) --
The field name of the ContributionAnalysisFactor .
TimeRanges (dict) --
The time ranges for the TopicIRContributionAnalysis .
StartRange (dict) --
The start range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
EndRange (dict) --
The end range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Direction (string) --
The direction for the TopicIRContributionAnalysis .
SortType (string) --
The sort type for the TopicIRContributionAnalysis .
Visual (dict) --
The visual for the TopicIR .
type (string) --
The type for a VisualOptions .
PrimaryVisual (dict) --
The PrimaryVisual for the CreateTopicReviewedAnswer .
VisualId (string) --
The visual ID for the TopicVisual .
Role (string) --
The role for the TopicVisual .
Ir (dict) --
The ir for the TopicVisual .
Metrics (list) --
The metrics for the TopicIR .
(dict) --
The definition for a TopicIRMetric .
MetricId (dict) --
The metric ID for the TopicIRMetric .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (dict) --
The function for the TopicIRMetric .
Aggregation (string) --
The aggregation of an Agg function.
AggregationFunctionParameters (dict) --
The aggregation parameters for an Agg function.
(string) --
(string) --
Period (string) --
The period of an Agg function.
PeriodField (string) --
The period field for an Agg function.
Operands (list) --
The operands for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) -- [REQUIRED]
The identity of the identifier.
ComparisonMethod (dict) --
The comparison method for the TopicIRMetric .
Type (string) --
The type for the TopicIRComparisonMethod .
Period (string) --
The period for the TopicIRComparisonMethod .
WindowSize (integer) --
The window size for the TopicIRComparisonMethod .
Expression (string) --
The expression for the TopicIRMetric .
CalculatedFieldReferences (list) --
The calculated field references for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) -- [REQUIRED]
The identity of the identifier.
DisplayFormat (string) --
The display format for the TopicIRMetric .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRMetric .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
GroupByList (list) --
The GroupBy list for the TopicIR .
(dict) --
The definition for a TopicIRGroupBy .
FieldName (dict) --
The field name for the TopicIRGroupBy .
Identity (string) -- [REQUIRED]
The identity of the identifier.
TimeGranularity (string) --
The time granularity for the TopicIRGroupBy .
Sort (dict) --
The sort for the TopicIRGroupBy .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) -- [REQUIRED]
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
DisplayFormat (string) --
The display format for the TopicIRGroupBy .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRGroupBy .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
Filters (list) --
The filters for the TopicIR .
(list) --
(dict) --
The definition for a TopicIRFilterOption .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Sort (dict) --
The sort for the TopicIR .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) -- [REQUIRED]
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
ContributionAnalysis (dict) --
The contribution analysis for the TopicIR .
Factors (list) --
The factors for a TopicIRContributionAnalysis .
(dict) --
The definition for the ContributionAnalysisFactor .
FieldName (string) --
The field name of the ContributionAnalysisFactor .
TimeRanges (dict) --
The time ranges for the TopicIRContributionAnalysis .
StartRange (dict) --
The start range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
EndRange (dict) --
The end range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) -- [REQUIRED]
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Direction (string) --
The direction for the TopicIRContributionAnalysis .
SortType (string) --
The sort type for the TopicIRContributionAnalysis .
Visual (dict) --
The visual for the TopicIR .
type (string) --
The type for a VisualOptions .
SupportingVisuals (list) --
The supporting visuals for the TopicVisual .
(dict) --
The definition for a TopicVisual .
Template (dict) --
The template for the CreateTopicReviewedAnswer .
TemplateType (string) --
The template type for the TopicTemplate .
Slots (list) --
The slots for the TopicTemplate .
(dict) --
The definition for the slot.
SlotId (string) --
The slot ID of the slot.
VisualId (string) --
The visual ID for the slot.
dict
Response Syntax
{
'TopicId': 'string',
'TopicArn': 'string',
'SucceededAnswers': [
{
'AnswerId': 'string'
},
],
'InvalidAnswers': [
{
'AnswerId': 'string',
'Error': 'INTERNAL_ERROR'|'MISSING_ANSWER'|'DATASET_DOES_NOT_EXIST'|'INVALID_DATASET_ARN'|'DUPLICATED_ANSWER'|'INVALID_DATA'|'MISSING_REQUIRED_FIELDS'
},
],
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TopicId (string) --
The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
TopicArn (string) --
The Amazon Resource Name (ARN) of the topic.
SucceededAnswers (list) --
The definition of Answers that are successfully created.
(dict) --
The definition for a SucceededTopicReviewedAnswer .
AnswerId (string) --
The answer ID for the SucceededTopicReviewedAnswer .
InvalidAnswers (list) --
The definition of Answers that are invalid and not created.
(dict) --
The definition for a InvalidTopicReviewedAnswer .
AnswerId (string) --
The answer ID for the InvalidTopicReviewedAnswer .
Error (string) --
The error that is returned for the InvalidTopicReviewedAnswer .
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Lists all reviewed answers for a Q Topic.
See also: AWS API Documentation
Request Syntax
client.list_topic_reviewed_answers(
AwsAccountId='string',
TopicId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.
string
[REQUIRED]
The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'TopicId': 'string',
'TopicArn': 'string',
'Answers': [
{
'Arn': 'string',
'AnswerId': 'string',
'DatasetArn': 'string',
'Question': 'string',
'Mir': {
'Metrics': [
{
'MetricId': {
'Identity': 'string'
},
'Function': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'PeriodField': 'string'
},
'Operands': [
{
'Identity': 'string'
},
],
'ComparisonMethod': {
'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE',
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'WindowSize': 123
},
'Expression': 'string',
'CalculatedFieldReferences': [
{
'Identity': 'string'
},
],
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'GroupByList': [
{
'FieldName': {
'Identity': 'string'
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'Filters': [
[
{
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
],
],
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'ContributionAnalysis': {
'Factors': [
{
'FieldName': 'string'
},
],
'TimeRanges': {
'StartRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
'EndRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
}
},
'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL',
'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE'
},
'Visual': {
'type': 'string'
}
},
'PrimaryVisual': {
'VisualId': 'string',
'Role': 'PRIMARY'|'COMPLIMENTARY'|'MULTI_INTENT'|'FALLBACK'|'FRAGMENT',
'Ir': {
'Metrics': [
{
'MetricId': {
'Identity': 'string'
},
'Function': {
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'PeriodField': 'string'
},
'Operands': [
{
'Identity': 'string'
},
],
'ComparisonMethod': {
'Type': 'DIFF'|'PERC_DIFF'|'DIFF_AS_PERC'|'POP_CURRENT_DIFF_AS_PERC'|'POP_CURRENT_DIFF'|'POP_OVERTIME_DIFF_AS_PERC'|'POP_OVERTIME_DIFF'|'PERCENT_OF_TOTAL'|'RUNNING_SUM'|'MOVING_AVERAGE',
'Period': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'WindowSize': 123
},
'Expression': 'string',
'CalculatedFieldReferences': [
{
'Identity': 'string'
},
],
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'GroupByList': [
{
'FieldName': {
'Identity': 'string'
},
'TimeGranularity': 'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'|'MONTH'|'QUARTER'|'YEAR',
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'DisplayFormat': 'AUTO'|'PERCENT'|'CURRENCY'|'NUMBER'|'DATE'|'STRING',
'DisplayFormatOptions': {
'UseBlankCellFormat': True|False,
'BlankCellFormat': 'string',
'DateFormat': 'string',
'DecimalSeparator': 'COMMA'|'DOT',
'GroupingSeparator': 'string',
'UseGrouping': True|False,
'FractionDigits': 123,
'Prefix': 'string',
'Suffix': 'string',
'UnitScaler': 'NONE'|'AUTO'|'THOUSANDS'|'MILLIONS'|'BILLIONS'|'TRILLIONS',
'NegativeFormat': {
'Prefix': 'string',
'Suffix': 'string'
},
'CurrencySymbol': 'string'
},
'NamedEntity': {
'NamedEntityName': 'string'
}
},
],
'Filters': [
[
{
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
],
],
'Sort': {
'Operand': {
'Identity': 'string'
},
'SortDirection': 'ASCENDING'|'DESCENDING'
},
'ContributionAnalysis': {
'Factors': [
{
'FieldName': 'string'
},
],
'TimeRanges': {
'StartRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
},
'EndRange': {
'FilterType': 'CATEGORY_FILTER'|'NUMERIC_EQUALITY_FILTER'|'NUMERIC_RANGE_FILTER'|'DATE_RANGE_FILTER'|'RELATIVE_DATE_FILTER'|'TOP_BOTTOM_FILTER'|'EQUALS'|'RANK_LIMIT_FILTER'|'ACCEPT_ALL_FILTER',
'FilterClass': 'ENFORCED_VALUE_FILTER'|'CONDITIONAL_VALUE_FILTER'|'NAMED_VALUE_FILTER',
'OperandField': {
'Identity': 'string'
},
'Function': 'CONTAINS'|'EXACT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS_STRING'|'PREVIOUS'|'THIS'|'LAST'|'NEXT'|'NOW',
'Constant': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inverse': True|False,
'NullFilter': 'ALL_VALUES'|'NON_NULLS_ONLY'|'NULLS_ONLY',
'Aggregation': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'AggregationFunctionParameters': {
'string': 'string'
},
'AggregationPartitionBy': [
{
'FieldName': 'string',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND'
},
],
'Range': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'Inclusive': True|False,
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'LastNextOffset': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'AggMetrics': [
{
'MetricOperand': {
'Identity': 'string'
},
'Function': 'SUM'|'MIN'|'MAX'|'COUNT'|'AVERAGE'|'DISTINCT_COUNT'|'STDEV'|'STDEVP'|'VAR'|'VARP'|'PERCENTILE'|'MEDIAN'|'PTD_SUM'|'PTD_MIN'|'PTD_MAX'|'PTD_COUNT'|'PTD_DISTINCT_COUNT'|'PTD_AVERAGE'|'COLUMN'|'CUSTOM',
'SortDirection': 'ASCENDING'|'DESCENDING'
},
],
'TopBottomLimit': {
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string',
'Minimum': 'string',
'Maximum': 'string',
'ValueList': [
{
'ConstantType': 'SINGULAR'|'RANGE'|'COLLECTIVE',
'Value': 'string'
},
]
},
'SortDirection': 'ASCENDING'|'DESCENDING',
'Anchor': {
'AnchorType': 'TODAY',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'Offset': 123
}
}
},
'Direction': 'INCREASE'|'DECREASE'|'NEUTRAL',
'SortType': 'ABSOLUTE_DIFFERENCE'|'CONTRIBUTION_PERCENTAGE'|'DEVIATION_FROM_EXPECTED'|'PERCENTAGE_DIFFERENCE'
},
'Visual': {
'type': 'string'
}
},
'SupportingVisuals': [
{'... recursive ...'},
]
},
'Template': {
'TemplateType': 'string',
'Slots': [
{
'SlotId': 'string',
'VisualId': 'string'
},
]
}
},
],
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TopicId (string) --
The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
TopicArn (string) --
The Amazon Resource Name (ARN) of the topic.
Answers (list) --
The definition of all Answers in the topic.
(dict) --
The deinition for a TopicReviewedAnswer .
Arn (string) --
The Amazon Resource Name (ARN) of the reviewed answer.
AnswerId (string) --
The answer ID of the reviewed answer.
DatasetArn (string) --
The Dataset ARN for the TopicReviewedAnswer .
Question (string) --
The question for the TopicReviewedAnswer .
Mir (dict) --
The mir for the TopicReviewedAnswer .
Metrics (list) --
The metrics for the TopicIR .
(dict) --
The definition for a TopicIRMetric .
MetricId (dict) --
The metric ID for the TopicIRMetric .
Identity (string) --
The identity of the identifier.
Function (dict) --
The function for the TopicIRMetric .
Aggregation (string) --
The aggregation of an Agg function.
AggregationFunctionParameters (dict) --
The aggregation parameters for an Agg function.
(string) --
(string) --
Period (string) --
The period of an Agg function.
PeriodField (string) --
The period field for an Agg function.
Operands (list) --
The operands for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) --
The identity of the identifier.
ComparisonMethod (dict) --
The comparison method for the TopicIRMetric .
Type (string) --
The type for the TopicIRComparisonMethod .
Period (string) --
The period for the TopicIRComparisonMethod .
WindowSize (integer) --
The window size for the TopicIRComparisonMethod .
Expression (string) --
The expression for the TopicIRMetric .
CalculatedFieldReferences (list) --
The calculated field references for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) --
The identity of the identifier.
DisplayFormat (string) --
The display format for the TopicIRMetric .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRMetric .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
GroupByList (list) --
The GroupBy list for the TopicIR .
(dict) --
The definition for a TopicIRGroupBy .
FieldName (dict) --
The field name for the TopicIRGroupBy .
Identity (string) --
The identity of the identifier.
TimeGranularity (string) --
The time granularity for the TopicIRGroupBy .
Sort (dict) --
The sort for the TopicIRGroupBy .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) --
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
DisplayFormat (string) --
The display format for the TopicIRGroupBy .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRGroupBy .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
Filters (list) --
The filters for the TopicIR .
(list) --
(dict) --
The definition for a TopicIRFilterOption .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Sort (dict) --
The sort for the TopicIR .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) --
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
ContributionAnalysis (dict) --
The contribution analysis for the TopicIR .
Factors (list) --
The factors for a TopicIRContributionAnalysis .
(dict) --
The definition for the ContributionAnalysisFactor .
FieldName (string) --
The field name of the ContributionAnalysisFactor .
TimeRanges (dict) --
The time ranges for the TopicIRContributionAnalysis .
StartRange (dict) --
The start range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
EndRange (dict) --
The end range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Direction (string) --
The direction for the TopicIRContributionAnalysis .
SortType (string) --
The sort type for the TopicIRContributionAnalysis .
Visual (dict) --
The visual for the TopicIR .
type (string) --
The type for a VisualOptions .
PrimaryVisual (dict) --
The primary visual for the TopicReviewedAnswer .
VisualId (string) --
The visual ID for the TopicVisual .
Role (string) --
The role for the TopicVisual .
Ir (dict) --
The ir for the TopicVisual .
Metrics (list) --
The metrics for the TopicIR .
(dict) --
The definition for a TopicIRMetric .
MetricId (dict) --
The metric ID for the TopicIRMetric .
Identity (string) --
The identity of the identifier.
Function (dict) --
The function for the TopicIRMetric .
Aggregation (string) --
The aggregation of an Agg function.
AggregationFunctionParameters (dict) --
The aggregation parameters for an Agg function.
(string) --
(string) --
Period (string) --
The period of an Agg function.
PeriodField (string) --
The period field for an Agg function.
Operands (list) --
The operands for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) --
The identity of the identifier.
ComparisonMethod (dict) --
The comparison method for the TopicIRMetric .
Type (string) --
The type for the TopicIRComparisonMethod .
Period (string) --
The period for the TopicIRComparisonMethod .
WindowSize (integer) --
The window size for the TopicIRComparisonMethod .
Expression (string) --
The expression for the TopicIRMetric .
CalculatedFieldReferences (list) --
The calculated field references for the TopicIRMetric .
(dict) --
The definition for the identifier.
Identity (string) --
The identity of the identifier.
DisplayFormat (string) --
The display format for the TopicIRMetric .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRMetric .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
GroupByList (list) --
The GroupBy list for the TopicIR .
(dict) --
The definition for a TopicIRGroupBy .
FieldName (dict) --
The field name for the TopicIRGroupBy .
Identity (string) --
The identity of the identifier.
TimeGranularity (string) --
The time granularity for the TopicIRGroupBy .
Sort (dict) --
The sort for the TopicIRGroupBy .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) --
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
DisplayFormat (string) --
The display format for the TopicIRGroupBy .
DisplayFormatOptions (dict) --
A structure that represents additional options for display formatting.
UseBlankCellFormat (boolean) --
A Boolean value that indicates whether to use blank cell format.
BlankCellFormat (string) --
Determines the blank cell format.
DateFormat (string) --
Determines the DateTime format.
DecimalSeparator (string) --
Determines the decimal separator.
GroupingSeparator (string) --
Determines the grouping separator.
UseGrouping (boolean) --
A Boolean value that indicates whether to use grouping.
FractionDigits (integer) --
Determines the number of fraction digits.
Prefix (string) --
The prefix value for a display format.
Suffix (string) --
The suffix value for a display format.
UnitScaler (string) --
The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .
NegativeFormat (dict) --
The negative format.
Prefix (string) --
The prefix for a negative format.
Suffix (string) --
The suffix for a negative format.
CurrencySymbol (string) --
The currency symbol, such as USD .
NamedEntity (dict) --
The named entity for the TopicIRGroupBy .
NamedEntityName (string) --
The NamedEntityName for the NamedEntityRef .
Filters (list) --
The filters for the TopicIR .
(list) --
(dict) --
The definition for a TopicIRFilterOption .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Sort (dict) --
The sort for the TopicIR .
Operand (dict) --
The operand for a TopicSortClause .
Identity (string) --
The identity of the identifier.
SortDirection (string) --
The sort direction for the TopicSortClause .
ContributionAnalysis (dict) --
The contribution analysis for the TopicIR .
Factors (list) --
The factors for a TopicIRContributionAnalysis .
(dict) --
The definition for the ContributionAnalysisFactor .
FieldName (string) --
The field name of the ContributionAnalysisFactor .
TimeRanges (dict) --
The time ranges for the TopicIRContributionAnalysis .
StartRange (dict) --
The start range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
EndRange (dict) --
The end range for the ContributionAnalysisTimeRanges .
FilterType (string) --
The filter type for the TopicIRFilterOption .
FilterClass (string) --
The filter class for the TopicIRFilterOption .
OperandField (dict) --
The operand field for the TopicIRFilterOption .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the TopicIRFilterOption .
Constant (dict) --
The constant for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inverse (boolean) --
The inverse for the TopicIRFilterOption .
NullFilter (string) --
The null filter for the TopicIRFilterOption .
Aggregation (string) --
The aggregation for the TopicIRFilterOption .
AggregationFunctionParameters (dict) --
The aggregation function parameters for the TopicIRFilterOption .
(string) --
(string) --
AggregationPartitionBy (list) --
The AggregationPartitionBy for the TopicIRFilterOption .
(dict) --
The definition of an AggregationPartitionBy .
FieldName (string) --
The field Name for an AggregationPartitionBy .
TimeGranularity (string) --
The TimeGranularity for an AggregationPartitionBy .
Range (dict) --
The range for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
Inclusive (boolean) --
The inclusive for the TopicIRFilterOption .
TimeGranularity (string) --
The time granularity for the TopicIRFilterOption .
LastNextOffset (dict) --
The last next offset for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
AggMetrics (list) --
The agg metrics for the TopicIRFilterOption .
(dict) --
The definition for the FilterAggMetrics .
MetricOperand (dict) --
The metric operand of the FilterAggMetrics .
Identity (string) --
The identity of the identifier.
Function (string) --
The function for the FilterAggMetrics .
SortDirection (string) --
The sort direction for FilterAggMetrics .
TopBottomLimit (dict) --
The TopBottomLimit for the TopicIRFilterOption .
ConstantType (string) --
The constant type of a TopicConstantValue .
Value (string) --
The value of the TopicConstantValue .
Minimum (string) --
The minimum for the TopicConstantValue .
Maximum (string) --
The maximum for the TopicConstantValue .
ValueList (list) --
The value list of the TopicConstantValue .
(dict) --
The definition for a CollectiveConstantEntry .
ConstantType (string) --
The ConstantType of a CollectiveConstantEntry .
Value (string) --
The value of a CollectiveConstantEntry .
SortDirection (string) --
The sort direction for the TopicIRFilterOption .
Anchor (dict) --
The anchor for the TopicIRFilterOption .
AnchorType (string) --
The AnchorType for the Anchor.
TimeGranularity (string) --
The TimeGranularity of the Anchor.
Offset (integer) --
The offset of the Anchor.
Direction (string) --
The direction for the TopicIRContributionAnalysis .
SortType (string) --
The sort type for the TopicIRContributionAnalysis .
Visual (dict) --
The visual for the TopicIR .
type (string) --
The type for a VisualOptions .
SupportingVisuals (list) --
The supporting visuals for the TopicVisual .
(dict) --
The definition for a TopicVisual .
Template (dict) --
The template for the TopicReviewedAnswer .
TemplateType (string) --
The template type for the TopicTemplate .
Slots (list) --
The slots for the TopicTemplate .
(dict) --
The definition for the slot.
SlotId (string) --
The slot ID of the slot.
VisualId (string) --
The visual ID for the slot.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Deletes reviewed answers for Q Topic.
See also: AWS API Documentation
Request Syntax
client.batch_delete_topic_reviewed_answer(
AwsAccountId='string',
TopicId='string',
AnswerIds=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that you want to delete a reviewed answers in.
string
[REQUIRED]
The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
list
The Answer IDs of the Answers to be deleted.
(string) --
dict
Response Syntax
{
'TopicId': 'string',
'TopicArn': 'string',
'SucceededAnswers': [
{
'AnswerId': 'string'
},
],
'InvalidAnswers': [
{
'AnswerId': 'string',
'Error': 'INTERNAL_ERROR'|'MISSING_ANSWER'|'DATASET_DOES_NOT_EXIST'|'INVALID_DATASET_ARN'|'DUPLICATED_ANSWER'|'INVALID_DATA'|'MISSING_REQUIRED_FIELDS'
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
TopicId (string) --
The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
TopicArn (string) --
The Amazon Resource Name (ARN) of the topic.
SucceededAnswers (list) --
The definition of Answers that are successfully deleted.
(dict) --
The definition for a SucceededTopicReviewedAnswer .
AnswerId (string) --
The answer ID for the SucceededTopicReviewedAnswer .
InvalidAnswers (list) --
The definition of Answers that are invalid and not deleted.
(dict) --
The definition for a InvalidTopicReviewedAnswer .
AnswerId (string) --
The answer ID for the InvalidTopicReviewedAnswer .
Error (string) --
The error that is returned for the InvalidTopicReviewedAnswer .
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition .
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Provides a detailed description of the definition of an analysis.
Note
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Provides a detailed description of the definition of a dashboard.
Note
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Provides a detailed description of the definition of a template.
Note
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
string
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Updates a dashboard in an Amazon Web Services account.
Note
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}},
'Sheets': {'FilterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}},
'ParameterControls': {'DateTimePicker': {'DisplayOptions': {'DateIconVisibility': 'HIDDEN '
'| '
'VISIBLE',
'HelperTextVisibility': 'HIDDEN '
'| '
'VISIBLE'}}}}}}
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateId (string) --
The ID for the template.
Arn (string) --
The Amazon Resource Name (ARN) for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
CreationStatus (string) --
The creation status of the template.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.