This product is not supported for your selected Datadog site. ().
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_quicksight_topic

account_id

Type: STRING

arn

Type: STRING
Provider name: Arn
Description: The Amazon Resource Name (ARN) of the topic.

request_id

Type: STRING
Provider name: RequestId
Description: The Amazon Web Services request ID for this operation.

status

Type: INT32
Provider name: Status
Description: The HTTP status of the request.

tags

Type: UNORDERED_LIST_STRING

topic

Type: STRUCT
Provider name: Topic
Description: The definition of a topic.

  • config_options
    Type: STRUCT
    Provider name: ConfigOptions
    Description: Configuration options for a Topic.
    • q_business_insights_enabled
      Type: BOOLEAN
      Provider name: QBusinessInsightsEnabled
      Description: Enables Amazon Q Business Insights for a Topic.
  • data_sets
    Type: UNORDERED_LIST_STRUCT
    Provider name: DataSets
    Description: The data sets that the topic is associated with.
    • calculated_fields
      Type: UNORDERED_LIST_STRUCT
      Provider name: CalculatedFields
      Description: The list of calculated field definitions.
      • aggregation
        Type: STRING
        Provider name: Aggregation
        Description: The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
      • allowed_aggregations
        Type: UNORDERED_LIST_STRING
        Provider name: AllowedAggregations
        Description: The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
      • calculated_field_description
        Type: STRING
        Provider name: CalculatedFieldDescription
        Description: The calculated field description.
      • calculated_field_name
        Type: STRING
        Provider name: CalculatedFieldName
        Description: The calculated field name.
      • calculated_field_synonyms
        Type: UNORDERED_LIST_STRING
        Provider name: CalculatedFieldSynonyms
        Description: The other names or aliases for the calculated field.
      • cell_value_synonyms
        Type: UNORDERED_LIST_STRUCT
        Provider name: CellValueSynonyms
        Description: The other names or aliases for the calculated field cell value.
        • cell_value
          Type: STRING
          Provider name: CellValue
          Description: The cell value.
        • synonyms
          Type: UNORDERED_LIST_STRING
          Provider name: Synonyms
          Description: Other names or aliases for the cell value.
      • column_data_role
        Type: STRING
        Provider name: ColumnDataRole
        Description: The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
      • comparative_order
        Type: STRUCT
        Provider name: ComparativeOrder
        Description: The order in which data is displayed for the calculated field when it’s used in a comparative context.
        • specifed_order
          Type: UNORDERED_LIST_STRING
          Provider name: SpecifedOrder
          Description: The list of columns to be used in the ordering.
        • treat_undefined_specified_values
          Type: STRING
          Provider name: TreatUndefinedSpecifiedValues
          Description: The treat of undefined specified values. Valid values for this structure are LEAST and MOST.
        • use_ordering
          Type: STRING
          Provider name: UseOrdering
          Description: The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.
      • default_formatting
        Type: STRUCT
        Provider name: DefaultFormatting
        Description: The default formatting definition.
        • display_format
          Type: STRING
          Provider name: DisplayFormat
          Description: The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.
        • display_format_options
          Type: STRUCT
          Provider name: DisplayFormatOptions
          Description: The additional options for display formatting.
          • blank_cell_format
            Type: STRING
            Provider name: BlankCellFormat
            Description: Determines the blank cell format.
          • currency_symbol
            Type: STRING
            Provider name: CurrencySymbol
            Description: The currency symbol, such as USD.
          • date_format
            Type: STRING
            Provider name: DateFormat
            Description: Determines the DateTime format.
          • decimal_separator
            Type: STRING
            Provider name: DecimalSeparator
            Description: Determines the decimal separator.
          • fraction_digits
            Type: INT32
            Provider name: FractionDigits
            Description: Determines the number of fraction digits.
          • grouping_separator
            Type: STRING
            Provider name: GroupingSeparator
            Description: Determines the grouping separator.
          • negative_format
            Type: STRUCT
            Provider name: NegativeFormat
            Description: The negative format.
            • prefix
              Type: STRING
              Provider name: Prefix
              Description: The prefix for a negative format.
            • suffix
              Type: STRING
              Provider name: Suffix
              Description: The suffix for a negative format.
          • prefix
            Type: STRING
            Provider name: Prefix
            Description: The prefix value for a display format.
          • suffix
            Type: STRING
            Provider name: Suffix
            Description: The suffix value for a display format.
          • unit_scaler
            Type: STRING
            Provider name: UnitScaler
            Description: The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
          • use_blank_cell_format
            Type: BOOLEAN
            Provider name: UseBlankCellFormat
            Description: A Boolean value that indicates whether to use blank cell format.
          • use_grouping
            Type: BOOLEAN
            Provider name: UseGrouping
            Description: A Boolean value that indicates whether to use grouping.
      • disable_indexing
        Type: BOOLEAN
        Provider name: DisableIndexing
        Description: A Boolean value that indicates if a calculated field is visible in the autocomplete.
      • expression
        Type: STRING
        Provider name: Expression
        Description: The calculated field expression.
      • is_included_in_topic
        Type: BOOLEAN
        Provider name: IsIncludedInTopic
        Description: A boolean value that indicates if a calculated field is included in the topic.
      • never_aggregate_in_filter
        Type: BOOLEAN
        Provider name: NeverAggregateInFilter
        Description: A Boolean value that indicates whether to never aggregate calculated field in filters.
      • non_additive
        Type: BOOLEAN
        Provider name: NonAdditive
        Description: The non additive for the table style target.
      • not_allowed_aggregations
        Type: UNORDERED_LIST_STRING
        Provider name: NotAllowedAggregations
        Description: The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
      • semantic_type
        Type: STRUCT
        Provider name: SemanticType
        Description: The semantic type.
        • falsey_cell_value
          Type: STRING
          Provider name: FalseyCellValue
          Description: The semantic type falsey cell value.
        • falsey_cell_value_synonyms
          Type: UNORDERED_LIST_STRING
          Provider name: FalseyCellValueSynonyms
          Description: The other names or aliases for the false cell value.
        • sub_type_name
          Type: STRING
          Provider name: SubTypeName
          Description: The semantic type sub type name.
        • truthy_cell_value
          Type: STRING
          Provider name: TruthyCellValue
          Description: The semantic type truthy cell value.
        • truthy_cell_value_synonyms
          Type: UNORDERED_LIST_STRING
          Provider name: TruthyCellValueSynonyms
          Description: The other names or aliases for the true cell value.
        • type_name
          Type: STRING
          Provider name: TypeName
          Description: The semantic type name.
        • type_parameters
          Type: MAP_STRING_STRING
          Provider name: TypeParameters
          Description: The semantic type parameters.
      • time_granularity
        Type: STRING
        Provider name: TimeGranularity
        Description: The level of time precision that is used to aggregate DateTime values.
    • columns
      Type: UNORDERED_LIST_STRUCT
      Provider name: Columns
      Description: The list of column definitions.
      • aggregation
        Type: STRING
        Provider name: Aggregation
        Description: The type of aggregation that is performed on the column data when it’s queried.
      • allowed_aggregations
        Type: UNORDERED_LIST_STRING
        Provider name: AllowedAggregations
        Description: The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
      • cell_value_synonyms
        Type: UNORDERED_LIST_STRUCT
        Provider name: CellValueSynonyms
        Description: The other names or aliases for the column cell value.
        • cell_value
          Type: STRING
          Provider name: CellValue
          Description: The cell value.
        • synonyms
          Type: UNORDERED_LIST_STRING
          Provider name: Synonyms
          Description: Other names or aliases for the cell value.
      • column_data_role
        Type: STRING
        Provider name: ColumnDataRole
        Description: The role of the column in the data. Valid values are DIMENSION and MEASURE.
      • column_description
        Type: STRING
        Provider name: ColumnDescription
        Description: A description of the column and its contents.
      • column_friendly_name
        Type: STRING
        Provider name: ColumnFriendlyName
        Description: A user-friendly name for the column.
      • column_name
        Type: STRING
        Provider name: ColumnName
        Description: The name of the column.
      • column_synonyms
        Type: UNORDERED_LIST_STRING
        Provider name: ColumnSynonyms
        Description: The other names or aliases for the column.
      • comparative_order
        Type: STRUCT
        Provider name: ComparativeOrder
        Description: The order in which data is displayed for the column when it’s used in a comparative context.
        • specifed_order
          Type: UNORDERED_LIST_STRING
          Provider name: SpecifedOrder
          Description: The list of columns to be used in the ordering.
        • treat_undefined_specified_values
          Type: STRING
          Provider name: TreatUndefinedSpecifiedValues
          Description: The treat of undefined specified values. Valid values for this structure are LEAST and MOST.
        • use_ordering
          Type: STRING
          Provider name: UseOrdering
          Description: The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.
      • default_formatting
        Type: STRUCT
        Provider name: DefaultFormatting
        Description: The default formatting used for values in the column.
        • display_format
          Type: STRING
          Provider name: DisplayFormat
          Description: The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.
        • display_format_options
          Type: STRUCT
          Provider name: DisplayFormatOptions
          Description: The additional options for display formatting.
          • blank_cell_format
            Type: STRING
            Provider name: BlankCellFormat
            Description: Determines the blank cell format.
          • currency_symbol
            Type: STRING
            Provider name: CurrencySymbol
            Description: The currency symbol, such as USD.
          • date_format
            Type: STRING
            Provider name: DateFormat
            Description: Determines the DateTime format.
          • decimal_separator
            Type: STRING
            Provider name: DecimalSeparator
            Description: Determines the decimal separator.
          • fraction_digits
            Type: INT32
            Provider name: FractionDigits
            Description: Determines the number of fraction digits.
          • grouping_separator
            Type: STRING
            Provider name: GroupingSeparator
            Description: Determines the grouping separator.
          • negative_format
            Type: STRUCT
            Provider name: NegativeFormat
            Description: The negative format.
            • prefix
              Type: STRING
              Provider name: Prefix
              Description: The prefix for a negative format.
            • suffix
              Type: STRING
              Provider name: Suffix
              Description: The suffix for a negative format.
          • prefix
            Type: STRING
            Provider name: Prefix
            Description: The prefix value for a display format.
          • suffix
            Type: STRING
            Provider name: Suffix
            Description: The suffix value for a display format.
          • unit_scaler
            Type: STRING
            Provider name: UnitScaler
            Description: The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
          • use_blank_cell_format
            Type: BOOLEAN
            Provider name: UseBlankCellFormat
            Description: A Boolean value that indicates whether to use blank cell format.
          • use_grouping
            Type: BOOLEAN
            Provider name: UseGrouping
            Description: A Boolean value that indicates whether to use grouping.
      • disable_indexing
        Type: BOOLEAN
        Provider name: DisableIndexing
        Description: A Boolean value that indicates whether the column shows in the autocomplete functionality.
      • is_included_in_topic
        Type: BOOLEAN
        Provider name: IsIncludedInTopic
        Description: A Boolean value that indicates whether the column is included in the query results.
      • never_aggregate_in_filter
        Type: BOOLEAN
        Provider name: NeverAggregateInFilter
        Description: A Boolean value that indicates whether to aggregate the column data when it’s used in a filter context.
      • non_additive
        Type: BOOLEAN
        Provider name: NonAdditive
        Description: The non additive value for the column.
      • not_allowed_aggregations
        Type: UNORDERED_LIST_STRING
        Provider name: NotAllowedAggregations
        Description: The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
      • semantic_type
        Type: STRUCT
        Provider name: SemanticType
        Description: The semantic type of data contained in the column.
        • falsey_cell_value
          Type: STRING
          Provider name: FalseyCellValue
          Description: The semantic type falsey cell value.
        • falsey_cell_value_synonyms
          Type: UNORDERED_LIST_STRING
          Provider name: FalseyCellValueSynonyms
          Description: The other names or aliases for the false cell value.
        • sub_type_name
          Type: STRING
          Provider name: SubTypeName
          Description: The semantic type sub type name.
        • truthy_cell_value
          Type: STRING
          Provider name: TruthyCellValue
          Description: The semantic type truthy cell value.
        • truthy_cell_value_synonyms
          Type: UNORDERED_LIST_STRING
          Provider name: TruthyCellValueSynonyms
          Description: The other names or aliases for the true cell value.
        • type_name
          Type: STRING
          Provider name: TypeName
          Description: The semantic type name.
        • type_parameters
          Type: MAP_STRING_STRING
          Provider name: TypeParameters
          Description: The semantic type parameters.
      • time_granularity
        Type: STRING
        Provider name: TimeGranularity
        Description: The level of time precision that is used to aggregate DateTime values.
    • data_aggregation
      Type: STRUCT
      Provider name: DataAggregation
      Description: The definition of a data aggregation.
      • dataset_row_date_granularity
        Type: STRING
        Provider name: DatasetRowDateGranularity
        Description: The level of time precision that is used to aggregate DateTime values.
      • default_date_column_name
        Type: STRING
        Provider name: DefaultDateColumnName
        Description: The column name for the default date.
    • dataset_arn
      Type: STRING
      Provider name: DatasetArn
      Description: The Amazon Resource Name (ARN) of the dataset.
    • dataset_description
      Type: STRING
      Provider name: DatasetDescription
      Description: The description of the dataset.
    • dataset_name
      Type: STRING
      Provider name: DatasetName
      Description: The name of the dataset.
    • filters
      Type: UNORDERED_LIST_STRUCT
      Provider name: Filters
      Description: The list of filter definitions.
      • category_filter
        Type: STRUCT
        Provider name: CategoryFilter
        Description: The category filter that is associated with this filter.
        • category_filter_function
          Type: STRING
          Provider name: CategoryFilterFunction
          Description: The category filter function. Valid values for this structure are EXACT and CONTAINS.
        • category_filter_type
          Type: STRING
          Provider name: CategoryFilterType
          Description: The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
        • constant
          Type: STRUCT
          Provider name: Constant
          Description: The constant used in a category filter.
          • collective_constant
            Type: STRUCT
            Provider name: CollectiveConstant
            Description: A collective constant used in a category filter. This element is used to specify a list of values for the constant.
            • value_list
              Type: UNORDERED_LIST_STRING
              Provider name: ValueList
              Description: A list of values for the collective constant.
          • constant_type
            Type: STRING
            Provider name: ConstantType
            Description: The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.
          • singular_constant
            Type: STRING
            Provider name: SingularConstant
            Description: A singular constant used in a category filter. This element is used to specify a single value for the constant.
        • inverse
          Type: BOOLEAN
          Provider name: Inverse
          Description: A Boolean value that indicates if the filter is inverse.
      • date_range_filter
        Type: STRUCT
        Provider name: DateRangeFilter
        Description: The date range filter.
        • constant
          Type: STRUCT
          Provider name: Constant
          Description: The constant used in a date range filter.
          • constant_type
            Type: STRING
            Provider name: ConstantType
            Description: The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.
          • range_constant
            Type: STRUCT
            Provider name: RangeConstant
            Description: The value of the constant that is used to specify the endpoints of a range filter.
            • maximum
              Type: STRING
              Provider name: Maximum
              Description: The maximum value for a range constant.
            • minimum
              Type: STRING
              Provider name: Minimum
              Description: The minimum value for a range constant.
        • inclusive
          Type: BOOLEAN
          Provider name: Inclusive
          Description: A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.
      • filter_class
        Type: STRING
        Provider name: FilterClass
        Description: The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.
      • filter_description
        Type: STRING
        Provider name: FilterDescription
        Description: A description of the filter used to select items for a topic.
      • filter_name
        Type: STRING
        Provider name: FilterName
        Description: The name of the filter.
      • filter_synonyms
        Type: UNORDERED_LIST_STRING
        Provider name: FilterSynonyms
        Description: The other names or aliases for the filter.
      • filter_type
        Type: STRING
        Provider name: FilterType
        Description: The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.
      • numeric_equality_filter
        Type: STRUCT
        Provider name: NumericEqualityFilter
        Description: The numeric equality filter.
        • aggregation
          Type: STRING
          Provider name: Aggregation
          Description: An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
        • constant
          Type: STRUCT
          Provider name: Constant
          Description: The constant used in a numeric equality filter.
          • constant_type
            Type: STRING
            Provider name: ConstantType
            Description: The type of the singular filter constant. Valid values for this structure are SINGULAR.
          • singular_constant
            Type: STRING
            Provider name: SingularConstant
            Description: The value of the singular filter constant.
      • numeric_range_filter
        Type: STRUCT
        Provider name: NumericRangeFilter
        Description: The numeric range filter.
        • aggregation
          Type: STRING
          Provider name: Aggregation
          Description: An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
        • constant
          Type: STRUCT
          Provider name: Constant
          Description: The constant used in a numeric range filter.
          • constant_type
            Type: STRING
            Provider name: ConstantType
            Description: The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.
          • range_constant
            Type: STRUCT
            Provider name: RangeConstant
            Description: The value of the constant that is used to specify the endpoints of a range filter.
            • maximum
              Type: STRING
              Provider name: Maximum
              Description: The maximum value for a range constant.
            • minimum
              Type: STRING
              Provider name: Minimum
              Description: The minimum value for a range constant.
        • inclusive
          Type: BOOLEAN
          Provider name: Inclusive
          Description: A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.
      • operand_field_name
        Type: STRING
        Provider name: OperandFieldName
        Description: The name of the field that the filter operates on.
      • relative_date_filter
        Type: STRUCT
        Provider name: RelativeDateFilter
        Description: The relative date filter.
        • constant
          Type: STRUCT
          Provider name: Constant
          Description: The constant used in a relative date filter.
          • constant_type
            Type: STRING
            Provider name: ConstantType
            Description: The type of the singular filter constant. Valid values for this structure are SINGULAR.
          • singular_constant
            Type: STRING
            Provider name: SingularConstant
            Description: The value of the singular filter constant.
        • relative_date_filter_function
          Type: STRING
          Provider name: RelativeDateFilterFunction
          Description: The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.
        • time_granularity
          Type: STRING
          Provider name: TimeGranularity
          Description: The level of time precision that is used to aggregate DateTime values.
    • named_entities
      Type: UNORDERED_LIST_STRUCT
      Provider name: NamedEntities
      Description: The list of named entities definitions.
      • definition
        Type: UNORDERED_LIST_STRUCT
        Provider name: Definition
        Description: The definition of a named entity.
        • field_name
          Type: STRING
          Provider name: FieldName
          Description: The name of the entity.
        • metric
          Type: STRUCT
          Provider name: Metric
          Description: The definition of a metric.
          • aggregation
            Type: STRING
            Provider name: Aggregation
            Description: The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.
          • aggregation_function_parameters
            Type: MAP_STRING_STRING
            Provider name: AggregationFunctionParameters
            Description: The additional parameters for an aggregation function.
        • property_name
          Type: STRING
          Provider name: PropertyName
          Description: The property name to be used for the named entity.
        • property_role
          Type: STRING
          Provider name: PropertyRole
          Description: The property role. Valid values for this structure are PRIMARY and ID.
        • property_usage
          Type: STRING
          Provider name: PropertyUsage
          Description: The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
      • entity_description
        Type: STRING
        Provider name: EntityDescription
        Description: The description of the named entity.
      • entity_name
        Type: STRING
        Provider name: EntityName
        Description: The name of the named entity.
      • entity_synonyms
        Type: UNORDERED_LIST_STRING
        Provider name: EntitySynonyms
        Description: The other names or aliases for the named entity.
      • semantic_entity_type
        Type: STRUCT
        Provider name: SemanticEntityType
        Description: The type of named entity that a topic represents.
        • sub_type_name
          Type: STRING
          Provider name: SubTypeName
          Description: The semantic entity sub type name.
        • type_name
          Type: STRING
          Provider name: TypeName
          Description: The semantic entity type name.
        • type_parameters
          Type: MAP_STRING_STRING
          Provider name: TypeParameters
          Description: The semantic entity type parameters.
  • description
    Type: STRING
    Provider name: Description
    Description: The description of the topic.
  • name
    Type: STRING
    Provider name: Name
    Description: The name of the topic.
  • user_experience_version
    Type: STRING
    Provider name: UserExperienceVersion
    Description: The user experience version of a topic.

topic_id

Type: STRING
Provider name: TopicId
Description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.