@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-quicksight-dataset.d.ts

@@ -0,0 +1,1014 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type QuickSightDataSet = ResourceDefinitionWithAttributes<"AWS::QuickSight::DataSet", QuickSightDataSetProps, QuickSightDataSetAttribs>;
+/**
+ * Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
+ */
+export type QuickSightDataSetProps = {
+    /**
+     * The AWS account ID.
+     * @minLength 12
+     * @maxLength 12
+     * @pattern ^[0-9]{12}$
+     */
+    AwsAccountId?: string | undefined;
+    /**
+     * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
+     */
+    ColumnGroups?: ColumnGroup[] | undefined;
+    /**
+     * A set of one or more definitions of a `ColumnLevelPermissionRule` .
+     */
+    ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined;
+    /**
+     * An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
+     */
+    DataSetId?: string | undefined;
+    /**
+     * The refresh properties of a dataset.
+     */
+    DataSetRefreshProperties?: DataSetRefreshProperties | undefined;
+    /**
+     * The usage configuration to apply to child datasets that reference this dataset as a source.
+     */
+    DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined;
+    /**
+     * The parameters that are declared in a dataset.
+     */
+    DatasetParameters?: DatasetParameter[] | undefined;
+    /**
+     * The folder that contains fields and nested subfolders for your dataset.
+     */
+    FieldFolders?: Record<string, FieldFolder> | undefined;
+    /**
+     * <p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>
+     */
+    FolderArns?: string[] | undefined;
+    /**
+     * Indicates whether you want to import the data into SPICE.
+     */
+    ImportMode?: DataSetImportMode | undefined;
+    /**
+     * The wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
+     */
+    IngestionWaitPolicy?: IngestionWaitPolicy | undefined;
+    /**
+     * Configures the combination and transformation of the data from the physical tables.
+     */
+    LogicalTableMap?: Record<string, LogicalTable> | undefined;
+    /**
+     * The display name for the dataset.
+     * @minLength 1
+     * @maxLength 128
+     */
+    Name?: string | undefined;
+    /**
+     * The performance optimization configuration of a dataset.
+     */
+    PerformanceConfiguration?: PerformanceConfiguration | undefined;
+    /**
+     * A list of resource permissions on the dataset.
+     */
+    Permissions?: ResourcePermission[] | undefined;
+    /**
+     * Declares the physical tables that are available in the underlying data sources.
+     */
+    PhysicalTableMap?: Record<string, PhysicalTable> | undefined;
+    /**
+     * The row-level security configuration for the data that you want to create.
+     */
+    RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
+    /**
+     * The element you can use to define tags for row-level security.
+     */
+    RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined;
+    /**
+     * Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The usage of the dataset.
+     */
+    UseAs?: DataSetUseAs | undefined;
+};
+export type QuickSightDataSetAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the dataset.
+     */
+    Arn: string;
+    /**
+     * <p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't
+     *             imported into SPICE.</p>
+     * @default 0
+     */
+    ConsumedSpiceCapacityInBytes: number;
+    /**
+     * The time this dataset version was created.
+     * @format string
+     */
+    CreatedTime: string;
+    /**
+     * The time this dataset version was last updated.
+     * @format string
+     */
+    LastUpdatedTime: string;
+};
+/**
+ * A calculated column for a dataset.
+ */
+export type CalculatedColumn = {
+    /**
+     * A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
+     * @minLength 1
+     * @maxLength 64
+     */
+    ColumnId: string;
+    /**
+     * Column name.
+     * @minLength 1
+     * @maxLength 127
+     */
+    ColumnName: string;
+    /**
+     * An expression that defines the calculated column.
+     * @minLength 1
+     * @maxLength 250000
+     */
+    Expression: string;
+};
+/**
+ * A transform operation that casts a column to a different type.
+ */
+export type CastColumnTypeOperation = {
+    /**
+     * Column name.
+     * @minLength 1
+     * @maxLength 127
+     */
+    ColumnName: string;
+    /**
+     * When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
+     * @minLength 0
+     * @maxLength 32
+     */
+    Format?: string | undefined;
+    /**
+     * New column data type.
+     */
+    NewColumnType: ColumnDataType;
+    /**
+     * The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
+     */
+    SubType?: ColumnDataSubType | undefined;
+};
+export type ColumnDataSubType = "FLOAT" | "FIXED";
+export type ColumnDataType = "STRING" | "INTEGER" | "DECIMAL" | "DATETIME";
+/**
+ * Metadata that contains a description for a column.
+ */
+export type ColumnDescription = {
+    /**
+     * The text of a description for a column.
+     * @minLength 0
+     * @maxLength 500
+     */
+    Text?: string | undefined;
+};
+/**
+ * Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ */
+export type ColumnGroup = {
+    /**
+     * Geospatial column group that denotes a hierarchy.
+     */
+    GeoSpatialColumnGroup?: GeoSpatialColumnGroup | undefined;
+};
+/**
+ * A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
+ */
+export type ColumnLevelPermissionRule = {
+    /**
+     * An array of column names.
+     */
+    ColumnNames?: string[] | undefined;
+    /**
+     * An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
+     */
+    Principals?: string[] | undefined;
+};
+/**
+ * A tag for a column in a `[TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html)` structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ */
+export type ColumnTag = {
+    /**
+     * A description for a column.
+     */
+    ColumnDescription?: ColumnDescription | undefined;
+    /**
+     * A geospatial role for a column.
+     */
+    ColumnGeographicRole?: GeoSpatialDataRole | undefined;
+};
+export type ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE" | "COLUMN_DESCRIPTION";
+/**
+ * A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
+ */
+export type CreateColumnsOperation = {
+    /**
+     * Calculated columns to create.
+     */
+    Columns?: CalculatedColumn[] | undefined;
+};
+/**
+ * A physical table type built from the results of the custom SQL query.
+ */
+export type CustomSql = {
+    /**
+     * The column schema from the SQL query result set.
+     */
+    Columns?: InputColumn[] | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the data source.
+     */
+    DataSourceArn: string;
+    /**
+     * A display name for the SQL query result.
+     * @minLength 1
+     * @maxLength 128
+     */
+    Name: string;
+    /**
+     * The SQL query.
+     * @minLength 1
+     * @maxLength 168000
+     */
+    SqlQuery: string;
+};
+export type DataSetImportMode = "SPICE" | "DIRECT_QUERY";
+/**
+ * The refresh properties of a dataset.
+ */
+export type DataSetRefreshProperties = {
+    /**
+     * The failure configuration for a dataset.
+     */
+    FailureConfiguration?: RefreshFailureConfiguration | undefined;
+    /**
+     * The refresh configuration for a dataset.
+     */
+    RefreshConfiguration?: RefreshConfiguration | undefined;
+};
+/**
+ * The usage configuration to apply to child datasets that reference this dataset as a source.
+ */
+export type DataSetUsageConfiguration = {
+    /**
+     * An option that controls whether a child dataset of a direct query can use this dataset as a source.
+     * @default false
+     */
+    DisableUseAsDirectQuerySource?: boolean | undefined;
+    /**
+     * An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
+     * @default false
+     */
+    DisableUseAsImportedSource?: boolean | undefined;
+};
+export type DataSetUseAs = "RLS_RULES";
+/**
+ * The parameter declarations of the dataset.
+ */
+export type DatasetParameter = {
+    /**
+     * A date time parameter that is created in the dataset.
+     */
+    DateTimeDatasetParameter?: DateTimeDatasetParameter | undefined;
+    /**
+     * A decimal parameter that is created in the dataset.
+     */
+    DecimalDatasetParameter?: DecimalDatasetParameter | undefined;
+    /**
+     * An integer parameter that is created in the dataset.
+     */
+    IntegerDatasetParameter?: IntegerDatasetParameter | undefined;
+    /**
+     * A string parameter that is created in the dataset.
+     */
+    StringDatasetParameter?: StringDatasetParameter | undefined;
+};
+export type DatasetParameterValueType = "MULTI_VALUED" | "SINGLE_VALUED";
+/**
+ * A date time parameter that is created in the dataset.
+ */
+export type DateTimeDatasetParameter = {
+    /**
+     * A list of default values for a given date time parameter. This structure only accepts static values.
+     */
+    DefaultValues?: DateTimeDatasetParameterDefaultValues | undefined;
+    /**
+     * An identifier for the parameter that is created in the dataset.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-]+$
+     */
+    Id: string;
+    /**
+     * The name of the date time parameter that is created in the dataset.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9]+$
+     */
+    Name: string;
+    /**
+     * The time granularity of the date time parameter.
+     */
+    TimeGranularity?: TimeGranularity | undefined;
+    /**
+     * The value type of the dataset parameter. Valid values are `single value` or `multi value` .
+     */
+    ValueType: DatasetParameterValueType;
+};
+/**
+ * <p>The default values of a date time parameter.</p>
+ */
+export type DateTimeDatasetParameterDefaultValues = {
+    /**
+     * A list of static default values for a given date time parameter. The valid format for this property is `yyyy-MM-dd’T’HH:mm:ss’Z’` .
+     */
+    StaticValues?: string[] | undefined;
+};
+/**
+ * A decimal parameter that is created in the dataset.
+ */
+export type DecimalDatasetParameter = {
+    /**
+     * A list of default values for a given decimal parameter. This structure only accepts static values.
+     */
+    DefaultValues?: DecimalDatasetParameterDefaultValues | undefined;
+    /**
+     * An identifier for the decimal parameter created in the dataset.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-]+$
+     */
+    Id: string;
+    /**
+     * The name of the decimal parameter that is created in the dataset.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9]+$
+     */
+    Name: string;
+    /**
+     * The value type of the dataset parameter. Valid values are `single value` or `multi value` .
+     */
+    ValueType: DatasetParameterValueType;
+};
+/**
+ * A list of default values for a given decimal parameter. This structure only accepts static values.
+ */
+export type DecimalDatasetParameterDefaultValues = {
+    /**
+     * A list of static default values for a given decimal parameter.
+     */
+    StaticValues?: number[] | undefined;
+};
+/**
+ * A FieldFolder element is a folder that contains fields and nested subfolders.
+ */
+export type FieldFolder = {
+    /**
+     * A folder has a list of columns. A column can only be in one folder.
+     */
+    Columns?: string[] | undefined;
+    /**
+     * The description for a field folder.
+     * @minLength 0
+     * @maxLength 500
+     */
+    Description?: string | undefined;
+};
+export type FileFormat = "CSV" | "TSV" | "CLF" | "ELF" | "XLSX" | "JSON";
+/**
+ * A transform operation that filters rows based on a condition.
+ */
+export type FilterOperation = {
+    /**
+     * An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
+     * @minLength 1
+     * @maxLength 4096
+     */
+    ConditionExpression: string;
+};
+/**
+ * Geospatial column group that denotes a hierarchy.
+ */
+export type GeoSpatialColumnGroup = {
+    /**
+     * Columns in this hierarchy.
+     */
+    Columns: string[];
+    /**
+     * Country code.
+     */
+    CountryCode?: GeoSpatialCountryCode | undefined;
+    /**
+     * A display name for the hierarchy.
+     * @minLength 1
+     * @maxLength 64
+     */
+    Name: string;
+};
+export type GeoSpatialCountryCode = "US";
+export type GeoSpatialDataRole = "COUNTRY" | "STATE" | "COUNTY" | "CITY" | "POSTCODE" | "LONGITUDE" | "LATITUDE" | "POLITICAL1" | "CENSUS_TRACT" | "CENSUS_BLOCK_GROUP" | "CENSUS_BLOCK";
+/**
+ * The incremental refresh configuration for a dataset.
+ */
+export type IncrementalRefresh = {
+    /**
+     * The lookback window setup for an incremental refresh configuration.
+     */
+    LookbackWindow: LookbackWindow;
+};
+/**
+ * The wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
+ */
+export type IngestionWaitPolicy = {
+    /**
+     * The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. Applicable only when `DataSetImportMode` mode is set to SPICE and `WaitForSpiceIngestion` is set to true.
+     * @min 1
+     * @max 36
+     * @default 36
+     */
+    IngestionWaitTimeInHours?: number | undefined;
+    /**
+     * Wait for SPICE ingestion to finish to mark dataset creation or update as successful. Default (true). Applicable only when `DataSetImportMode` mode is set to SPICE.
+     * @default true
+     */
+    WaitForSpiceIngestion?: boolean | undefined;
+};
+/**
+ * Metadata for a column that is used as the input of a transform operation.
+ */
+export type InputColumn = {
+    /**
+     * The name of this column in the underlying data source.
+     * @minLength 1
+     * @maxLength 127
+     */
+    Name: string;
+    /**
+     * The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
+     */
+    SubType?: ColumnDataSubType | undefined;
+    /**
+     * The data type of the column.
+     */
+    Type: InputColumnDataType;
+};
+export type InputColumnDataType = "STRING" | "INTEGER" | "DECIMAL" | "DATETIME" | "BIT" | "BOOLEAN" | "JSON";
+/**
+ * An integer parameter that is created in the dataset.
+ */
+export type IntegerDatasetParameter = {
+    /**
+     * A list of default values for a given integer parameter. This structure only accepts static values.
+     */
+    DefaultValues?: IntegerDatasetParameterDefaultValues | undefined;
+    /**
+     * An identifier for the integer parameter created in the dataset.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-]+$
+     */
+    Id: string;
+    /**
+     * The name of the integer parameter that is created in the dataset.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9]+$
+     */
+    Name: string;
+    /**
+     * The value type of the dataset parameter. Valid values are `single value` or `multi value` .
+     */
+    ValueType: DatasetParameterValueType;
+};
+/**
+ * A list of default values for a given integer parameter. This structure only accepts static values.
+ */
+export type IntegerDatasetParameterDefaultValues = {
+    /**
+     * A list of static default values for a given integer parameter.
+     */
+    StaticValues?: number[] | undefined;
+};
+/**
+ * The instructions associated with a join.
+ */
+export type JoinInstruction = {
+    /**
+     * Join key properties of the left operand.
+     */
+    LeftJoinKeyProperties?: JoinKeyProperties | undefined;
+    /**
+     * The operand on the left side of a join.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern ^[0-9a-zA-Z-]*$
+     */
+    LeftOperand: string;
+    /**
+     * The join instructions provided in the `ON` clause of a join.
+     * @minLength 1
+     * @maxLength 512
+     */
+    OnClause: string;
+    /**
+     * Join key properties of the right operand.
+     */
+    RightJoinKeyProperties?: JoinKeyProperties | undefined;
+    /**
+     * The operand on the right side of a join.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern ^[0-9a-zA-Z-]*$
+     */
+    RightOperand: string;
+    /**
+     * The type of join that it is.
+     */
+    Type: JoinType;
+};
+/**
+ * Properties associated with the columns participating in a join.
+ */
+export type JoinKeyProperties = {
+    /**
+     * A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by QuickSight to optimize query performance.
+     */
+    UniqueKey?: boolean | undefined;
+};
+export type JoinType = "INNER" | "OUTER" | "LEFT" | "RIGHT";
+/**
+ * A *logical table* is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
+ */
+export type LogicalTable = {
+    /**
+     * A display name for the logical table.
+     * @minLength 1
+     * @maxLength 64
+     */
+    Alias: string;
+    /**
+     * Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
+     */
+    DataTransforms?: TransformOperation[] | undefined;
+    /**
+     * Source of this logical table.
+     */
+    Source?: LogicalTableSource | undefined;
+};
+/**
+ * Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ */
+export type LogicalTableSource = {
+    /**
+     * The Amazon Resource Number (ARN) of the parent dataset.
+     */
+    DataSetArn?: string | undefined;
+    /**
+     * Specifies the result of a join of two logical tables.
+     */
+    JoinInstruction?: JoinInstruction | undefined;
+    /**
+     * Physical table ID.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern ^[0-9a-zA-Z-]*$
+     */
+    PhysicalTableId?: string | undefined;
+};
+/**
+ * The lookback window setup of an incremental refresh configuration.
+ */
+export type LookbackWindow = {
+    /**
+     * The name of the lookback window column.
+     */
+    ColumnName: string;
+    /**
+     * The lookback window column size.
+     * @min 1
+     * @default 0
+     */
+    Size: number;
+    /**
+     * The size unit that is used for the lookback window column. Valid values for this structure are `HOUR` , `DAY` , and `WEEK` .
+     */
+    SizeUnit: LookbackWindowSizeUnit;
+};
+export type LookbackWindowSizeUnit = "HOUR" | "DAY" | "WEEK";
+/**
+ * The new default values for the parameter.
+ */
+export type NewDefaultValues = {
+    /**
+     * A list of static default values for a given date time parameter. The valid format for this property is `yyyy-MM-dd’T’HH:mm:ss’Z’` .
+     */
+    DateTimeStaticValues?: string[] | undefined;
+    /**
+     * A list of static default values for a given decimal parameter.
+     */
+    DecimalStaticValues?: number[] | undefined;
+    /**
+     * A list of static default values for a given integer parameter.
+     */
+    IntegerStaticValues?: number[] | undefined;
+    /**
+     * A list of static default values for a given string parameter.
+     */
+    StringStaticValues?: string[] | undefined;
+};
+/**
+ * A transform operation that overrides the dataset parameter values that are defined in another dataset.
+ */
+export type OverrideDatasetParameterOperation = {
+    /**
+     * The new default values for the parameter.
+     */
+    NewDefaultValues?: NewDefaultValues | undefined;
+    /**
+     * The new name for the parameter.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9]+$
+     */
+    NewParameterName?: string | undefined;
+    /**
+     * The name of the parameter to be overridden with different values.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9]+$
+     */
+    ParameterName: string;
+};
+export type PerformanceConfiguration = {
+    UniqueKeys?: UniqueKey[] | undefined;
+};
+/**
+ * A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ */
+export type PhysicalTable = {
+    /**
+     * A physical table type built from the results of the custom SQL query.
+     */
+    CustomSql?: CustomSql | undefined;
+    /**
+     * A physical table type for relational data sources.
+     */
+    RelationalTable?: RelationalTable | undefined;
+    /**
+     * A physical table type for as S3 data source.
+     */
+    S3Source?: S3Source | undefined;
+};
+/**
+ * A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
+ */
+export type ProjectOperation = {
+    /**
+     * Projected columns.
+     */
+    ProjectedColumns: string[];
+};
+/**
+ * The refresh configuration of a dataset.
+ */
+export type RefreshConfiguration = {
+    /**
+     * The incremental refresh for the dataset.
+     */
+    IncrementalRefresh: IncrementalRefresh;
+};
+export type RefreshFailureAlertStatus = "ENABLED" | "DISABLED";
+/**
+ * The failure configuration of a dataset.
+ */
+export type RefreshFailureConfiguration = {
+    /**
+     * The email alert configuration for a dataset refresh failure.
+     */
+    EmailAlert?: RefreshFailureEmailAlert | undefined;
+};
+/**
+ * The configuration settings for the email alerts that are sent when a dataset refresh fails.
+ */
+export type RefreshFailureEmailAlert = {
+    /**
+     * The status value that determines if email alerts are sent.
+     */
+    AlertStatus?: RefreshFailureAlertStatus | undefined;
+};
+/**
+ * A physical table type for relational data sources.
+ */
+export type RelationalTable = {
+    /**
+     * The catalog associated with a table.
+     * @minLength 0
+     * @maxLength 256
+     */
+    Catalog?: string | undefined;
+    /**
+     * The Amazon Resource Name (ARN) for the data source.
+     */
+    DataSourceArn: string;
+    /**
+     * The column schema of the table.
+     */
+    InputColumns?: InputColumn[] | undefined;
+    /**
+     * The name of the relational table.
+     * @minLength 1
+     * @maxLength 256
+     */
+    Name: string;
+    /**
+     * The schema name. This name applies to certain relational database engines.
+     * @minLength 0
+     * @maxLength 256
+     */
+    Schema?: string | undefined;
+};
+/**
+ * A transform operation that renames a column.
+ */
+export type RenameColumnOperation = {
+    /**
+     * The name of the column to be renamed.
+     * @minLength 1
+     * @maxLength 127
+     */
+    ColumnName: string;
+    /**
+     * The new name for the column.
+     * @minLength 1
+     * @maxLength 127
+     */
+    NewColumnName?: string | undefined;
+};
+/**
+ * Permission for the resource.
+ */
+export type ResourcePermission = {
+    /**
+     * The IAM action to grant or revoke permisions on
+     */
+    Actions: string[];
+    /**
+     * The Amazon Resource Name (ARN) of the principal. This can be one of the following:
+     *
+     * - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
+     * - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
+     * - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
+     * @minLength 1
+     * @maxLength 256
+     */
+    Principal: string;
+};
+/**
+ * Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see [Using Row-Level Security (RLS) to Restrict Access to a Dataset](https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) in the *Amazon QuickSight User Guide* .
+ *
+ * The option to deny permissions by setting `PermissionPolicy` to `DENY_ACCESS` is not supported for new RLS datasets.
+ */
+export type RowLevelPermissionDataSet = {
+    /**
+     * The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
+     */
+    Arn: string;
+    /**
+     * The user or group rules associated with the dataset that contains permissions for RLS.
+     *
+     * By default, `FormatVersion` is `VERSION_1` . When `FormatVersion` is `VERSION_1` , `UserName` and `GroupName` are required. When `FormatVersion` is `VERSION_2` , `UserARN` and `GroupARN` are required, and `Namespace` must not exist.
+     */
+    FormatVersion?: RowLevelPermissionFormatVersion | undefined;
+    /**
+     * The namespace associated with the dataset that contains permissions for RLS.
+     * @minLength 0
+     * @maxLength 64
+     * @pattern ^[a-zA-Z0-9._-]*$
+     */
+    Namespace?: string | undefined;
+    /**
+     * The type of permissions to use when interpreting the permissions for RLS. `DENY_ACCESS` is included for backward compatibility only.
+     */
+    PermissionPolicy: RowLevelPermissionPolicy;
+    /**
+     * The status of the row-level security permission dataset. If enabled, the status is `ENABLED` . If disabled, the status is `DISABLED` .
+     */
+    Status?: Status | undefined;
+};
+export type RowLevelPermissionFormatVersion = "VERSION_1" | "VERSION_2";
+export type RowLevelPermissionPolicy = "GRANT_ACCESS" | "DENY_ACCESS";
+/**
+ * The element you can use to define tags for row-level security.
+ */
+export type RowLevelPermissionTagConfiguration = {
+    /**
+     * The status of row-level security tags. If enabled, the status is `ENABLED` . If disabled, the status is `DISABLED` .
+     */
+    Status?: Status | undefined;
+    /**
+     * The configuration of tags on a dataset to set row-level security.
+     */
+    TagRuleConfigurations?: string[][] | undefined;
+    /**
+     * A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
+     */
+    TagRules: RowLevelPermissionTagRule[];
+};
+/**
+ * A set of rules associated with a tag.
+ */
+export type RowLevelPermissionTagRule = {
+    /**
+     * The column name that a tag key is assigned to.
+     */
+    ColumnName: string;
+    /**
+     * A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
+     * @minLength 1
+     * @maxLength 256
+     */
+    MatchAllValue?: string | undefined;
+    /**
+     * The unique key for a tag.
+     * @minLength 1
+     * @maxLength 128
+     */
+    TagKey: string;
+    /**
+     * A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
+     * @minLength 0
+     * @maxLength 10
+     */
+    TagMultiValueDelimiter?: string | undefined;
+};
+/**
+ * A physical table type for an S3 data source.
+ */
+export type S3Source = {
+    /**
+     * The Amazon Resource Name (ARN) for the data source.
+     */
+    DataSourceArn: string;
+    /**
+     * A physical table type for an S3 data source.
+     *
+     * > For files that aren't JSON, only `STRING` data types are supported in input columns.
+     */
+    InputColumns?: InputColumn[] | undefined;
+    /**
+     * Information about the format for the S3 source file or files.
+     */
+    UploadSettings?: UploadSettings | undefined;
+};
+export type Status = "ENABLED" | "DISABLED";
+/**
+ * A string parameter that is created in the dataset.
+ */
+export type StringDatasetParameter = {
+    /**
+     * A list of default values for a given string dataset parameter type. This structure only accepts static values.
+     */
+    DefaultValues?: StringDatasetParameterDefaultValues | undefined;
+    /**
+     * An identifier for the string parameter that is created in the dataset.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[a-zA-Z0-9-]+$
+     */
+    Id: string;
+    /**
+     * The name of the string parameter that is created in the dataset.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9]+$
+     */
+    Name: string;
+    /**
+     * The value type of the dataset parameter. Valid values are `single value` or `multi value` .
+     */
+    ValueType: DatasetParameterValueType;
+};
+/**
+ * A list of default values for a given string dataset parameter type. This structure only accepts static values.
+ */
+export type StringDatasetParameterDefaultValues = {
+    /**
+     * A list of static default values for a given string parameter.
+     */
+    StaticValues?: string[] | undefined;
+};
+/**
+ * A transform operation that tags a column with additional information.
+ */
+export type TagColumnOperation = {
+    /**
+     * The column that this operation acts on.
+     * @minLength 1
+     * @maxLength 127
+     */
+    ColumnName: string;
+    /**
+     * The dataset column tag, currently only used for geospatial type tagging.
+     *
+     * > This is not tags for the AWS tagging feature.
+     */
+    Tags: ColumnTag[];
+};
+export type TextQualifier = "DOUBLE_QUOTE" | "SINGLE_QUOTE";
+export type TimeGranularity = "YEAR" | "QUARTER" | "MONTH" | "WEEK" | "DAY" | "HOUR" | "MINUTE" | "SECOND" | "MILLISECOND";
+/**
+ * A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
+ */
+export type TransformOperation = {
+    /**
+     * A transform operation that casts a column to a different type.
+     */
+    CastColumnTypeOperation?: CastColumnTypeOperation | undefined;
+    /**
+     * An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
+     */
+    CreateColumnsOperation?: CreateColumnsOperation | undefined;
+    /**
+     * An operation that filters rows based on some condition.
+     */
+    FilterOperation?: FilterOperation | undefined;
+    /**
+     * A transform operation that overrides the dataset parameter values that are defined in another dataset.
+     */
+    OverrideDatasetParameterOperation?: OverrideDatasetParameterOperation | undefined;
+    /**
+     * An operation that projects columns. Operations that come after a projection can only refer to projected columns.
+     */
+    ProjectOperation?: ProjectOperation | undefined;
+    /**
+     * An operation that renames a column.
+     */
+    RenameColumnOperation?: RenameColumnOperation | undefined;
+    /**
+     * An operation that tags a column with additional information.
+     */
+    TagColumnOperation?: TagColumnOperation | undefined;
+    /**
+     * <p>A transform operation that removes tags associated with a column.</p>
+     */
+    UntagColumnOperation?: UntagColumnOperation | undefined;
+};
+export type UniqueKey = {
+    ColumnNames: string[];
+};
+/**
+ * A transform operation that removes tags associated with a column.
+ */
+export type UntagColumnOperation = {
+    /**
+     * The column that this operation acts on.
+     * @minLength 1
+     * @maxLength 127
+     */
+    ColumnName: string;
+    /**
+     * The column tags to remove from this column.
+     */
+    TagNames: ColumnTagName[];
+};
+/**
+ * Information about the format for a source file or files.
+ */
+export type UploadSettings = {
+    /**
+     * Whether the file has a header row, or the files each have a header row.
+     */
+    ContainsHeader?: boolean | undefined;
+    /**
+     * The delimiter between values in the file.
+     * @minLength 1
+     * @maxLength 1
+     */
+    Delimiter?: string | undefined;
+    /**
+     * File format.
+     */
+    Format?: FileFormat | undefined;
+    /**
+     * A row number to start reading data from.
+     * @min 1
+     */
+    StartFromRow?: number | undefined;
+    /**
+     * Text qualifier.
+     */
+    TextQualifier?: TextQualifier | undefined;
+};
+//# sourceMappingURL=aws-quicksight-dataset.d.ts.map