import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateTopicRequest, CreateTopicResponse } from "../models/models_3"; import type { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateTopicCommand}. */ export interface CreateTopicCommandInput extends CreateTopicRequest { } /** * @public * * The output of {@link CreateTopicCommand}. */ export interface CreateTopicCommandOutput extends CreateTopicResponse, __MetadataBearer { } declare const CreateTopicCommand_base: { new (input: CreateTopicCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateTopicCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a new Q topic.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { QuickSightClient, CreateTopicCommand } from "@aws-sdk/client-quicksight"; // ES Modules import * // const { QuickSightClient, CreateTopicCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight"; * const config = {}; // type is QuickSightClientConfig * const client = new QuickSightClient(config); * const input = { // CreateTopicRequest * AwsAccountId: "STRING_VALUE", // required * TopicId: "STRING_VALUE", // required * Topic: { // TopicDetails * Name: "STRING_VALUE", * Description: "STRING_VALUE", * UserExperienceVersion: "LEGACY" || "NEW_READER_EXPERIENCE", * DataSets: [ // Datasets * { // DatasetMetadata * DatasetArn: "STRING_VALUE", // required * DatasetName: "STRING_VALUE", * DatasetDescription: "STRING_VALUE", * DataAggregation: { // DataAggregation * DatasetRowDateGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR", * DefaultDateColumnName: "STRING_VALUE", * }, * Filters: [ // TopicFilters * { // TopicFilter * FilterDescription: "STRING_VALUE", * FilterClass: "ENFORCED_VALUE_FILTER" || "CONDITIONAL_VALUE_FILTER" || "NAMED_VALUE_FILTER", * FilterName: "STRING_VALUE", // required * FilterSynonyms: [ // Synonyms * "STRING_VALUE", * ], * OperandFieldName: "STRING_VALUE", // required * FilterType: "CATEGORY_FILTER" || "NUMERIC_EQUALITY_FILTER" || "NUMERIC_RANGE_FILTER" || "DATE_RANGE_FILTER" || "RELATIVE_DATE_FILTER" || "NULL_FILTER", * CategoryFilter: { // TopicCategoryFilter * CategoryFilterFunction: "EXACT" || "CONTAINS", * CategoryFilterType: "CUSTOM_FILTER" || "CUSTOM_FILTER_LIST" || "FILTER_LIST", * Constant: { // TopicCategoryFilterConstant * ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE", * SingularConstant: "STRING_VALUE", * CollectiveConstant: { // CollectiveConstant * ValueList: [ // StringList * "STRING_VALUE", * ], * }, * }, * Inverse: true || false, * }, * NumericEqualityFilter: { // TopicNumericEqualityFilter * Constant: { // TopicSingularFilterConstant * ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE", * SingularConstant: "STRING_VALUE", * }, * Aggregation: "NO_AGGREGATION" || "SUM" || "AVERAGE" || "COUNT" || "DISTINCT_COUNT" || "MAX" || "MEDIAN" || "MIN" || "STDEV" || "STDEVP" || "VAR" || "VARP", * }, * NumericRangeFilter: { // TopicNumericRangeFilter * Inclusive: true || false, * Constant: { // TopicRangeFilterConstant * ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE", * RangeConstant: { // RangeConstant * Minimum: "STRING_VALUE", * Maximum: "STRING_VALUE", * }, * }, * Aggregation: "NO_AGGREGATION" || "SUM" || "AVERAGE" || "COUNT" || "DISTINCT_COUNT" || "MAX" || "MEDIAN" || "MIN" || "STDEV" || "STDEVP" || "VAR" || "VARP", * }, * DateRangeFilter: { // TopicDateRangeFilter * Inclusive: true || false, * Constant: { * ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE", * RangeConstant: { * Minimum: "STRING_VALUE", * Maximum: "STRING_VALUE", * }, * }, * }, * RelativeDateFilter: { // TopicRelativeDateFilter * TimeGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR", * RelativeDateFilterFunction: "PREVIOUS" || "THIS" || "LAST" || "NEXT" || "NOW", * Constant: { * ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE", * SingularConstant: "STRING_VALUE", * }, * }, * NullFilter: { // TopicNullFilter * NullFilterType: "ALL_VALUES" || "NON_NULLS_ONLY" || "NULLS_ONLY", * Constant: { * ConstantType: "SINGULAR" || "RANGE" || "COLLECTIVE", * SingularConstant: "STRING_VALUE", * }, * Inverse: true || false, * }, * }, * ], * Columns: [ // TopicColumns * { // TopicColumn * ColumnName: "STRING_VALUE", // required * ColumnFriendlyName: "STRING_VALUE", * ColumnDescription: "STRING_VALUE", * ColumnSynonyms: [ * "STRING_VALUE", * ], * ColumnDataRole: "DIMENSION" || "MEASURE", * Aggregation: "SUM" || "MAX" || "MIN" || "COUNT" || "DISTINCT_COUNT" || "AVERAGE" || "MEDIAN" || "STDEV" || "STDEVP" || "VAR" || "VARP", * IsIncludedInTopic: true || false, * DisableIndexing: true || false, * ComparativeOrder: { // ComparativeOrder * UseOrdering: "GREATER_IS_BETTER" || "LESSER_IS_BETTER" || "SPECIFIED", * SpecifedOrder: [ * "STRING_VALUE", * ], * TreatUndefinedSpecifiedValues: "LEAST" || "MOST", * }, * SemanticType: { // SemanticType * TypeName: "STRING_VALUE", * SubTypeName: "STRING_VALUE", * TypeParameters: { // TypeParameters * "": "STRING_VALUE", * }, * TruthyCellValue: "STRING_VALUE", * TruthyCellValueSynonyms: [ // SensitiveStringList * "STRING_VALUE", * ], * FalseyCellValue: "STRING_VALUE", * FalseyCellValueSynonyms: [ * "STRING_VALUE", * ], * }, * TimeGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR", * AllowedAggregations: [ // AuthorSpecifiedAggregations * "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE", * ], * NotAllowedAggregations: [ * "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE", * ], * DefaultFormatting: { // DefaultFormatting * DisplayFormat: "AUTO" || "PERCENT" || "CURRENCY" || "NUMBER" || "DATE" || "STRING", * DisplayFormatOptions: { // DisplayFormatOptions * UseBlankCellFormat: true || false, * BlankCellFormat: "STRING_VALUE", * DateFormat: "STRING_VALUE", * DecimalSeparator: "COMMA" || "DOT", * GroupingSeparator: "STRING_VALUE", * UseGrouping: true || false, * FractionDigits: Number("int"), * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * UnitScaler: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeFormat: { // NegativeFormat * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * }, * CurrencySymbol: "STRING_VALUE", * }, * }, * NeverAggregateInFilter: true || false, * CellValueSynonyms: [ // CellValueSynonyms * { // CellValueSynonym * CellValue: "STRING_VALUE", * Synonyms: "", * }, * ], * NonAdditive: true || false, * }, * ], * CalculatedFields: [ // TopicCalculatedFields * { // TopicCalculatedField * CalculatedFieldName: "STRING_VALUE", // required * CalculatedFieldDescription: "STRING_VALUE", * Expression: "STRING_VALUE", // required * CalculatedFieldSynonyms: [ * "STRING_VALUE", * ], * IsIncludedInTopic: true || false, * DisableIndexing: true || false, * ColumnDataRole: "DIMENSION" || "MEASURE", * TimeGranularity: "SECOND" || "MINUTE" || "HOUR" || "DAY" || "WEEK" || "MONTH" || "QUARTER" || "YEAR", * DefaultFormatting: { * DisplayFormat: "AUTO" || "PERCENT" || "CURRENCY" || "NUMBER" || "DATE" || "STRING", * DisplayFormatOptions: { * UseBlankCellFormat: true || false, * BlankCellFormat: "STRING_VALUE", * DateFormat: "STRING_VALUE", * DecimalSeparator: "COMMA" || "DOT", * GroupingSeparator: "STRING_VALUE", * UseGrouping: true || false, * FractionDigits: Number("int"), * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * UnitScaler: "NONE" || "AUTO" || "THOUSANDS" || "MILLIONS" || "BILLIONS" || "TRILLIONS" || "LAKHS" || "CRORES", * NegativeFormat: { * Prefix: "STRING_VALUE", * Suffix: "STRING_VALUE", * }, * CurrencySymbol: "STRING_VALUE", * }, * }, * Aggregation: "SUM" || "MAX" || "MIN" || "COUNT" || "DISTINCT_COUNT" || "AVERAGE" || "MEDIAN" || "STDEV" || "STDEVP" || "VAR" || "VARP", * ComparativeOrder: { * UseOrdering: "GREATER_IS_BETTER" || "LESSER_IS_BETTER" || "SPECIFIED", * SpecifedOrder: "", * TreatUndefinedSpecifiedValues: "LEAST" || "MOST", * }, * SemanticType: { * TypeName: "STRING_VALUE", * SubTypeName: "STRING_VALUE", * TypeParameters: { * "": "STRING_VALUE", * }, * TruthyCellValue: "STRING_VALUE", * TruthyCellValueSynonyms: [ * "STRING_VALUE", * ], * FalseyCellValue: "STRING_VALUE", * FalseyCellValueSynonyms: [ * "STRING_VALUE", * ], * }, * AllowedAggregations: [ * "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE", * ], * NotAllowedAggregations: [ * "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX" || "MEDIAN" || "SUM" || "AVERAGE" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE", * ], * NeverAggregateInFilter: true || false, * CellValueSynonyms: [ * { * CellValue: "STRING_VALUE", * Synonyms: "", * }, * ], * NonAdditive: true || false, * }, * ], * NamedEntities: [ // TopicNamedEntities * { // TopicNamedEntity * EntityName: "STRING_VALUE", // required * EntityDescription: "STRING_VALUE", * EntitySynonyms: [ * "STRING_VALUE", * ], * SemanticEntityType: { // SemanticEntityType * TypeName: "STRING_VALUE", * SubTypeName: "STRING_VALUE", * TypeParameters: { * "": "STRING_VALUE", * }, * }, * Definition: [ // NamedEntityDefinitions * { // NamedEntityDefinition * FieldName: "STRING_VALUE", * PropertyName: "STRING_VALUE", * PropertyRole: "PRIMARY" || "ID", * PropertyUsage: "INHERIT" || "DIMENSION" || "MEASURE", * Metric: { // NamedEntityDefinitionMetric * Aggregation: "SUM" || "MIN" || "MAX" || "COUNT" || "AVERAGE" || "DISTINCT_COUNT" || "STDEV" || "STDEVP" || "VAR" || "VARP" || "PERCENTILE" || "MEDIAN" || "CUSTOM", * AggregationFunctionParameters: { // AggregationFunctionParameters * "": "STRING_VALUE", * }, * }, * }, * ], * }, * ], * }, * ], * ConfigOptions: { // TopicConfigOptions * QBusinessInsightsEnabled: true || false, * }, * }, * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * FolderArns: [ // FolderArnList * "STRING_VALUE", * ], * CustomInstructions: { // CustomInstructions * CustomInstructionsString: "STRING_VALUE", // required * }, * }; * const command = new CreateTopicCommand(input); * const response = await client.send(command); * // { // CreateTopicResponse * // Arn: "STRING_VALUE", * // TopicId: "STRING_VALUE", * // RefreshArn: "STRING_VALUE", * // RequestId: "STRING_VALUE", * // Status: Number("int"), * // }; * * ``` * * @param CreateTopicCommandInput - {@link CreateTopicCommandInput} * @returns {@link CreateTopicCommandOutput} * @see {@link CreateTopicCommandInput} for command's `input` shape. * @see {@link CreateTopicCommandOutput} for command's `response` shape. * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have access to this item. The provided credentials couldn't be * validated. You might not be authorized to carry out the request. Make sure that your * account is authorized to use the Amazon Quick Sight service, that your policies have the * correct permissions, and that you are using the correct credentials.

* * @throws {@link ConflictException} (client fault) *

Updating or deleting a resource can cause an inconsistent state.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

One or more parameters has a value that isn't valid.

* * @throws {@link LimitExceededException} (client fault) *

A limit is exceeded.

* * @throws {@link ResourceExistsException} (client fault) *

The resource specified already exists.

* * @throws {@link ResourceNotFoundException} (client fault) *

One or more resources can't be found.

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @public */ export declare class CreateTopicCommand extends CreateTopicCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateTopicRequest; output: CreateTopicResponse; }; sdk: { input: CreateTopicCommandInput; output: CreateTopicCommandOutput; }; }; }