AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
aws-native.quicksight.getTopic
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
Definition of the AWS::QuickSight::Topic Resource Type.
Using getTopic
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>
def get_topic(aws_account_id: Optional[str] = None,
topic_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(aws_account_id: Optional[pulumi.Input[str]] = None,
topic_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]
func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput
> Note: This function is named LookupTopic
in the Go SDK.
public static class GetTopic
{
public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:quicksight:getTopic
arguments:
# arguments dictionary
The following arguments are supported:
- Aws
Account stringId - Topic
Id string
- Aws
Account stringId - Topic
Id string
- aws
Account StringId - topic
Id String
- aws
Account stringId - topic
Id string
- aws_
account_ strid - topic_
id str
- aws
Account StringId - topic
Id String
getTopic Result
The following output properties are available:
Supporting Types
TopicAuthorSpecifiedAggregation
TopicCalculatedField
- Calculated
Field stringName - Expression string
- Aggregation
Pulumi.
Aws Native. Quick Sight. Topic Default Aggregation - Allowed
Aggregations List<Pulumi.Aws Native. Quick Sight. Topic Author Specified Aggregation> - Calculated
Field stringDescription - Calculated
Field List<string>Synonyms - Cell
Value List<Pulumi.Synonyms Aws Native. Quick Sight. Inputs. Topic Cell Value Synonym> - Column
Data Pulumi.Role Aws Native. Quick Sight. Topic Column Data Role - Comparative
Order Pulumi.Aws Native. Quick Sight. Inputs. Topic Comparative Order - Default
Formatting Pulumi.Aws Native. Quick Sight. Inputs. Topic Default Formatting - Disable
Indexing bool - Is
Included boolIn Topic - Never
Aggregate boolIn Filter - Non
Additive bool - Not
Allowed List<Pulumi.Aggregations Aws Native. Quick Sight. Topic Author Specified Aggregation> - Semantic
Type Pulumi.Aws Native. Quick Sight. Inputs. Topic Semantic Type - Time
Granularity Pulumi.Aws Native. Quick Sight. Topic Time Granularity
- Calculated
Field stringName - Expression string
- Aggregation
Topic
Default Aggregation - Allowed
Aggregations []TopicAuthor Specified Aggregation - Calculated
Field stringDescription - Calculated
Field []stringSynonyms - Cell
Value []TopicSynonyms Cell Value Synonym - Column
Data TopicRole Column Data Role - Comparative
Order TopicComparative Order - Default
Formatting TopicDefault Formatting - Disable
Indexing bool - Is
Included boolIn Topic - Never
Aggregate boolIn Filter - Non
Additive bool - Not
Allowed []TopicAggregations Author Specified Aggregation - Semantic
Type TopicSemantic Type - Time
Granularity TopicTime Granularity
- calculated
Field StringName - expression String
- aggregation
Topic
Default Aggregation - allowed
Aggregations List<TopicAuthor Specified Aggregation> - calculated
Field StringDescription - calculated
Field List<String>Synonyms - cell
Value List<TopicSynonyms Cell Value Synonym> - column
Data TopicRole Column Data Role - comparative
Order TopicComparative Order - default
Formatting TopicDefault Formatting - disable
Indexing Boolean - is
Included BooleanIn Topic - never
Aggregate BooleanIn Filter - non
Additive Boolean - not
Allowed List<TopicAggregations Author Specified Aggregation> - semantic
Type TopicSemantic Type - time
Granularity TopicTime Granularity
- calculated
Field stringName - expression string
- aggregation
Topic
Default Aggregation - allowed
Aggregations TopicAuthor Specified Aggregation[] - calculated
Field stringDescription - calculated
Field string[]Synonyms - cell
Value TopicSynonyms Cell Value Synonym[] - column
Data TopicRole Column Data Role - comparative
Order TopicComparative Order - default
Formatting TopicDefault Formatting - disable
Indexing boolean - is
Included booleanIn Topic - never
Aggregate booleanIn Filter - non
Additive boolean - not
Allowed TopicAggregations Author Specified Aggregation[] - semantic
Type TopicSemantic Type - time
Granularity TopicTime Granularity
- calculated_
field_ strname - expression str
- aggregation
Topic
Default Aggregation - allowed_
aggregations Sequence[TopicAuthor Specified Aggregation] - calculated_
field_ strdescription - calculated_
field_ Sequence[str]synonyms - cell_
value_ Sequence[Topicsynonyms Cell Value Synonym] - column_
data_ Topicrole Column Data Role - comparative_
order TopicComparative Order - default_
formatting TopicDefault Formatting - disable_
indexing bool - is_
included_ boolin_ topic - never_
aggregate_ boolin_ filter - non_
additive bool - not_
allowed_ Sequence[Topicaggregations Author Specified Aggregation] - semantic_
type TopicSemantic Type - time_
granularity TopicTime Granularity
- calculated
Field StringName - expression String
- aggregation "SUM" | "MAX" | "MIN" | "COUNT" | "DISTINCT_COUNT" | "AVERAGE" | "MEDIAN" | "STDEV" | "STDEVP" | "VAR" | "VARP"
- allowed
Aggregations List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE"> - calculated
Field StringDescription - calculated
Field List<String>Synonyms - cell
Value List<Property Map>Synonyms - column
Data "DIMENSION" | "MEASURE"Role - comparative
Order Property Map - default
Formatting Property Map - disable
Indexing Boolean - is
Included BooleanIn Topic - never
Aggregate BooleanIn Filter - non
Additive Boolean - not
Allowed List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE">Aggregations - semantic
Type Property Map - time
Granularity "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"
TopicCategoryFilter
TopicCategoryFilterConstant
TopicCategoryFilterFunction
TopicCategoryFilterType
TopicCellValueSynonym
- cell_
value str - synonyms Sequence[str]
TopicCollectiveConstant
- Value
List List<string>
- Value
List []string
- value
List List<String>
- value
List string[]
- value_
list Sequence[str]
- value
List List<String>
TopicColumn
- Column
Name string - Aggregation
Pulumi.
Aws Native. Quick Sight. Topic Default Aggregation - Allowed
Aggregations List<Pulumi.Aws Native. Quick Sight. Topic Author Specified Aggregation> - Cell
Value List<Pulumi.Synonyms Aws Native. Quick Sight. Inputs. Topic Cell Value Synonym> - Column
Data Pulumi.Role Aws Native. Quick Sight. Topic Column Data Role - Column
Description string - Column
Friendly stringName - Column
Synonyms List<string> - Comparative
Order Pulumi.Aws Native. Quick Sight. Inputs. Topic Comparative Order - Default
Formatting Pulumi.Aws Native. Quick Sight. Inputs. Topic Default Formatting - Disable
Indexing bool - Is
Included boolIn Topic - Never
Aggregate boolIn Filter - Non
Additive bool - Not
Allowed List<Pulumi.Aggregations Aws Native. Quick Sight. Topic Author Specified Aggregation> - Semantic
Type Pulumi.Aws Native. Quick Sight. Inputs. Topic Semantic Type - Time
Granularity Pulumi.Aws Native. Quick Sight. Topic Time Granularity
- Column
Name string - Aggregation
Topic
Default Aggregation - Allowed
Aggregations []TopicAuthor Specified Aggregation - Cell
Value []TopicSynonyms Cell Value Synonym - Column
Data TopicRole Column Data Role - Column
Description string - Column
Friendly stringName - Column
Synonyms []string - Comparative
Order TopicComparative Order - Default
Formatting TopicDefault Formatting - Disable
Indexing bool - Is
Included boolIn Topic - Never
Aggregate boolIn Filter - Non
Additive bool - Not
Allowed []TopicAggregations Author Specified Aggregation - Semantic
Type TopicSemantic Type - Time
Granularity TopicTime Granularity
- column
Name String - aggregation
Topic
Default Aggregation - allowed
Aggregations List<TopicAuthor Specified Aggregation> - cell
Value List<TopicSynonyms Cell Value Synonym> - column
Data TopicRole Column Data Role - column
Description String - column
Friendly StringName - column
Synonyms List<String> - comparative
Order TopicComparative Order - default
Formatting TopicDefault Formatting - disable
Indexing Boolean - is
Included BooleanIn Topic - never
Aggregate BooleanIn Filter - non
Additive Boolean - not
Allowed List<TopicAggregations Author Specified Aggregation> - semantic
Type TopicSemantic Type - time
Granularity TopicTime Granularity
- column
Name string - aggregation
Topic
Default Aggregation - allowed
Aggregations TopicAuthor Specified Aggregation[] - cell
Value TopicSynonyms Cell Value Synonym[] - column
Data TopicRole Column Data Role - column
Description string - column
Friendly stringName - column
Synonyms string[] - comparative
Order TopicComparative Order - default
Formatting TopicDefault Formatting - disable
Indexing boolean - is
Included booleanIn Topic - never
Aggregate booleanIn Filter - non
Additive boolean - not
Allowed TopicAggregations Author Specified Aggregation[] - semantic
Type TopicSemantic Type - time
Granularity TopicTime Granularity
- column_
name str - aggregation
Topic
Default Aggregation - allowed_
aggregations Sequence[TopicAuthor Specified Aggregation] - cell_
value_ Sequence[Topicsynonyms Cell Value Synonym] - column_
data_ Topicrole Column Data Role - column_
description str - column_
friendly_ strname - column_
synonyms Sequence[str] - comparative_
order TopicComparative Order - default_
formatting TopicDefault Formatting - disable_
indexing bool - is_
included_ boolin_ topic - never_
aggregate_ boolin_ filter - non_
additive bool - not_
allowed_ Sequence[Topicaggregations Author Specified Aggregation] - semantic_
type TopicSemantic Type - time_
granularity TopicTime Granularity
- column
Name String - aggregation "SUM" | "MAX" | "MIN" | "COUNT" | "DISTINCT_COUNT" | "AVERAGE" | "MEDIAN" | "STDEV" | "STDEVP" | "VAR" | "VARP"
- allowed
Aggregations List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE"> - cell
Value List<Property Map>Synonyms - column
Data "DIMENSION" | "MEASURE"Role - column
Description String - column
Friendly StringName - column
Synonyms List<String> - comparative
Order Property Map - default
Formatting Property Map - disable
Indexing Boolean - is
Included BooleanIn Topic - never
Aggregate BooleanIn Filter - non
Additive Boolean - not
Allowed List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE">Aggregations - semantic
Type Property Map - time
Granularity "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"
TopicColumnDataRole
TopicColumnOrderingType
TopicComparativeOrder
TopicConstantType
TopicDataAggregation
TopicDatasetMetadata
- Dataset
Arn string - Calculated
Fields List<Pulumi.Aws Native. Quick Sight. Inputs. Topic Calculated Field> - Columns
List<Pulumi.
Aws Native. Quick Sight. Inputs. Topic Column> - Data
Aggregation Pulumi.Aws Native. Quick Sight. Inputs. Topic Data Aggregation - Dataset
Description string - Dataset
Name string - Filters
List<Pulumi.
Aws Native. Quick Sight. Inputs. Topic Filter> - Named
Entities List<Pulumi.Aws Native. Quick Sight. Inputs. Topic Named Entity>
TopicDateRangeFilter
- constant Property Map
- inclusive Boolean
TopicDefaultAggregation
TopicDefaultFormatting
TopicDisplayFormat
TopicDisplayFormatOptions
- Blank
Cell stringFormat - Currency
Symbol string - Date
Format string - Decimal
Separator Pulumi.Aws Native. Quick Sight. Topic Numeric Separator Symbol - Fraction
Digits double - Grouping
Separator string - Negative
Format Pulumi.Aws Native. Quick Sight. Inputs. Topic Negative Format - Prefix string
- Suffix string
- Unit
Scaler Pulumi.Aws Native. Quick Sight. Topic Number Scale - Use
Blank boolCell Format - Use
Grouping bool
- Blank
Cell stringFormat - Currency
Symbol string - Date
Format string - Decimal
Separator TopicNumeric Separator Symbol - Fraction
Digits float64 - Grouping
Separator string - Negative
Format TopicNegative Format - Prefix string
- Suffix string
- Unit
Scaler TopicNumber Scale - Use
Blank boolCell Format - Use
Grouping bool
- blank
Cell StringFormat - currency
Symbol String - date
Format String - decimal
Separator TopicNumeric Separator Symbol - fraction
Digits Double - grouping
Separator String - negative
Format TopicNegative Format - prefix String
- suffix String
- unit
Scaler TopicNumber Scale - use
Blank BooleanCell Format - use
Grouping Boolean
- blank
Cell stringFormat - currency
Symbol string - date
Format string - decimal
Separator TopicNumeric Separator Symbol - fraction
Digits number - grouping
Separator string - negative
Format TopicNegative Format - prefix string
- suffix string
- unit
Scaler TopicNumber Scale - use
Blank booleanCell Format - use
Grouping boolean
- blank
Cell StringFormat - currency
Symbol String - date
Format String - decimal
Separator "COMMA" | "DOT" - fraction
Digits Number - grouping
Separator String - negative
Format Property Map - prefix String
- suffix String
- unit
Scaler "NONE" | "AUTO" | "THOUSANDS" | "MILLIONS" | "BILLIONS" | "TRILLIONS" - use
Blank BooleanCell Format - use
Grouping Boolean
TopicFilter
- Filter
Name string - Operand
Field stringName - Category
Filter Pulumi.Aws Native. Quick Sight. Inputs. Topic Category Filter - Date
Range Pulumi.Filter Aws Native. Quick Sight. Inputs. Topic Date Range Filter - Filter
Class Pulumi.Aws Native. Quick Sight. Topic Filter Class - Filter
Description string - Filter
Synonyms List<string> - Filter
Type Pulumi.Aws Native. Quick Sight. Topic Named Filter Type - Numeric
Equality Pulumi.Filter Aws Native. Quick Sight. Inputs. Topic Numeric Equality Filter - Numeric
Range Pulumi.Filter Aws Native. Quick Sight. Inputs. Topic Numeric Range Filter - Relative
Date Pulumi.Filter Aws Native. Quick Sight. Inputs. Topic Relative Date Filter
- Filter
Name string - Operand
Field stringName - Category
Filter TopicCategory Filter - Date
Range TopicFilter Date Range Filter - Filter
Class TopicFilter Class - Filter
Description string - Filter
Synonyms []string - Filter
Type TopicNamed Filter Type - Numeric
Equality TopicFilter Numeric Equality Filter - Numeric
Range TopicFilter Numeric Range Filter - Relative
Date TopicFilter Relative Date Filter
- filter
Name String - operand
Field StringName - category
Filter TopicCategory Filter - date
Range TopicFilter Date Range Filter - filter
Class TopicFilter Class - filter
Description String - filter
Synonyms List<String> - filter
Type TopicNamed Filter Type - numeric
Equality TopicFilter Numeric Equality Filter - numeric
Range TopicFilter Numeric Range Filter - relative
Date TopicFilter Relative Date Filter
- filter
Name string - operand
Field stringName - category
Filter TopicCategory Filter - date
Range TopicFilter Date Range Filter - filter
Class TopicFilter Class - filter
Description string - filter
Synonyms string[] - filter
Type TopicNamed Filter Type - numeric
Equality TopicFilter Numeric Equality Filter - numeric
Range TopicFilter Numeric Range Filter - relative
Date TopicFilter Relative Date Filter
- filter_
name str - operand_
field_ strname - category_
filter TopicCategory Filter - date_
range_ Topicfilter Date Range Filter - filter_
class TopicFilter Class - filter_
description str - filter_
synonyms Sequence[str] - filter_
type TopicNamed Filter Type - numeric_
equality_ Topicfilter Numeric Equality Filter - numeric_
range_ Topicfilter Numeric Range Filter - relative_
date_ Topicfilter Relative Date Filter
- filter
Name String - operand
Field StringName - category
Filter Property Map - date
Range Property MapFilter - filter
Class "ENFORCED_VALUE_FILTER" | "CONDITIONAL_VALUE_FILTER" | "NAMED_VALUE_FILTER" - filter
Description String - filter
Synonyms List<String> - filter
Type "CATEGORY_FILTER" | "NUMERIC_EQUALITY_FILTER" | "NUMERIC_RANGE_FILTER" | "DATE_RANGE_FILTER" | "RELATIVE_DATE_FILTER" - numeric
Equality Property MapFilter - numeric
Range Property MapFilter - relative
Date Property MapFilter
TopicFilterClass
TopicNamedEntity
- entity
Name String - definition List<Property Map>
- entity
Description String - entity
Synonyms List<String> - semantic
Entity Property MapType
TopicNamedEntityAggType
TopicNamedEntityDefinition
TopicNamedEntityDefinitionMetric
- Aggregation
Pulumi.
Aws Native. Quick Sight. Topic Named Entity Agg Type - Aggregation
Function Dictionary<string, string>Parameters
- Aggregation
Topic
Named Entity Agg Type - Aggregation
Function map[string]stringParameters
- aggregation
Topic
Named Entity Agg Type - aggregation
Function Map<String,String>Parameters
- aggregation
Topic
Named Entity Agg Type - aggregation
Function {[key: string]: string}Parameters
- aggregation
Topic
Named Entity Agg Type - aggregation_
function_ Mapping[str, str]parameters
TopicNamedFilterAggType
TopicNamedFilterType
TopicNegativeFormat
TopicNumberScale
TopicNumericEqualityFilter
TopicNumericRangeFilter
TopicNumericSeparatorSymbol
TopicPropertyRole
TopicPropertyUsage
TopicRangeConstant
TopicRangeFilterConstant
TopicRelativeDateFilter
TopicRelativeDateFilterFunction
TopicSemanticEntityType
- Sub
Type stringName - Type
Name string - Type
Parameters Dictionary<string, string>
- Sub
Type stringName - Type
Name string - Type
Parameters map[string]string
- sub
Type StringName - type
Name String - type
Parameters Map<String,String>
- sub
Type stringName - type
Name string - type
Parameters {[key: string]: string}
- sub_
type_ strname - type_
name str - type_
parameters Mapping[str, str]
- sub
Type StringName - type
Name String - type
Parameters Map<String>
TopicSemanticType
- Falsey
Cell stringValue - Falsey
Cell List<string>Value Synonyms - Sub
Type stringName - Truthy
Cell stringValue - Truthy
Cell List<string>Value Synonyms - Type
Name string - Type
Parameters Dictionary<string, string>
- Falsey
Cell stringValue - Falsey
Cell []stringValue Synonyms - Sub
Type stringName - Truthy
Cell stringValue - Truthy
Cell []stringValue Synonyms - Type
Name string - Type
Parameters map[string]string
- falsey
Cell StringValue - falsey
Cell List<String>Value Synonyms - sub
Type StringName - truthy
Cell StringValue - truthy
Cell List<String>Value Synonyms - type
Name String - type
Parameters Map<String,String>
- falsey
Cell stringValue - falsey
Cell string[]Value Synonyms - sub
Type stringName - truthy
Cell stringValue - truthy
Cell string[]Value Synonyms - type
Name string - type
Parameters {[key: string]: string}
- falsey_
cell_ strvalue - falsey_
cell_ Sequence[str]value_ synonyms - sub_
type_ strname - truthy_
cell_ strvalue - truthy_
cell_ Sequence[str]value_ synonyms - type_
name str - type_
parameters Mapping[str, str]
- falsey
Cell StringValue - falsey
Cell List<String>Value Synonyms - sub
Type StringName - truthy
Cell StringValue - truthy
Cell List<String>Value Synonyms - type
Name String - type
Parameters Map<String>
TopicSingularFilterConstant
TopicTimeGranularity
TopicUndefinedSpecifiedValueType
TopicUserExperienceVersion
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi