AWS CLI Command Reference

[ aws . quicksight ]

list-topic-reviewed-answers

Description

Lists all reviewed answers for a Q Topic.

See also: AWS API Documentation

Synopsis

  list-topic-reviewed-answers
--aws-account-id <value>
--topic-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--aws-account-id (string) [required]

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

Constraints:

  • min: 12
  • max: 12
  • pattern: ^[0-9]{12}$

--topic-id (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.

Constraints:

  • max: 256
  • pattern: ^[A-Za-z0-9-_.\\+]*$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

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.

Constraints:

  • max: 256
  • pattern: ^[A-Za-z0-9-_.\\+]*$

TopicArn -> (string)

The Amazon Resource Name (ARN) of the topic.

Answers -> (list)

The definition of all Answers in the topic.

(structure)

The deinition for a TopicReviewedAnswer .

Arn -> (string)

The Amazon Resource Name (ARN) of the reviewed answer.

AnswerId -> (string) [required]

The answer ID of the reviewed answer.

Constraints:

  • max: 256
  • pattern: ^[A-Za-z0-9-_.\\+]*$

DatasetArn -> (string) [required]

The Dataset ARN for the TopicReviewedAnswer .

Question -> (string) [required]

The question for the TopicReviewedAnswer .

Constraints:

  • max: 256

Mir -> (structure)

The mir for the TopicReviewedAnswer .

Metrics -> (list)

The metrics for the TopicIR .

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRMetric .

MetricId -> (structure)

The metric ID for the TopicIRMetric .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (structure)

The function for the TopicIRMetric .

Aggregation -> (string)

The aggregation of an Agg function.

Possible values:

  • 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 -> (map)

The aggregation parameters for an Agg function.

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

Period -> (string)

The period of an Agg function.

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

PeriodField -> (string)

The period field for an Agg function.

Constraints:

  • max: 256

Operands -> (list)

The operands for the TopicIRMetric .

Constraints:

  • max: 25

(structure)

The definition for the identifier.

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

ComparisonMethod -> (structure)

The comparison method for the TopicIRMetric .

Type -> (string)

The type for the TopicIRComparisonMethod .

Possible values:

  • 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 -> (string)

The period for the TopicIRComparisonMethod .

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

WindowSize -> (integer)

The window size for the TopicIRComparisonMethod .

Expression -> (string)

The expression for the TopicIRMetric .

Constraints:

  • min: 1
  • max: 4096

CalculatedFieldReferences -> (list)

The calculated field references for the TopicIRMetric .

Constraints:

  • max: 250

(structure)

The definition for the identifier.

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

DisplayFormat -> (string)

The display format for the TopicIRMetric .

Possible values:

  • AUTO
  • PERCENT
  • CURRENCY
  • NUMBER
  • DATE
  • STRING

DisplayFormatOptions -> (structure)

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.

Constraints:

  • max: 256

DateFormat -> (string)

Determines the DateTime format.

Constraints:

  • max: 256

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

  • COMMA
  • DOT

GroupingSeparator -> (string)

Determines the grouping separator.

Constraints:

  • max: 256

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.

Constraints:

  • max: 256

Suffix -> (string)

The suffix value for a display format.

Constraints:

  • max: 256

UnitScaler -> (string)

The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Possible values:

  • NONE
  • AUTO
  • THOUSANDS
  • MILLIONS
  • BILLIONS
  • TRILLIONS
  • LAKHS
  • CRORES

NegativeFormat -> (structure)

The negative format.

Prefix -> (string)

The prefix for a negative format.

Constraints:

  • max: 256

Suffix -> (string)

The suffix for a negative format.

Constraints:

  • max: 256

CurrencySymbol -> (string)

The currency symbol, such as USD .

Constraints:

  • max: 256

NamedEntity -> (structure)

The named entity for the TopicIRMetric .

NamedEntityName -> (string)

The NamedEntityName for the NamedEntityRef .

Constraints:

  • max: 256

GroupByList -> (list)

The GroupBy list for the TopicIR .

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRGroupBy .

FieldName -> (structure)

The field name for the TopicIRGroupBy .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

TimeGranularity -> (string)

The time granularity for the TopicIRGroupBy .

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Sort -> (structure)

The sort for the TopicIRGroupBy .

Operand -> (structure)

The operand for a TopicSortClause .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

SortDirection -> (string)

The sort direction for the TopicSortClause .

Possible values:

  • ASCENDING
  • DESCENDING

DisplayFormat -> (string)

The display format for the TopicIRGroupBy .

Possible values:

  • AUTO
  • PERCENT
  • CURRENCY
  • NUMBER
  • DATE
  • STRING

DisplayFormatOptions -> (structure)

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.

Constraints:

  • max: 256

DateFormat -> (string)

Determines the DateTime format.

Constraints:

  • max: 256

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

  • COMMA
  • DOT

GroupingSeparator -> (string)

Determines the grouping separator.

Constraints:

  • max: 256

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.

Constraints:

  • max: 256

Suffix -> (string)

The suffix value for a display format.

Constraints:

  • max: 256

UnitScaler -> (string)

The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Possible values:

  • NONE
  • AUTO
  • THOUSANDS
  • MILLIONS
  • BILLIONS
  • TRILLIONS
  • LAKHS
  • CRORES

NegativeFormat -> (structure)

The negative format.

Prefix -> (string)

The prefix for a negative format.

Constraints:

  • max: 256

Suffix -> (string)

The suffix for a negative format.

Constraints:

  • max: 256

CurrencySymbol -> (string)

The currency symbol, such as USD .

Constraints:

  • max: 256

NamedEntity -> (structure)

The named entity for the TopicIRGroupBy .

NamedEntityName -> (string)

The NamedEntityName for the NamedEntityRef .

Constraints:

  • max: 256

Filters -> (list)

The filters for the TopicIR .

Constraints:

  • max: 2000

(list)

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRFilterOption .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

Sort -> (structure)

The sort for the TopicIR .

Operand -> (structure)

The operand for a TopicSortClause .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

SortDirection -> (string)

The sort direction for the TopicSortClause .

Possible values:

  • ASCENDING
  • DESCENDING

ContributionAnalysis -> (structure)

The contribution analysis for the TopicIR .

Factors -> (list)

The factors for a TopicIRContributionAnalysis .

Constraints:

  • max: 50

(structure)

The definition for the ContributionAnalysisFactor .

FieldName -> (string)

The field name of the ContributionAnalysisFactor .

Constraints:

  • max: 256

TimeRanges -> (structure)

The time ranges for the TopicIRContributionAnalysis .

StartRange -> (structure)

The start range for the ContributionAnalysisTimeRanges .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

EndRange -> (structure)

The end range for the ContributionAnalysisTimeRanges .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

Direction -> (string)

The direction for the TopicIRContributionAnalysis .

Possible values:

  • INCREASE
  • DECREASE
  • NEUTRAL

SortType -> (string)

The sort type for the TopicIRContributionAnalysis .

Possible values:

  • ABSOLUTE_DIFFERENCE
  • CONTRIBUTION_PERCENTAGE
  • DEVIATION_FROM_EXPECTED
  • PERCENTAGE_DIFFERENCE

Visual -> (structure)

The visual for the TopicIR .

type -> (string)

The type for a VisualOptions .

Constraints:

  • max: 256

PrimaryVisual -> (structure)

The primary visual for the TopicReviewedAnswer .

VisualId -> (string)

The visual ID for the TopicVisual .

Constraints:

  • max: 256

Role -> (string)

The role for the TopicVisual .

Possible values:

  • PRIMARY
  • COMPLIMENTARY
  • MULTI_INTENT
  • FALLBACK
  • FRAGMENT

Ir -> (structure)

The ir for the TopicVisual .

Metrics -> (list)

The metrics for the TopicIR .

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRMetric .

MetricId -> (structure)

The metric ID for the TopicIRMetric .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (structure)

The function for the TopicIRMetric .

Aggregation -> (string)

The aggregation of an Agg function.

Possible values:

  • 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 -> (map)

The aggregation parameters for an Agg function.

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

Period -> (string)

The period of an Agg function.

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

PeriodField -> (string)

The period field for an Agg function.

Constraints:

  • max: 256

Operands -> (list)

The operands for the TopicIRMetric .

Constraints:

  • max: 25

(structure)

The definition for the identifier.

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

ComparisonMethod -> (structure)

The comparison method for the TopicIRMetric .

Type -> (string)

The type for the TopicIRComparisonMethod .

Possible values:

  • 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 -> (string)

The period for the TopicIRComparisonMethod .

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

WindowSize -> (integer)

The window size for the TopicIRComparisonMethod .

Expression -> (string)

The expression for the TopicIRMetric .

Constraints:

  • min: 1
  • max: 4096

CalculatedFieldReferences -> (list)

The calculated field references for the TopicIRMetric .

Constraints:

  • max: 250

(structure)

The definition for the identifier.

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

DisplayFormat -> (string)

The display format for the TopicIRMetric .

Possible values:

  • AUTO
  • PERCENT
  • CURRENCY
  • NUMBER
  • DATE
  • STRING

DisplayFormatOptions -> (structure)

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.

Constraints:

  • max: 256

DateFormat -> (string)

Determines the DateTime format.

Constraints:

  • max: 256

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

  • COMMA
  • DOT

GroupingSeparator -> (string)

Determines the grouping separator.

Constraints:

  • max: 256

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.

Constraints:

  • max: 256

Suffix -> (string)

The suffix value for a display format.

Constraints:

  • max: 256

UnitScaler -> (string)

The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Possible values:

  • NONE
  • AUTO
  • THOUSANDS
  • MILLIONS
  • BILLIONS
  • TRILLIONS
  • LAKHS
  • CRORES

NegativeFormat -> (structure)

The negative format.

Prefix -> (string)

The prefix for a negative format.

Constraints:

  • max: 256

Suffix -> (string)

The suffix for a negative format.

Constraints:

  • max: 256

CurrencySymbol -> (string)

The currency symbol, such as USD .

Constraints:

  • max: 256

NamedEntity -> (structure)

The named entity for the TopicIRMetric .

NamedEntityName -> (string)

The NamedEntityName for the NamedEntityRef .

Constraints:

  • max: 256

GroupByList -> (list)

The GroupBy list for the TopicIR .

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRGroupBy .

FieldName -> (structure)

The field name for the TopicIRGroupBy .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

TimeGranularity -> (string)

The time granularity for the TopicIRGroupBy .

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Sort -> (structure)

The sort for the TopicIRGroupBy .

Operand -> (structure)

The operand for a TopicSortClause .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

SortDirection -> (string)

The sort direction for the TopicSortClause .

Possible values:

  • ASCENDING
  • DESCENDING

DisplayFormat -> (string)

The display format for the TopicIRGroupBy .

Possible values:

  • AUTO
  • PERCENT
  • CURRENCY
  • NUMBER
  • DATE
  • STRING

DisplayFormatOptions -> (structure)

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.

Constraints:

  • max: 256

DateFormat -> (string)

Determines the DateTime format.

Constraints:

  • max: 256

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

  • COMMA
  • DOT

GroupingSeparator -> (string)

Determines the grouping separator.

Constraints:

  • max: 256

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.

Constraints:

  • max: 256

Suffix -> (string)

The suffix value for a display format.

Constraints:

  • max: 256

UnitScaler -> (string)

The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Possible values:

  • NONE
  • AUTO
  • THOUSANDS
  • MILLIONS
  • BILLIONS
  • TRILLIONS
  • LAKHS
  • CRORES

NegativeFormat -> (structure)

The negative format.

Prefix -> (string)

The prefix for a negative format.

Constraints:

  • max: 256

Suffix -> (string)

The suffix for a negative format.

Constraints:

  • max: 256

CurrencySymbol -> (string)

The currency symbol, such as USD .

Constraints:

  • max: 256

NamedEntity -> (structure)

The named entity for the TopicIRGroupBy .

NamedEntityName -> (string)

The NamedEntityName for the NamedEntityRef .

Constraints:

  • max: 256

Filters -> (list)

The filters for the TopicIR .

Constraints:

  • max: 2000

(list)

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRFilterOption .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

Sort -> (structure)

The sort for the TopicIR .

Operand -> (structure)

The operand for a TopicSortClause .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

SortDirection -> (string)

The sort direction for the TopicSortClause .

Possible values:

  • ASCENDING
  • DESCENDING

ContributionAnalysis -> (structure)

The contribution analysis for the TopicIR .

Factors -> (list)

The factors for a TopicIRContributionAnalysis .

Constraints:

  • max: 50

(structure)

The definition for the ContributionAnalysisFactor .

FieldName -> (string)

The field name of the ContributionAnalysisFactor .

Constraints:

  • max: 256

TimeRanges -> (structure)

The time ranges for the TopicIRContributionAnalysis .

StartRange -> (structure)

The start range for the ContributionAnalysisTimeRanges .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

EndRange -> (structure)

The end range for the ContributionAnalysisTimeRanges .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

Direction -> (string)

The direction for the TopicIRContributionAnalysis .

Possible values:

  • INCREASE
  • DECREASE
  • NEUTRAL

SortType -> (string)

The sort type for the TopicIRContributionAnalysis .

Possible values:

  • ABSOLUTE_DIFFERENCE
  • CONTRIBUTION_PERCENTAGE
  • DEVIATION_FROM_EXPECTED
  • PERCENTAGE_DIFFERENCE

Visual -> (structure)

The visual for the TopicIR .

type -> (string)

The type for a VisualOptions .

Constraints:

  • max: 256

SupportingVisuals -> (list)

The supporting visuals for the TopicVisual .

(structure)

The definition for a TopicVisual .

VisualId -> (string)

The visual ID for the TopicVisual .

Constraints:

  • max: 256

Role -> (string)

The role for the TopicVisual .

Possible values:

  • PRIMARY
  • COMPLIMENTARY
  • MULTI_INTENT
  • FALLBACK
  • FRAGMENT

Ir -> (structure)

The ir for the TopicVisual .

Metrics -> (list)

The metrics for the TopicIR .

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRMetric .

MetricId -> (structure)

The metric ID for the TopicIRMetric .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (structure)

The function for the TopicIRMetric .

Aggregation -> (string)

The aggregation of an Agg function.

Possible values:

  • 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 -> (map)

The aggregation parameters for an Agg function.

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

Period -> (string)

The period of an Agg function.

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

PeriodField -> (string)

The period field for an Agg function.

Constraints:

  • max: 256

Operands -> (list)

The operands for the TopicIRMetric .

Constraints:

  • max: 25

(structure)

The definition for the identifier.

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

ComparisonMethod -> (structure)

The comparison method for the TopicIRMetric .

Type -> (string)

The type for the TopicIRComparisonMethod .

Possible values:

  • 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 -> (string)

The period for the TopicIRComparisonMethod .

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

WindowSize -> (integer)

The window size for the TopicIRComparisonMethod .

Expression -> (string)

The expression for the TopicIRMetric .

Constraints:

  • min: 1
  • max: 4096

CalculatedFieldReferences -> (list)

The calculated field references for the TopicIRMetric .

Constraints:

  • max: 250

(structure)

The definition for the identifier.

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

DisplayFormat -> (string)

The display format for the TopicIRMetric .

Possible values:

  • AUTO
  • PERCENT
  • CURRENCY
  • NUMBER
  • DATE
  • STRING

DisplayFormatOptions -> (structure)

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.

Constraints:

  • max: 256

DateFormat -> (string)

Determines the DateTime format.

Constraints:

  • max: 256

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

  • COMMA
  • DOT

GroupingSeparator -> (string)

Determines the grouping separator.

Constraints:

  • max: 256

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.

Constraints:

  • max: 256

Suffix -> (string)

The suffix value for a display format.

Constraints:

  • max: 256

UnitScaler -> (string)

The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Possible values:

  • NONE
  • AUTO
  • THOUSANDS
  • MILLIONS
  • BILLIONS
  • TRILLIONS
  • LAKHS
  • CRORES

NegativeFormat -> (structure)

The negative format.

Prefix -> (string)

The prefix for a negative format.

Constraints:

  • max: 256

Suffix -> (string)

The suffix for a negative format.

Constraints:

  • max: 256

CurrencySymbol -> (string)

The currency symbol, such as USD .

Constraints:

  • max: 256

NamedEntity -> (structure)

The named entity for the TopicIRMetric .

NamedEntityName -> (string)

The NamedEntityName for the NamedEntityRef .

Constraints:

  • max: 256

GroupByList -> (list)

The GroupBy list for the TopicIR .

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRGroupBy .

FieldName -> (structure)

The field name for the TopicIRGroupBy .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

TimeGranularity -> (string)

The time granularity for the TopicIRGroupBy .

Possible values:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Sort -> (structure)

The sort for the TopicIRGroupBy .

Operand -> (structure)

The operand for a TopicSortClause .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

SortDirection -> (string)

The sort direction for the TopicSortClause .

Possible values:

  • ASCENDING
  • DESCENDING

DisplayFormat -> (string)

The display format for the TopicIRGroupBy .

Possible values:

  • AUTO
  • PERCENT
  • CURRENCY
  • NUMBER
  • DATE
  • STRING

DisplayFormatOptions -> (structure)

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.

Constraints:

  • max: 256

DateFormat -> (string)

Determines the DateTime format.

Constraints:

  • max: 256

DecimalSeparator -> (string)

Determines the decimal separator.

Possible values:

  • COMMA
  • DOT

GroupingSeparator -> (string)

Determines the grouping separator.

Constraints:

  • max: 256

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.

Constraints:

  • max: 256

Suffix -> (string)

The suffix value for a display format.

Constraints:

  • max: 256

UnitScaler -> (string)

The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS , MILLIONS , BILLIONS , and TRILLIONS .

Possible values:

  • NONE
  • AUTO
  • THOUSANDS
  • MILLIONS
  • BILLIONS
  • TRILLIONS
  • LAKHS
  • CRORES

NegativeFormat -> (structure)

The negative format.

Prefix -> (string)

The prefix for a negative format.

Constraints:

  • max: 256

Suffix -> (string)

The suffix for a negative format.

Constraints:

  • max: 256

CurrencySymbol -> (string)

The currency symbol, such as USD .

Constraints:

  • max: 256

NamedEntity -> (structure)

The named entity for the TopicIRGroupBy .

NamedEntityName -> (string)

The NamedEntityName for the NamedEntityRef .

Constraints:

  • max: 256

Filters -> (list)

The filters for the TopicIR .

Constraints:

  • max: 2000

(list)

Constraints:

  • max: 2000

(structure)

The definition for a TopicIRFilterOption .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

Sort -> (structure)

The sort for the TopicIR .

Operand -> (structure)

The operand for a TopicSortClause .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

SortDirection -> (string)

The sort direction for the TopicSortClause .

Possible values:

  • ASCENDING
  • DESCENDING

ContributionAnalysis -> (structure)

The contribution analysis for the TopicIR .

Factors -> (list)

The factors for a TopicIRContributionAnalysis .

Constraints:

  • max: 50

(structure)

The definition for the ContributionAnalysisFactor .

FieldName -> (string)

The field name of the ContributionAnalysisFactor .

Constraints:

  • max: 256

TimeRanges -> (structure)

The time ranges for the TopicIRContributionAnalysis .

StartRange -> (structure)

The start range for the ContributionAnalysisTimeRanges .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

EndRange -> (structure)

The end range for the ContributionAnalysisTimeRanges .

FilterType -> (string)

The filter type for the TopicIRFilterOption .

Possible values:

  • 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 -> (string)

The filter class for the TopicIRFilterOption .

Possible values:

  • ENFORCED_VALUE_FILTER
  • CONDITIONAL_VALUE_FILTER
  • NAMED_VALUE_FILTER

OperandField -> (structure)

The operand field for the TopicIRFilterOption .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the TopicIRFilterOption .

Possible values:

  • CONTAINS
  • EXACT
  • STARTS_WITH
  • ENDS_WITH
  • CONTAINS_STRING
  • PREVIOUS
  • THIS
  • LAST
  • NEXT
  • NOW

Constant -> (structure)

The constant for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inverse -> (boolean)

The inverse for the TopicIRFilterOption .

NullFilter -> (string)

The null filter for the TopicIRFilterOption .

Possible values:

  • ALL_VALUES
  • NON_NULLS_ONLY
  • NULLS_ONLY

Aggregation -> (string)

The aggregation for the TopicIRFilterOption .

Possible values:

  • 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 -> (map)

The aggregation function parameters for the TopicIRFilterOption .

key -> (string)

Constraints:

  • min: 1
  • max: 256

value -> (string)

Constraints:

  • max: 1024

AggregationPartitionBy -> (list)

The AggregationPartitionBy for the TopicIRFilterOption .

Constraints:

  • max: 50

(structure)

The definition of an AggregationPartitionBy .

FieldName -> (string)

The field Name for an AggregationPartitionBy .

Constraints:

  • max: 256

TimeGranularity -> (string)

The TimeGranularity for an AggregationPartitionBy .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Range -> (structure)

The range for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

Inclusive -> (boolean)

The inclusive for the TopicIRFilterOption .

TimeGranularity -> (string)

The time granularity for the TopicIRFilterOption .

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

LastNextOffset -> (structure)

The last next offset for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

AggMetrics -> (list)

The agg metrics for the TopicIRFilterOption .

Constraints:

  • max: 100

(structure)

The definition for the FilterAggMetrics .

MetricOperand -> (structure)

The metric operand of the FilterAggMetrics .

Identity -> (string) [required]

The identity of the identifier.

Constraints:

  • max: 256

Function -> (string)

The function for the FilterAggMetrics .

Possible values:

  • 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 -> (string)

The sort direction for FilterAggMetrics .

Possible values:

  • ASCENDING
  • DESCENDING

TopBottomLimit -> (structure)

The TopBottomLimit for the TopicIRFilterOption .

ConstantType -> (string)

The constant type of a TopicConstantValue .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of the TopicConstantValue .

Constraints:

  • max: 1024

Minimum -> (string)

The minimum for the TopicConstantValue .

Constraints:

  • max: 1024

Maximum -> (string)

The maximum for the TopicConstantValue .

Constraints:

  • max: 1024

ValueList -> (list)

The value list of the TopicConstantValue .

Constraints:

  • max: 2000

(structure)

The definition for a CollectiveConstantEntry .

ConstantType -> (string)

The ConstantType of a CollectiveConstantEntry .

Possible values:

  • SINGULAR
  • RANGE
  • COLLECTIVE

Value -> (string)

The value of a CollectiveConstantEntry .

Constraints:

  • max: 1024

SortDirection -> (string)

The sort direction for the TopicIRFilterOption .

Possible values:

  • ASCENDING
  • DESCENDING

Anchor -> (structure)

The anchor for the TopicIRFilterOption .

AnchorType -> (string)

The AnchorType for the Anchor.

Possible values:

  • TODAY

TimeGranularity -> (string)

The TimeGranularity of the Anchor.

Possible values:

  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND

Offset -> (integer)

The offset of the Anchor.

Direction -> (string)

The direction for the TopicIRContributionAnalysis .

Possible values:

  • INCREASE
  • DECREASE
  • NEUTRAL

SortType -> (string)

The sort type for the TopicIRContributionAnalysis .

Possible values:

  • ABSOLUTE_DIFFERENCE
  • CONTRIBUTION_PERCENTAGE
  • DEVIATION_FROM_EXPECTED
  • PERCENTAGE_DIFFERENCE

Visual -> (structure)

The visual for the TopicIR .

type -> (string)

The type for a VisualOptions .

Constraints:

  • max: 256

SupportingVisuals -> (list)

The supporting visuals for the TopicVisual .

( … recursive … )

Template -> (structure)

The template for the TopicReviewedAnswer .

TemplateType -> (string)

The template type for the TopicTemplate .

Constraints:

  • max: 256

Slots -> (list)

The slots for the TopicTemplate .

(structure)

The definition for the slot.

SlotId -> (string)

The slot ID of the slot.

Constraints:

  • max: 256

VisualId -> (string)

The visual ID for the slot.

Constraints:

  • max: 256

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.
© Copyright 2025, Amazon Web Services. Created using Sphinx.