1. Packages
  2. AWS Native
  3. API Docs
  4. quicksight
  5. getTopic

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 logo

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:

    AwsAccountId string
    TopicId string
    AwsAccountId string
    TopicId string
    awsAccountId String
    topicId String
    awsAccountId string
    topicId string
    awsAccountId String
    topicId String

    getTopic Result

    The following output properties are available:

    Supporting Types

    TopicAuthorSpecifiedAggregation

    TopicCalculatedField

    CalculatedFieldName string
    Expression string
    Aggregation Pulumi.AwsNative.QuickSight.TopicDefaultAggregation
    AllowedAggregations List<Pulumi.AwsNative.QuickSight.TopicAuthorSpecifiedAggregation>
    CalculatedFieldDescription string
    CalculatedFieldSynonyms List<string>
    CellValueSynonyms List<Pulumi.AwsNative.QuickSight.Inputs.TopicCellValueSynonym>
    ColumnDataRole Pulumi.AwsNative.QuickSight.TopicColumnDataRole
    ComparativeOrder Pulumi.AwsNative.QuickSight.Inputs.TopicComparativeOrder
    DefaultFormatting Pulumi.AwsNative.QuickSight.Inputs.TopicDefaultFormatting
    DisableIndexing bool
    IsIncludedInTopic bool
    NeverAggregateInFilter bool
    NonAdditive bool
    NotAllowedAggregations List<Pulumi.AwsNative.QuickSight.TopicAuthorSpecifiedAggregation>
    SemanticType Pulumi.AwsNative.QuickSight.Inputs.TopicSemanticType
    TimeGranularity Pulumi.AwsNative.QuickSight.TopicTimeGranularity
    calculatedFieldName String
    expression String
    aggregation "SUM" | "MAX" | "MIN" | "COUNT" | "DISTINCT_COUNT" | "AVERAGE" | "MEDIAN" | "STDEV" | "STDEVP" | "VAR" | "VARP"
    allowedAggregations List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE">
    calculatedFieldDescription String
    calculatedFieldSynonyms List<String>
    cellValueSynonyms List<Property Map>
    columnDataRole "DIMENSION" | "MEASURE"
    comparativeOrder Property Map
    defaultFormatting Property Map
    disableIndexing Boolean
    isIncludedInTopic Boolean
    neverAggregateInFilter Boolean
    nonAdditive Boolean
    notAllowedAggregations List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE">
    semanticType Property Map
    timeGranularity "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"

    TopicCategoryFilter

    TopicCategoryFilterConstant

    TopicCategoryFilterFunction

    TopicCategoryFilterType

    TopicCellValueSynonym

    CellValue string
    Synonyms List<string>
    CellValue string
    Synonyms []string
    cellValue String
    synonyms List<String>
    cellValue string
    synonyms string[]
    cell_value str
    synonyms Sequence[str]
    cellValue String
    synonyms List<String>

    TopicCollectiveConstant

    ValueList List<string>
    ValueList []string
    valueList List<String>
    valueList string[]
    value_list Sequence[str]
    valueList List<String>

    TopicColumn

    ColumnName string
    Aggregation Pulumi.AwsNative.QuickSight.TopicDefaultAggregation
    AllowedAggregations List<Pulumi.AwsNative.QuickSight.TopicAuthorSpecifiedAggregation>
    CellValueSynonyms List<Pulumi.AwsNative.QuickSight.Inputs.TopicCellValueSynonym>
    ColumnDataRole Pulumi.AwsNative.QuickSight.TopicColumnDataRole
    ColumnDescription string
    ColumnFriendlyName string
    ColumnSynonyms List<string>
    ComparativeOrder Pulumi.AwsNative.QuickSight.Inputs.TopicComparativeOrder
    DefaultFormatting Pulumi.AwsNative.QuickSight.Inputs.TopicDefaultFormatting
    DisableIndexing bool
    IsIncludedInTopic bool
    NeverAggregateInFilter bool
    NonAdditive bool
    NotAllowedAggregations List<Pulumi.AwsNative.QuickSight.TopicAuthorSpecifiedAggregation>
    SemanticType Pulumi.AwsNative.QuickSight.Inputs.TopicSemanticType
    TimeGranularity Pulumi.AwsNative.QuickSight.TopicTimeGranularity
    columnName String
    aggregation "SUM" | "MAX" | "MIN" | "COUNT" | "DISTINCT_COUNT" | "AVERAGE" | "MEDIAN" | "STDEV" | "STDEVP" | "VAR" | "VARP"
    allowedAggregations List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE">
    cellValueSynonyms List<Property Map>
    columnDataRole "DIMENSION" | "MEASURE"
    columnDescription String
    columnFriendlyName String
    columnSynonyms List<String>
    comparativeOrder Property Map
    defaultFormatting Property Map
    disableIndexing Boolean
    isIncludedInTopic Boolean
    neverAggregateInFilter Boolean
    nonAdditive Boolean
    notAllowedAggregations List<"COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX" | "MEDIAN" | "SUM" | "AVERAGE" | "STDEV" | "STDEVP" | "VAR" | "VARP" | "PERCENTILE">
    semanticType Property Map
    timeGranularity "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"

    TopicColumnDataRole

    TopicColumnOrderingType

    TopicComparativeOrder

    TopicConstantType

    TopicDataAggregation

    TopicDatasetMetadata

    TopicDateRangeFilter

    TopicDefaultAggregation

    TopicDefaultFormatting

    TopicDisplayFormat

    TopicDisplayFormatOptions

    TopicFilter

    TopicFilterClass

    TopicNamedEntity

    TopicNamedEntityAggType

    TopicNamedEntityDefinition

    TopicNamedEntityDefinitionMetric

    TopicNamedFilterAggType

    TopicNamedFilterType

    TopicNegativeFormat

    Prefix string
    Suffix string
    Prefix string
    Suffix string
    prefix String
    suffix String
    prefix string
    suffix string
    prefix str
    suffix str
    prefix String
    suffix String

    TopicNumberScale

    TopicNumericEqualityFilter

    TopicNumericRangeFilter

    TopicNumericSeparatorSymbol

    TopicPropertyRole

    TopicPropertyUsage

    TopicRangeConstant

    Maximum string
    Minimum string
    Maximum string
    Minimum string
    maximum String
    minimum String
    maximum string
    minimum string
    maximum String
    minimum String

    TopicRangeFilterConstant

    TopicRelativeDateFilter

    TopicRelativeDateFilterFunction

    TopicSemanticEntityType

    SubTypeName string
    TypeName string
    TypeParameters Dictionary<string, string>
    SubTypeName string
    TypeName string
    TypeParameters map[string]string
    subTypeName String
    typeName String
    typeParameters Map<String,String>
    subTypeName string
    typeName string
    typeParameters {[key: string]: string}
    sub_type_name str
    type_name str
    type_parameters Mapping[str, str]
    subTypeName String
    typeName String
    typeParameters Map<String>

    TopicSemanticType

    FalseyCellValue string
    FalseyCellValueSynonyms List<string>
    SubTypeName string
    TruthyCellValue string
    TruthyCellValueSynonyms List<string>
    TypeName string
    TypeParameters Dictionary<string, string>
    falseyCellValue String
    falseyCellValueSynonyms List<String>
    subTypeName String
    truthyCellValue String
    truthyCellValueSynonyms List<String>
    typeName String
    typeParameters Map<String,String>

    TopicSingularFilterConstant

    TopicTimeGranularity

    TopicUndefinedSpecifiedValueType

    TopicUserExperienceVersion

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi