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.
* @public */ export type TransformOperation = TransformOperation.CastColumnTypeOperationMember | TransformOperation.CreateColumnsOperationMember | TransformOperation.FilterOperationMember | TransformOperation.OverrideDatasetParameterOperationMember | TransformOperation.ProjectOperationMember | TransformOperation.RenameColumnOperationMember | TransformOperation.TagColumnOperationMember | TransformOperation.UntagColumnOperationMember | TransformOperation.$UnknownMember; /** * @public */ export declare namespace TransformOperation { /** *An operation that projects columns. Operations that come after a projection can only * refer to projected columns.
* @public */ interface ProjectOperationMember { ProjectOperation: ProjectOperation; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *An operation that filters rows based on some condition.
* @public */ interface FilterOperationMember { ProjectOperation?: never; FilterOperation: FilterOperation; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *An operation that creates calculated columns. Columns created in one such operation * form a lexical closure.
* @public */ interface CreateColumnsOperationMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation: CreateColumnsOperation; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *An operation that renames a column.
* @public */ interface RenameColumnOperationMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation: RenameColumnOperation; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *A transform operation that casts a column to a different type.
* @public */ interface CastColumnTypeOperationMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation: CastColumnTypeOperation; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *An operation that tags a column with additional information.
* @public */ interface TagColumnOperationMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation: TagColumnOperation; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *A transform operation that removes tags associated with a column.
* @public */ interface UntagColumnOperationMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation: UntagColumnOperation; OverrideDatasetParameterOperation?: never; $unknown?: never; } /** *A transform operation that overrides the dataset parameter values that are defined in another dataset.
* @public */ interface OverrideDatasetParameterOperationMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation: OverrideDatasetParameterOperation; $unknown?: never; } /** * @public */ interface $UnknownMember { ProjectOperation?: never; FilterOperation?: never; CreateColumnsOperation?: never; RenameColumnOperation?: never; CastColumnTypeOperation?: never; TagColumnOperation?: never; UntagColumnOperation?: never; OverrideDatasetParameterOperation?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorProperties associated with the columns participating in a join.
* @public */ export interface 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 Quick Sight to optimize query performance.
* @public */ UniqueKey?: boolean | undefined; } /** *The instructions associated with a join.
* @public */ export interface JoinInstruction { /** *The operand on the left side of a join.
* @public */ LeftOperand: string | undefined; /** *The operand on the right side of a join.
* @public */ RightOperand: string | undefined; /** *Join key properties of the left operand.
* @public */ LeftJoinKeyProperties?: JoinKeyProperties | undefined; /** *Join key properties of the right operand.
* @public */ RightJoinKeyProperties?: JoinKeyProperties | undefined; /** *The type of join that it is.
* @public */ Type: JoinType | undefined; /** *The join instructions provided in the ON clause of a join.
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.
* @public */ export interface LogicalTableSource { /** *Specifies the result of a join of two logical tables.
* @public */ JoinInstruction?: JoinInstruction | undefined; /** *Physical table ID.
* @public */ PhysicalTableId?: string | undefined; /** *The Amazon Resource Number (ARN) of the parent dataset.
* @public */ DataSetArn?: string | undefined; } /** *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.
* @public */ export interface LogicalTable { /** *A display name for the logical table.
* @public */ Alias: string | undefined; /** *Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
* @public */ DataTransforms?: TransformOperation[] | undefined; /** *Source of this logical table.
* @public */ Source: LogicalTableSource | undefined; } /** *A UniqueKey configuration that references a dataset column.
The name of the column that is referenced in the UniqueKey
* configuration.
The configuration for the performance optimization of the dataset that contains a
* UniqueKey configuration.
A UniqueKey configuration.
A physical table type built from the results of the custom SQL query.
* @public */ export interface CustomSql { /** *The Amazon Resource Name (ARN) of the data source.
* @public */ DataSourceArn: string | undefined; /** *A display name for the SQL query result.
* @public */ Name: string | undefined; /** *The SQL query.
* @public */ SqlQuery: string | undefined; /** *The column schema from the SQL query result set.
* @public */ Columns?: InputColumn[] | undefined; } /** *A physical table type for relational data sources.
* @public */ export interface RelationalTable { /** *The Amazon Resource Name (ARN) for the data source.
* @public */ DataSourceArn: string | undefined; /** *The catalog associated with a table.
* @public */ Catalog?: string | undefined; /** *The schema name. This name applies to certain relational database engines.
* @public */ Schema?: string | undefined; /** *The name of the relational table.
* @public */ Name: string | undefined; /** *The column schema of the table.
* @public */ InputColumns: InputColumn[] | undefined; } /** *Information about the format for a source file or files.
* @public */ export interface UploadSettings { /** *File format.
* @public */ Format?: FileFormat | undefined; /** *A row number to start reading data from.
* @public */ StartFromRow?: number | undefined; /** *Whether the file has a header row, or the files each have a header row.
* @public */ ContainsHeader?: boolean | undefined; /** *Text qualifier.
* @public */ TextQualifier?: TextQualifier | undefined; /** *The delimiter between values in the file.
* @public */ Delimiter?: string | undefined; /** *A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
* @public */ CustomCellAddressRange?: string | undefined; } /** *A physical table type for an S3 data source.
* @public */ export interface S3Source { /** *The Amazon Resource Name (ARN) for the data source.
* @public */ DataSourceArn: string | undefined; /** *Information about the format for the S3 source file or files.
* @public */ UploadSettings?: UploadSettings | undefined; /** *A physical table type for an S3 data source.
*For files that aren't JSON, only STRING data types are supported in input columns.
An element in the hierarchical path to a table within a data source, containing both name and identifier.
* @public */ export interface TablePathElement { /** *The name of the path element.
* @public */ Name?: string | undefined; /** *The unique identifier of the path element.
* @public */ Id?: string | undefined; } /** *A table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions.
* @public */ export interface SaaSTable { /** *The Amazon Resource Name (ARN) of the SaaS data source.
* @public */ DataSourceArn: string | undefined; /** *The hierarchical path to the table within the SaaS data source.
* @public */ TablePath: TablePathElement[] | undefined; /** *The list of input columns available from the SaaS table.
* @public */ InputColumns: InputColumn[] | 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.
* @public */ export type PhysicalTable = PhysicalTable.CustomSqlMember | PhysicalTable.RelationalTableMember | PhysicalTable.S3SourceMember | PhysicalTable.SaaSTableMember | PhysicalTable.$UnknownMember; /** * @public */ export declare namespace PhysicalTable { /** *A physical table type for relational data sources.
* @public */ interface RelationalTableMember { RelationalTable: RelationalTable; CustomSql?: never; S3Source?: never; SaaSTable?: never; $unknown?: never; } /** *A physical table type built from the results of the custom SQL query.
* @public */ interface CustomSqlMember { RelationalTable?: never; CustomSql: CustomSql; S3Source?: never; SaaSTable?: never; $unknown?: never; } /** *A physical table type for as S3 data source.
* @public */ interface S3SourceMember { RelationalTable?: never; CustomSql?: never; S3Source: S3Source; SaaSTable?: never; $unknown?: never; } /** *A physical table type for Software-as-a-Service (SaaS) sources.
* @public */ interface SaaSTableMember { RelationalTable?: never; CustomSql?: never; S3Source?: never; SaaSTable: SaaSTable; $unknown?: never; } /** * @public */ interface $UnknownMember { RelationalTable?: never; CustomSql?: never; S3Source?: never; SaaSTable?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorInformation 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 in the Quick Sight User * Guide.
*The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is
* not supported for new RLS datasets.
The namespace associated with the dataset that contains permissions for RLS.
* @public */ Namespace?: string | undefined; /** *The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
* @public */ Arn: string | undefined; /** *The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
* is included for backward compatibility only.
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.
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
A set of rules associated with a tag.
* @public */ export interface RowLevelPermissionTagRule { /** *The unique key for a tag.
* @public */ TagKey: string | undefined; /** *The column name that a tag key is assigned to.
* @public */ ColumnName: string | undefined; /** *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.
* @public */ TagMultiValueDelimiter?: string | undefined; /** *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.
* @public */ MatchAllValue?: string | undefined; } /** *The configuration of tags on a dataset to set row-level security.
* @public */ export interface RowLevelPermissionTagConfiguration { /** *The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
* @public */ TagRules: RowLevelPermissionTagRule[] | undefined; /** *A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
* @public */ TagRuleConfigurations?: string[][] | undefined; } /** *Configuration for row level security.
* @public */ export interface RowLevelPermissionConfiguration { /** *The configuration of tags on a dataset to set row-level security.
* @public */ TagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** *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 in the Quick Sight User * Guide.
*The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is
* not supported for new RLS datasets.
A semantic table that represents the final analytical structure of the data.
* @public */ export interface SemanticTable { /** *Alias for the semantic table.
* @public */ Alias: string | undefined; /** *The identifier of the destination table from data preparation that provides data to this semantic table.
* @public */ DestinationTableId: string | undefined; /** *Configuration for row level security that control data access for this semantic table.
* @public */ RowLevelPermissionConfiguration?: RowLevelPermissionConfiguration | undefined; } /** *Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.
* @public */ export interface SemanticModelConfiguration { /** *A map of semantic tables that define the analytical structure.
* @public */ TableMap?: RecordThe Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId: string | undefined; /** *The display name for the dataset.
* @public */ Name: string | undefined; /** *Declares the physical tables that are available in the underlying data sources.
* @public */ PhysicalTableMap: RecordConfigures the combination and transformation of the data from the physical * tables. This parameter is used with the legacy data preparation experience.
* * @deprecated (since 2025-10-23) Only used in the legacy data preparation experience. * @public */ LogicalTableMap?: RecordIndicates whether you want to import the data into SPICE.
* @public */ ImportMode: DataSetImportMode | undefined; /** *Groupings of columns that work together in certain Amazon Quick Sight features. * Currently, only geospatial hierarchy is supported.
* @public */ ColumnGroups?: ColumnGroup[] | undefined; /** *The folder that contains fields and nested subfolders for your dataset.
* @public */ FieldFolders?: RecordA list of resource permissions on the dataset.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The row-level security configuration for the data that you want to create. This parameter is * used with the legacy data preparation experience.
* * @deprecated (since 2025-10-23) Only used in the legacy data preparation experience. * @public */ RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** *The configuration of tags on a dataset to set row-level security. Row-level security * tags are currently supported for anonymous embedding only. This parameter is * used with the legacy data preparation experience.
* * @deprecated (since 2025-10-23) Only used in the legacy data preparation experience. * @public */ RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** *A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
Contains a map of the key-value pairs for the resource tag or tags assigned to the * dataset.
* @public */ Tags?: Tag[] | undefined; /** *The usage configuration to apply to child datasets that reference this dataset as a source.
* @public */ DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** *The parameter declarations of the dataset.
* @public */ DatasetParameters?: DatasetParameter[] | undefined; /** *When you create the dataset, Amazon Quick Sight adds the dataset to these * folders.
* @public */ FolderArns?: string[] | undefined; /** *The configuration for the performance optimization of the dataset that contains a
* UniqueKey configuration.
The usage of the dataset. RLS_RULES must be specified for RLS permission
* datasets.
The data preparation configuration for the dataset. This configuration defines the source tables, * transformation steps, and destination tables used to prepare the data. * Required when using the new data preparation experience.
* @public */ DataPrepConfiguration?: DataPrepConfiguration | undefined; /** *The semantic model configuration for the dataset. This configuration defines how the prepared * data is structured for an analysis, including table mappings and row-level security configurations. * Required when using the new data preparation experience.
* @public */ SemanticModelConfiguration?: SemanticModelConfiguration | undefined; } /** * @public */ export interface CreateDataSetResponse { /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ Arn?: string | undefined; /** *The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId?: string | undefined; /** *The ARN for the ingestion, which is triggered as a result of dataset creation if the * import mode is SPICE.
* @public */ IngestionArn?: string | undefined; /** *The ID of the ingestion, which is triggered as a result of dataset creation if the * import mode is SPICE.
* @public */ IngestionId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *The combination of user name and password that are used as credentials.
* @public */ export interface CredentialPair { /** *User name.
* @public */ Username: string | undefined; /** *Password.
* @public */ Password: string | undefined; /** *A set of alternate data source parameters that you want to share for these
* credentials. The credentials are applied in tandem with the data source parameters when
* you copy a data source by using a create or update request. The API operation compares
* the DataSourceParameters structure that's in the request with the
* structures in the AlternateDataSourceParameters allow list. If the
* structures are an exact match, the request is allowed to use the new data source with
* the existing credentials. If the AlternateDataSourceParameters list is
* null, the DataSourceParameters originally used with these
* Credentials is automatically allowed.
The combination of username, private key and passphrase that are used as credentials.
* @public */ export interface KeyPairCredentials { /** *Username
* @public */ KeyPairUsername: string | undefined; /** *PrivateKey
* @public */ PrivateKey: string | undefined; /** *PrivateKeyPassphrase
* @public */ PrivateKeyPassphrase?: string | undefined; } /** *The OAuth 2.0 client credentials used for authenticating a data source connection. * Use this structure to provide a client ID, client secret, and username directly * instead of referencing a secret stored in Amazon Secrets Manager. This structure * supports data sources that use two-legged OAuth (2LO) authentication, such as * Snowflake.
* @public */ export interface OAuthClientCredentials { /** *The client ID of the OAuth 2.0 application that is registered with the data source * provider.
* @public */ ClientId?: string | undefined; /** *The client secret of the OAuth 2.0 application that is registered with the data source * provider.
* @public */ ClientSecret?: string | undefined; /** *The username of the account that is used for OAuth 2.0 client credentials * authentication with the data source provider.
* @public */ Username?: string | undefined; } /** *The credentials for authenticating with a web proxy server.
* @public */ export interface WebProxyCredentials { /** *The username for authenticating with the web proxy server.
* @public */ WebProxyUsername: string | undefined; /** *The password for authenticating with the web proxy server.
* @public */ WebProxyPassword: string | undefined; } /** *Data source credentials. This is a variant type structure. For this structure to be * valid, only one of the attributes can be non-null.
* @public */ export interface DataSourceCredentials { /** *Credential pair. For more information, see
*
* CredentialPair
* .
The Amazon Resource Name (ARN) of a data source that has the credential pair that you
* want to use. When CopySourceArn is not null, the credential pair from the
* data source in the ARN is used as the credentials for the
* DataSourceCredentials structure.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
* @public */ SecretArn?: string | undefined; /** *The credentials for connecting using key-pair.
* @public */ KeyPairCredentials?: KeyPairCredentials | undefined; /** *The credentials for connecting through a web proxy server.
* @public */ WebProxyCredentials?: WebProxyCredentials | undefined; /** *The OAuth client credentials for connecting to a data source using OAuth 2.0 client
* credentials (2LO) authentication. For more information, see
*
* OAuthClientCredentials
* .
The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *An ID for the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId: string | undefined; /** *A display name for the data source.
* @public */ Name: string | undefined; /** *The type of the data source. To return a list of all data sources, use
* ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
The parameters that Amazon Quick Sight uses to connect to your underlying * source.
* @public */ DataSourceParameters?: DataSourceParameters | undefined; /** *The credentials Amazon Quick Sight that uses to connect to your underlying source. * Currently, only credentials based on user name and password are supported.
* @public */ Credentials?: DataSourceCredentials | undefined; /** *A list of resource permissions on the data source.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *Use this parameter only when you want Amazon Quick Sight to use a VPC connection when * connecting to your underlying source.
* @public */ VpcConnectionProperties?: VpcConnectionProperties | undefined; /** *Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to * your underlying source.
* @public */ SslProperties?: SslProperties | undefined; /** *Contains a map of the key-value pairs for the resource tag or tags assigned to the * data source.
* @public */ Tags?: Tag[] | undefined; /** *When you create the data source, Amazon Quick Sight adds the data source to these * folders.
* @public */ FolderArns?: string[] | undefined; } /** * @public */ export interface CreateDataSourceResponse { /** *The Amazon Resource Name (ARN) of the data source.
* @public */ Arn?: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId?: string | undefined; /** *The status of creating the data source.
* @public */ CreationStatus?: ResourceStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface CreateFolderRequest { /** *The ID for the Amazon Web Services account where you want to create the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The name of the folder.
* @public */ Name?: string | undefined; /** *The type of folder. By default, folderType is SHARED.
The Amazon Resource Name (ARN) for the parent folder.
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
A structure that describes the principals and the resource-level permissions of a folder.
*To specify no permissions, omit Permissions.
Tags for the folder.
* @public */ Tags?: Tag[] | undefined; /** *An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.
The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Resource Name (ARN) for the newly created folder.
* @public */ Arn?: string | undefined; /** *The folder ID for the newly created folder.
* @public */ FolderId?: string | undefined; /** *The request ID for the newly created folder.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface CreateFolderMembershipRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The ID of the asset that you want to add to the folder.
* @public */ MemberId: string | undefined; /** *The member type of the asset that you want to add to a folder.
* @public */ MemberType: MemberType | undefined; } /** *An asset in a Quick Sight folder, such as a dashboard, analysis, or dataset.
* @public */ export interface FolderMember { /** *The ID of an asset in the folder.
* @public */ MemberId?: string | undefined; /** *The type of asset that it is.
* @public */ MemberType?: MemberType | undefined; } /** * @public */ export interface CreateFolderMembershipResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *Information about the member in the folder.
* @public */ FolderMember?: FolderMember | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *The request object for this operation.
* @public */ export interface CreateGroupRequest { /** *A name for the group that you want to create.
* @public */ GroupName: string | undefined; /** *A description for the group that you want to create.
* @public */ Description?: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that you want the group to be a part of.
* @public */ Namespace: string | undefined; } /** *A group in Quick Sight consists of a set of users. You can * use groups to make it easier to manage access and security.
* @public */ export interface Group { /** *The Amazon Resource Name (ARN) for the group.
* @public */ Arn?: string | undefined; /** *The name of the group.
* @public */ GroupName?: string | undefined; /** *The group description.
* @public */ Description?: string | undefined; /** *The principal ID of the group.
* @public */ PrincipalId?: string | undefined; } /** *The response object for this operation.
* @public */ export interface CreateGroupResponse { /** *The name of the group.
* @public */ Group?: Group | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface CreateGroupMembershipRequest { /** *The name of the user that you want to add to the group membership.
* @public */ MemberName: string | undefined; /** *The name of the group that you want to add the user to.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that you want the user to be a part of.
* @public */ Namespace: string | undefined; } /** *A member of an Quick Sight group. Currently, group members must be users. Groups * can't be members of another group. .
* @public */ export interface GroupMember { /** *The Amazon Resource Name (ARN) for the group member (user).
* @public */ Arn?: string | undefined; /** *The name of the group member (user).
* @public */ MemberName?: string | undefined; } /** * @public */ export interface CreateGroupMembershipResponse { /** *The group member.
* @public */ GroupMember?: GroupMember | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface CreateIAMPolicyAssignmentRequest { /** *The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon Quick Sight users or groups.
* @public */ AwsAccountId: string | undefined; /** *The name of the assignment, also called a rule. * The * name * must be unique within the * Amazon Web Services account.
* @public */ AssignmentName: string | undefined; /** *The status of the assignment. Possible values are as follows:
*
* ENABLED - Anything specified in this assignment is used when
* creating the data source.
* DISABLED - This assignment isn't used when creating the data
* source.
* DRAFT - This assignment is an unfinished draft and isn't used
* when creating the data source.
The ARN for the IAM policy to apply to the Amazon Quick Sight users and * groups specified in this assignment.
* @public */ PolicyArn?: string | undefined; /** *The Amazon Quick Sight users, groups, or both that you want to assign the policy * to.
* @public */ Identities?: RecordThe namespace that contains the assignment.
* @public */ Namespace: string | undefined; } /** * @public */ export interface CreateIAMPolicyAssignmentResponse { /** *The name of the assignment. * The * name must be unique within the Amazon Web Services account.
* @public */ AssignmentName?: string | undefined; /** *The ID for the assignment.
* @public */ AssignmentId?: string | undefined; /** *The status of the assignment. Possible values are as follows:
*
* ENABLED - Anything specified in this assignment is used when
* creating the data source.
* DISABLED - This assignment isn't used when creating the data
* source.
* DRAFT - This assignment is an unfinished draft and isn't used
* when creating the data source.
The ARN for the IAM policy that is applied to the Amazon Quick Sight * users and groups specified in this assignment.
* @public */ PolicyArn?: string | undefined; /** *The Amazon Quick Sight users, groups, or both that the IAM policy is * assigned to.
* @public */ Identities?: RecordThe Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface CreateIngestionRequest { /** *The ID of the dataset used in the ingestion.
* @public */ DataSetId: string | undefined; /** *An ID for the ingestion.
* @public */ IngestionId: string | undefined; /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The type of ingestion that you want to create.
* @public */ IngestionType?: IngestionType | undefined; } /** * @public */ export interface CreateIngestionResponse { /** *The Amazon Resource Name (ARN) for the data ingestion.
* @public */ Arn?: string | undefined; /** *An ID for the ingestion.
* @public */ IngestionId?: string | undefined; /** *The ingestion status.
* @public */ IngestionStatus?: IngestionStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface CreateNamespaceRequest { /** *The ID for the Amazon Web Services account that you want to create the Quick Sight namespace in.
* @public */ AwsAccountId: string | undefined; /** *The name that you want to use to describe the new namespace.
* @public */ Namespace: string | undefined; /** *Specifies the type of your user identity directory. Currently, this supports users
* with an identity type of QUICKSIGHT.
The tags that you want to associate with the namespace that you're creating.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateNamespaceResponse { /** *The ARN of the Quick Sight namespace you created.
* @public */ Arn?: string | undefined; /** *The name of the new namespace that you created.
* @public */ Name?: string | undefined; /** *The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. * This is set to the region that you run CreateNamespace in.
* @public */ CapacityRegion?: string | undefined; /** *The status of the creation of the namespace. This is an asynchronous process. A status
* of CREATED means that your namespace is ready to use. If an error occurs,
* it indicates if the process is retryable or non-retryable. In
* the case of a non-retryable error, refer to the error message for follow-up
* tasks.
Specifies the type of your user identity directory. Currently, this supports users
* with an identity type of QUICKSIGHT.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *The refresh on entity for weekly or monthly schedules.
* @public */ export interface ScheduleRefreshOnEntity { /** *The day of the week that you want to schedule a refresh on.
* @public */ DayOfWeek?: DayOfWeek | undefined; /** *The day of the month that you want to schedule refresh on.
* @public */ DayOfMonth?: string | undefined; } /** *Specifies the interval between each scheduled refresh of a dataset.
* @public */ export interface RefreshFrequency { /** *The interval between scheduled refreshes. Valid values are as follows:
*
* MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
* MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
* HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
* DAILY: The dataset refreshes every day.
* WEEKLY: The dataset refreshes every week.
* MONTHLY: The dataset refreshes every month.
The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.
* @public */ RefreshOnDay?: ScheduleRefreshOnEntity | undefined; /** *The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().
The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.
* @public */ TimeOfTheDay?: string | undefined; } /** *The refresh schedule of a dataset.
* @public */ export interface RefreshSchedule { /** *An identifier for the refresh schedule.
* @public */ ScheduleId: string | undefined; /** *The frequency for the refresh schedule.
* @public */ ScheduleFrequency: RefreshFrequency | undefined; /** *Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
The type of refresh that a datset undergoes. Valid values are as follows:
*
* FULL_REFRESH: A complete refresh of a dataset.
* INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.
For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon Quick Suite User Guide.
* @public */ RefreshType: IngestionType | undefined; /** *The Amazon Resource Name (ARN) for the refresh schedule.
* @public */ Arn?: string | undefined; } /** * @public */ export interface CreateRefreshScheduleRequest { /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The refresh schedule.
* @public */ Schedule: RefreshSchedule | undefined; } /** * @public */ export interface CreateRefreshScheduleResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The ID of the refresh schedule.
* @public */ ScheduleId?: string | undefined; /** *The Amazon Resource Name (ARN) for the refresh schedule.
* @public */ Arn?: string | undefined; } /** * @public */ export interface CreateRoleMembershipRequest { /** *The name of the group that you want to add to the role.
* @public */ MemberName: string | undefined; /** *The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that the role belongs to.
* @public */ Namespace: string | undefined; /** *The role that you want to add a group to.
* @public */ Role: Role | undefined; } /** * @public */ export interface CreateRoleMembershipResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *Dataset schema.
* @public */ export interface DataSetSchema { /** *A structure containing the list of column schemas.
* @public */ ColumnSchemaList?: ColumnSchema[] | undefined; } /** *Dataset configuration.
* @public */ export interface DataSetConfiguration { /** *Placeholder.
* @public */ Placeholder?: string | undefined; /** *Dataset schema.
* @public */ DataSetSchema?: DataSetSchema | undefined; /** *A structure containing the list of column group schemas.
* @public */ ColumnGroupSchemaList?: ColumnGroupSchema[] | undefined; } /** *The detailed definition of a template.
* @public */ export interface TemplateVersionDefinition { /** *An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
* @public */ DataSetConfigurations: DataSetConfiguration[] | undefined; /** *An array of sheet definitions for a template.
* @public */ Sheets?: SheetDefinition[] | undefined; /** *An array of tooltip sheet definitions for a template.
* @public */ TooltipSheets?: TooltipSheetDefinition[] | undefined; /** *An array of calculated field definitions for the template.
* @public */ CalculatedFields?: CalculatedField[] | undefined; /** *An array of parameter declarations for a template.
** Parameters are named variables that can transfer a value for use by an action or an object.
*For more information, see Parameters in Amazon Quick Sight in the * Amazon Quick Suite User Guide. *
* @public */ ParameterDeclarations?: ParameterDeclaration[] | undefined; /** *Filter definitions for a template.
*For more information, see Filtering Data in the Amazon Quick Suite User Guide. *
* @public */ FilterGroups?: FilterGroup[] | undefined; /** *An array of template-level column * configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
* @public */ ColumnConfigurations?: ColumnConfiguration[] | undefined; /** *The configuration for default analysis settings.
* @public */ AnalysisDefaults?: AnalysisDefaults | undefined; /** *An array of option definitions for a template.
* @public */ Options?: AssetOptions | undefined; /** *A structure that describes the query execution options.
* @public */ QueryExecutionOptions?: QueryExecutionOptions | undefined; /** *The static files for the definition.
* @public */ StaticFiles?: StaticFile[] | undefined; } /** *The source analysis of the template.
* @public */ export interface TemplateSourceAnalysis { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn: string | undefined; /** *A structure containing information about the dataset references used as placeholders * in the template.
* @public */ DataSetReferences: DataSetReference[] | undefined; } /** *The source template of the template.
* @public */ export interface TemplateSourceTemplate { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn: string | undefined; } /** *The source entity of the template.
* @public */ export interface TemplateSourceEntity { /** *The source analysis, if it is based on an analysis.
* @public */ SourceAnalysis?: TemplateSourceAnalysis | undefined; /** *The source template, if it is based on an template.
* @public */ SourceTemplate?: TemplateSourceTemplate | undefined; } /** * @public */ export interface CreateTemplateRequest { /** *The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in * each Amazon Web Services account.
* @public */ TemplateId: string | undefined; /** *A display name for the template.
* @public */ Name?: string | undefined; /** *A list of resource permissions to be set on the template.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The entity that you are using as a source when you create the template. In
* SourceEntity, you specify the type of object you're using as source:
* SourceTemplate for a template or SourceAnalysis for an
* analysis. Both of these require an Amazon Resource Name (ARN). For
* SourceTemplate, specify the ARN of the source template. For
* SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate
* ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate or
* SourceAnalysis to list the replacement datasets for the placeholders listed
* in the original. The schema in each dataset must match its placeholder.
Either a SourceEntity or a Definition must be provided in
* order for the request to be valid.
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
* @public */ Tags?: Tag[] | undefined; /** *A description of the current template version being created. This API operation creates the
* first version of the template. Every time UpdateTemplate is called, a new
* version is created. Each version of the template maintains a description of the version
* in the VersionDescription field.
The definition of a template.
*A definition is the data model of all features in a Dashboard, Template, or Analysis.
*Either a SourceEntity or a Definition must be provided in
* order for the request to be valid.
TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.
* @public */ ValidationStrategy?: ValidationStrategy | undefined; } /** * @public */ export interface CreateTemplateResponse { /** *The ARN for the template.
* @public */ Arn?: string | undefined; /** *The ARN for the template, including the version information of * the first version.
* @public */ VersionArn?: string | undefined; /** *The ID of the template.
* @public */ TemplateId?: string | undefined; /** *The template creation status.
* @public */ CreationStatus?: ResourceStatus | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface CreateTemplateAliasRequest { /** *The ID of the Amazon Web Services account that contains the template that you creating an alias for.
* @public */ AwsAccountId: string | undefined; /** *An ID for the template.
* @public */ TemplateId: string | undefined; /** *The name that you want to give to the template alias that you're creating. Don't start the
* alias name with the $ character. Alias names that start with $
* are reserved by Quick Sight.
The version number of the template.
* @public */ TemplateVersionNumber: number | undefined; } /** *The template alias.
* @public */ export interface TemplateAlias { /** *The display name of the template alias.
* @public */ AliasName?: string | undefined; /** *The Amazon Resource Name (ARN) of the template alias.
* @public */ Arn?: string | undefined; /** *The version number of the template alias.
* @public */ TemplateVersionNumber?: number | undefined; } /** * @public */ export interface CreateTemplateAliasResponse { /** *Information about the template alias.
* @public */ TemplateAlias?: TemplateAlias | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *The theme colors that are used for data colors in charts. The colors description is a
* hexadecimal color code that consists of six alphanumerical characters, prefixed with
* #, for example #37BFF5.
The hexadecimal codes for the colors.
* @public */ Colors?: string[] | undefined; /** *The minimum and maximum hexadecimal codes that describe a color gradient.
* @public */ MinMaxGradient?: string[] | undefined; /** *The hexadecimal code of a color that applies to charts where a lack of data is * highlighted.
* @public */ EmptyFillColor?: string | undefined; } /** *The background configuration for sheets.
* @public */ export interface SheetBackgroundStyle { /** *The solid color background option for sheets.
* @public */ Color?: string | undefined; /** *The gradient background option for sheets.
* @public */ Gradient?: string | undefined; } /** *Display options related to tiles on a sheet.
* @public */ export interface TileStyle { /** *The background color of a tile.
* @public */ BackgroundColor?: string | undefined; /** *The border around a tile.
* @public */ Border?: BorderStyle | undefined; /** *The border radius of a tile.
* @public */ BorderRadius?: string | undefined; /** *The padding of a tile.
* @public */ Padding?: string | undefined; } /** *The display options for gutter spacing between tiles on a sheet.
* @public */ export interface GutterStyle { /** *This Boolean value controls whether to display a gutter space between sheet tiles. *
* @public */ Show?: boolean | undefined; } /** *The display options for margins around the outside edge of sheets.
* @public */ export interface MarginStyle { /** *This Boolean value controls whether to display sheet margins.
* @public */ Show?: boolean | undefined; } /** *The display options for the layout of tiles on a sheet.
* @public */ export interface TileLayoutStyle { /** *The gutter settings that apply between tiles.
* @public */ Gutter?: GutterStyle | undefined; /** *The margin settings that apply around the outside edge of sheets.
* @public */ Margin?: MarginStyle | undefined; } /** *The theme display options for sheets.
* @public */ export interface SheetStyle { /** *The display options for tiles.
* @public */ Tile?: TileStyle | undefined; /** *The layout options for tiles.
* @public */ TileLayout?: TileLayoutStyle | undefined; /** *The background for sheets.
* @public */ Background?: SheetBackgroundStyle | undefined; } /** *Determines the font settings.
* @public */ export interface Font { /** *Determines the font family settings.
* @public */ FontFamily?: string | undefined; } /** *Configures the display properties of the visual sub-title.
* @public */ export interface VisualSubtitleFontConfiguration { /** *Configures the display properties of the given text.
* @public */ FontConfiguration?: FontConfiguration | undefined; /** *Determines the alignment of visual sub-title.
* @public */ TextAlignment?: HorizontalTextAlignment | undefined; /** *Determines the text transformation of visual sub-title.
* @public */ TextTransform?: TextTransform | undefined; } /** *Configures the display properties of the visual title.
* @public */ export interface VisualTitleFontConfiguration { /** *Configures the display properties of the given text.
* @public */ FontConfiguration?: FontConfiguration | undefined; /** *Determines the alignment of visual title.
* @public */ TextAlignment?: HorizontalTextAlignment | undefined; /** *Determines the text transformation of visual title.
* @public */ TextTransform?: TextTransform | undefined; } /** *Determines the typography options.
* @public */ export interface Typography { /** *Determines the list of font families.
* @public */ FontFamilies?: Font[] | undefined; /** *Configures the display properties of the given text.
* @public */ AxisTitleFontConfiguration?: FontConfiguration | undefined; /** *Configures the display properties of the given text.
* @public */ AxisLabelFontConfiguration?: FontConfiguration | undefined; /** *Configures the display properties of the given text.
* @public */ LegendTitleFontConfiguration?: FontConfiguration | undefined; /** *Configures the display properties of the given text.
* @public */ LegendValueFontConfiguration?: FontConfiguration | undefined; /** *Configures the display properties of the given text.
* @public */ DataLabelFontConfiguration?: FontConfiguration | undefined; /** *Configures the display properties of the visual title.
* @public */ VisualTitleFontConfiguration?: VisualTitleFontConfiguration | undefined; /** *Configures the display properties of the visual sub-title.
* @public */ VisualSubtitleFontConfiguration?: VisualSubtitleFontConfiguration | undefined; } /** *The theme colors that apply to UI and to charts, excluding data colors. The colors
* description is a hexadecimal color code that consists of six alphanumerical characters,
* prefixed with #, for example #37BFF5. For more information, see Using Themes in Quick Sight in the Quick Sight User
* Guide.
*
The color of text and other foreground elements that appear over the primary * background regions, such as grid lines, borders, table banding, icons, and so on.
* @public */ PrimaryForeground?: string | undefined; /** *The background color that applies to visuals and other high emphasis UI.
* @public */ PrimaryBackground?: string | undefined; /** *The foreground color that applies to any sheet title, sheet control text, or UI that * appears over the secondary background.
* @public */ SecondaryForeground?: string | undefined; /** *The background color that applies to the sheet background and sheet controls.
* @public */ SecondaryBackground?: string | undefined; /** *This color is that applies to selected states and buttons.
* @public */ Accent?: string | undefined; /** *The foreground color that applies to any text or other elements that appear over the * accent color.
* @public */ AccentForeground?: string | undefined; /** *The color that applies to error messages.
* @public */ Danger?: string | undefined; /** *The foreground color that applies to any text or other elements that appear over the * error color.
* @public */ DangerForeground?: string | undefined; /** *This color that applies to warning and informational messages.
* @public */ Warning?: string | undefined; /** *The foreground color that applies to any text or other elements that appear over the * warning color.
* @public */ WarningForeground?: string | undefined; /** *The color that applies to success messages, for example the check mark for a * successful download.
* @public */ Success?: string | undefined; /** *The foreground color that applies to any text or other elements that appear over the * success color.
* @public */ SuccessForeground?: string | undefined; /** *The color that applies to the names of fields that are identified as * dimensions.
* @public */ Dimension?: string | undefined; /** *The foreground color that applies to any text or other elements that appear over the * dimension color.
* @public */ DimensionForeground?: string | undefined; /** *The color that applies to the names of fields that are identified as measures.
* @public */ Measure?: string | undefined; /** *The foreground color that applies to any text or other elements that appear over the * measure color.
* @public */ MeasureForeground?: string | undefined; } /** *The theme configuration. This configuration contains all of the display properties for * a theme.
* @public */ export interface ThemeConfiguration { /** *Color properties that apply to chart data colors.
* @public */ DataColorPalette?: DataColorPalette | undefined; /** *Color properties that apply to the UI and to charts, excluding the colors that apply * to data.
* @public */ UIColorPalette?: UIColorPalette | undefined; /** *Display options related to sheets.
* @public */ Sheet?: SheetStyle | undefined; /** *Determines the typography options.
* @public */ Typography?: Typography | undefined; } /** * @public */ export interface CreateThemeRequest { /** *The ID of the Amazon Web Services account where you want to store the new theme.
* @public */ AwsAccountId: string | undefined; /** *An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in * each Amazon Web Services account.
* @public */ ThemeId: string | undefined; /** *A display name for the theme.
* @public */ Name: string | undefined; /** *The ID of the theme that a custom theme will inherit from. All themes inherit from one of
* the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use
* ListThemes or choose Themes from
* within an analysis.
A description of the first version of the theme that you're creating. Every time
* UpdateTheme is called, a new version is created. Each version of the
* theme has a description of the version in the VersionDescription
* field.
The theme configuration, which contains the theme display properties.
* @public */ Configuration: ThemeConfiguration | undefined; /** *A valid grouping of resource permissions to apply to the new theme. *
* @public */ Permissions?: ResourcePermission[] | undefined; /** *A map of the key-value pairs for the resource tag or tags that you want to add to the * resource.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateThemeResponse { /** *The Amazon Resource Name (ARN) for the theme.
* @public */ Arn?: string | undefined; /** *The Amazon Resource Name (ARN) for the new theme.
* @public */ VersionArn?: string | undefined; /** *The ID of the theme.
* @public */ ThemeId?: string | undefined; /** *The theme creation status.
* @public */ CreationStatus?: ResourceStatus | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface CreateThemeAliasRequest { /** *The ID of the Amazon Web Services account that contains the theme for the new theme alias.
* @public */ AwsAccountId: string | undefined; /** *An ID for the theme alias.
* @public */ ThemeId: string | undefined; /** *The name that you want to give to the theme alias that you are creating. The
* alias name can't begin with a $. Alias names that start with $
* are reserved by Amazon Quick Sight.
The version number of the theme.
* @public */ ThemeVersionNumber: number | undefined; } /** *An alias for a theme.
* @public */ export interface ThemeAlias { /** *The Amazon Resource Name (ARN) of the theme alias.
* @public */ Arn?: string | undefined; /** *The display name of the theme alias.
* @public */ AliasName?: string | undefined; /** *The version number of the theme alias.
* @public */ ThemeVersionNumber?: number | undefined; } /** * @public */ export interface CreateThemeAliasResponse { /** *Information about the theme alias.
* @public */ ThemeAlias?: ThemeAlias | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *Instructions that provide additional guidance and context for response generation.
* @public */ export interface CustomInstructions { /** *A text field for providing additional guidance or context for response generation.
* @public */ CustomInstructionsString: string | undefined; } /** *Configuration options for a Topic.
Enables Amazon Q Business Insights for a Topic.
A structure that represents a default formatting definition.
* @public */ export interface DefaultFormatting { /** *The display format. Valid values for this structure are AUTO,
* PERCENT, CURRENCY, NUMBER, DATE, and
* STRING.
The additional options for display formatting.
* @public */ DisplayFormatOptions?: DisplayFormatOptions | undefined; } /** *A structure that represents a semantic type.
* @public */ export interface SemanticType { /** *The semantic type name.
* @public */ TypeName?: string | undefined; /** *The semantic type sub type name.
* @public */ SubTypeName?: string | undefined; /** *The semantic type parameters.
* @public */ TypeParameters?: RecordThe semantic type truthy cell value.
* @public */ TruthyCellValue?: string | undefined; /** *The other names or aliases for the true cell value.
* @public */ TruthyCellValueSynonyms?: string[] | undefined; /** *The semantic type falsey cell value.
* @public */ FalseyCellValue?: string | undefined; /** *The other names or aliases for the false cell value.
* @public */ FalseyCellValueSynonyms?: string[] | undefined; } /** *A structure that represents a calculated field.
* @public */ export interface TopicCalculatedField { /** *The calculated field name.
* @public */ CalculatedFieldName: string | undefined; /** *The calculated field description.
* @public */ CalculatedFieldDescription?: string | undefined; /** *The calculated field expression.
* @public */ Expression: string | undefined; /** *The other names or aliases for the calculated field.
* @public */ CalculatedFieldSynonyms?: string[] | undefined; /** *A boolean value that indicates if a calculated field is included in the topic.
* @public */ IsIncludedInTopic?: boolean | undefined; /** *A Boolean value that indicates if a calculated field is visible in the autocomplete.
* @public */ DisableIndexing?: boolean | undefined; /** *The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
The level of time precision that is used to aggregate DateTime values.
The default formatting definition.
* @public */ DefaultFormatting?: DefaultFormatting | undefined; /** *The default aggregation. Valid values for this structure are SUM,
* MAX, MIN, COUNT,
* DISTINCT_COUNT,
* and AVERAGE.
The order in which data is displayed for the calculated field when * it's used in a comparative context.
* @public */ ComparativeOrder?: ComparativeOrder | undefined; /** *The semantic type.
* @public */ SemanticType?: SemanticType | undefined; /** *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.
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.
A Boolean value that indicates whether to never aggregate calculated field in filters.
* @public */ NeverAggregateInFilter?: boolean | undefined; /** *The other * names or aliases for the calculated field cell value.
* @public */ CellValueSynonyms?: CellValueSynonym[] | undefined; /** *The non additive for the table style target.
* @public */ NonAdditive?: boolean | undefined; } /** *Represents a column in a dataset.
* @public */ export interface TopicColumn { /** *The name of the column.
* @public */ ColumnName: string | undefined; /** *A user-friendly name for the column.
* @public */ ColumnFriendlyName?: string | undefined; /** *A description of the column and its contents.
* @public */ ColumnDescription?: string | undefined; /** *The other names or aliases for the column.
* @public */ ColumnSynonyms?: string[] | undefined; /** *The role of the column in the data. Valid values are DIMENSION and MEASURE.
The type of aggregation that is performed on the column data when * it's queried.
* @public */ Aggregation?: DefaultAggregation | undefined; /** *A Boolean value that indicates whether the column is included in the query results.
* @public */ IsIncludedInTopic?: boolean | undefined; /** *A Boolean value that indicates whether the column shows in the autocomplete functionality.
* @public */ DisableIndexing?: boolean | undefined; /** *The order in which data is displayed for the column when * it's used in a comparative context.
* @public */ ComparativeOrder?: ComparativeOrder | undefined; /** *The semantic type of data contained in the column.
* @public */ SemanticType?: SemanticType | undefined; /** *The level of time precision that is used to aggregate DateTime values.
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.
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.
The default formatting used for values in the column.
* @public */ DefaultFormatting?: DefaultFormatting | undefined; /** *A Boolean * value that indicates whether to aggregate the column data when * it's used in a filter context.
* @public */ NeverAggregateInFilter?: boolean | undefined; /** *The other names or aliases for the column cell value.
* @public */ CellValueSynonyms?: CellValueSynonym[] | undefined; /** *The non additive value for the column.
* @public */ NonAdditive?: boolean | undefined; } /** *A structure that represents a data aggregation.
* @public */ export interface DataAggregation { /** *The level of time precision that is used to aggregate DateTime values.
The column name for the default date.
* @public */ DefaultDateColumnName?: string | undefined; } /** *A constant used in a category filter.
* @public */ export interface TopicCategoryFilterConstant { /** *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.
A singular constant used in a category filter. This element is used to specify a single value for the constant.
* @public */ SingularConstant?: string | undefined; /** *A collective constant used in a category filter. This element is used to specify a list of values for the constant.
* @public */ CollectiveConstant?: CollectiveConstant | undefined; } /** *A structure that represents a category filter.
* @public */ export interface TopicCategoryFilter { /** *The category filter function. Valid values for this structure are EXACT and CONTAINS.
The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
* @public */ CategoryFilterType?: CategoryFilterType | undefined; /** *The constant used in a category filter.
* @public */ Constant?: TopicCategoryFilterConstant | undefined; /** *A Boolean value that indicates if the filter is inverse.
* @public */ Inverse?: boolean | undefined; } /** *A structure that represents a range constant.
* @public */ export interface RangeConstant { /** *The minimum value for a range constant.
* @public */ Minimum?: string | undefined; /** *The maximum value for a range constant.
* @public */ Maximum?: string | undefined; } /** *A constant value that is used in a range filter to specify the endpoints of the range.
* @public */ export interface TopicRangeFilterConstant { /** *The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.
The value of the constant that is used to specify the endpoints of a range filter.
* @public */ RangeConstant?: RangeConstant | undefined; } /** *A filter used to restrict data based on a range of dates or times.
* @public */ export interface TopicDateRangeFilter { /** *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.
* @public */ Inclusive?: boolean | undefined; /** *The constant used in a date range filter.
* @public */ Constant?: TopicRangeFilterConstant | undefined; } /** *A structure that represents a singular filter constant, used in filters to specify a single value to match against.
* @public */ export interface TopicSingularFilterConstant { /** *The type of the singular filter constant. Valid values for this structure are SINGULAR.
The value of the singular filter constant.
* @public */ SingularConstant?: string | undefined; } /** *The structure that represents a null filter.
* @public */ export interface TopicNullFilter { /** *The type of the null filter. Valid values for this type are NULLS_ONLY, NON_NULLS_ONLY, and ALL_VALUES.
A structure that represents a singular filter constant, used in filters to specify a single value to match against.
* @public */ Constant?: TopicSingularFilterConstant | undefined; /** *A Boolean value that indicates if the filter is inverse.
* @public */ Inverse?: boolean | undefined; } /** *A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.
* @public */ export interface TopicNumericEqualityFilter { /** *The constant used in a numeric equality filter.
* @public */ Constant?: TopicSingularFilterConstant | undefined; /** *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.
A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.
* @public */ export interface TopicNumericRangeFilter { /** *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.
* @public */ Inclusive?: boolean | undefined; /** *The constant used in a * numeric range filter.
* @public */ Constant?: TopicRangeFilterConstant | undefined; /** *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.
A structure that represents a relative date filter.
* @public */ export interface TopicRelativeDateFilter { /** *The level of time precision that is used to aggregate DateTime values.
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.
The constant used in a * relative date filter.
* @public */ Constant?: TopicSingularFilterConstant | undefined; } /** *A structure that represents a filter used to select items for a topic.
* @public */ export interface TopicFilter { /** *A description of the filter used to select items for a topic.
* @public */ FilterDescription?: string | undefined; /** *The class of the filter. Valid values for this structure are
* ENFORCED_VALUE_FILTER,
* CONDITIONAL_VALUE_FILTER,
* and NAMED_VALUE_FILTER.
The name of the filter.
* @public */ FilterName: string | undefined; /** *The other names or aliases for the filter.
* @public */ FilterSynonyms?: string[] | undefined; /** *The name of the field that the filter operates on.
* @public */ OperandFieldName: string | undefined; /** *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.
The category filter that is associated with this filter.
* @public */ CategoryFilter?: TopicCategoryFilter | undefined; /** *The numeric equality filter.
* @public */ NumericEqualityFilter?: TopicNumericEqualityFilter | undefined; /** *The numeric range filter.
* @public */ NumericRangeFilter?: TopicNumericRangeFilter | undefined; /** *The date range filter.
* @public */ DateRangeFilter?: TopicDateRangeFilter | undefined; /** *The relative date filter.
* @public */ RelativeDateFilter?: TopicRelativeDateFilter | undefined; /** *The null filter.
* @public */ NullFilter?: TopicNullFilter | undefined; } /** *A structure that represents a metric.
* @public */ export interface NamedEntityDefinitionMetric { /** *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.
The additional parameters for an aggregation function.
* @public */ AggregationFunctionParameters?: RecordA structure that represents a named entity.
* @public */ export interface NamedEntityDefinition { /** *The name of the entity.
* @public */ FieldName?: string | undefined; /** *The property name to be used for the named entity.
* @public */ PropertyName?: string | undefined; /** *The property role. Valid values for this structure are PRIMARY and ID.
The property usage. Valid values for this structure are INHERIT,
* DIMENSION,
* and MEASURE.
The definition of a metric.
* @public */ Metric?: NamedEntityDefinitionMetric | undefined; } /** *A structure that represents a semantic entity type.
* @public */ export interface SemanticEntityType { /** *The semantic entity type name.
* @public */ TypeName?: string | undefined; /** *The semantic entity sub type name.
* @public */ SubTypeName?: string | undefined; /** *The semantic entity type parameters.
* @public */ TypeParameters?: RecordA structure that represents a named entity.
* @public */ export interface TopicNamedEntity { /** *The name of the named entity.
* @public */ EntityName: string | undefined; /** *The description of the named entity.
* @public */ EntityDescription?: string | undefined; /** *The other * names or aliases for the named entity.
* @public */ EntitySynonyms?: string[] | undefined; /** *The type of named entity that a topic represents.
* @public */ SemanticEntityType?: SemanticEntityType | undefined; /** *The definition of a named entity.
* @public */ Definition?: NamedEntityDefinition[] | undefined; } /** *A structure that represents a dataset.
* @public */ export interface DatasetMetadata { /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DatasetArn: string | undefined; /** *The name of the dataset.
* @public */ DatasetName?: string | undefined; /** *The description of the dataset.
* @public */ DatasetDescription?: string | undefined; /** *The definition of a data aggregation.
* @public */ DataAggregation?: DataAggregation | undefined; /** *The list of filter definitions.
* @public */ Filters?: TopicFilter[] | undefined; /** *The list of column definitions.
* @public */ Columns?: TopicColumn[] | undefined; /** *The list of calculated field definitions.
* @public */ CalculatedFields?: TopicCalculatedField[] | undefined; /** *The list of named entities definitions.
* @public */ NamedEntities?: TopicNamedEntity[] | undefined; } /** *A structure that describes the details of a topic, such as its name, description, and associated data sets.
* @public */ export interface TopicDetails { /** *The name of the topic.
* @public */ Name?: string | undefined; /** *The description of the topic.
* @public */ Description?: string | undefined; /** *The user experience version of a topic.
* @public */ UserExperienceVersion?: TopicUserExperienceVersion | undefined; /** *The data sets that the topic is associated with.
* @public */ DataSets?: DatasetMetadata[] | undefined; /** *Configuration options for a Topic.
The ID of the Amazon Web Services account that you want to create a topic in.
* @public */ AwsAccountId: string | undefined; /** *The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; /** *The definition of a topic to create.
* @public */ Topic: TopicDetails | undefined; /** *Contains a map of the key-value pairs for the resource tag or tags that are assigned to * the dataset.
* @public */ Tags?: Tag[] | undefined; /** *The Folder ARN of the folder that you want the topic to reside in.
* @public */ FolderArns?: string[] | undefined; /** *Custom instructions for the topic.
* @public */ CustomInstructions?: CustomInstructions | undefined; } /** * @public */ export interface CreateTopicResponse { /** *The Amazon Resource Name (ARN) of the topic.
* @public */ Arn?: string | undefined; /** *The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region * for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Resource Name (ARN) of the topic refresh.
* @public */ RefreshArn?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *A structure that represents a topic refresh schedule.
* @public */ export interface TopicRefreshSchedule { /** *A Boolean value that controls whether to schedule is enabled.
* @public */ IsEnabled: boolean | undefined; /** *A Boolean value that controls whether to schedule runs at the same schedule that is specified in * SPICE dataset.
* @public */ BasedOnSpiceSchedule: boolean | undefined; /** *The starting date and time for the refresh schedule.
* @public */ StartingAt?: Date | undefined; /** *The timezone that you want the refresh schedule to use.
* @public */ Timezone?: string | undefined; /** *The time of day when the refresh should run, for * example, Monday-Sunday.
* @public */ RepeatAt?: string | undefined; /** *The type of refresh schedule. Valid values for this structure are HOURLY,
* DAILY,
* WEEKLY,
* and MONTHLY.
The ID of the Amazon Web Services account that contains the topic * you're creating a refresh schedule for.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DatasetArn: string | undefined; /** *The name of the dataset.
* @public */ DatasetName?: string | undefined; /** *The definition of a refresh schedule.
* @public */ RefreshSchedule: TopicRefreshSchedule | undefined; } /** * @public */ export interface CreateTopicRefreshScheduleResponse { /** *The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Resource Name (ARN) of the topic.
* @public */ TopicArn?: string | undefined; /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DatasetArn?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface CreateVPCConnectionRequest { /** *The Amazon Web Services account ID of the account where you want to create a new VPC * connection.
* @public */ AwsAccountId: string | undefined; /** *The ID of the VPC connection that * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an * Amazon Web Services account.
* @public */ VPCConnectionId: string | undefined; /** *The display name for the VPC connection.
* @public */ Name: string | undefined; /** *A list of subnet IDs for the VPC connection.
* @public */ SubnetIds: string[] | undefined; /** *A list of security group IDs for the VPC connection.
* @public */ SecurityGroupIds: string[] | undefined; /** *A list of IP addresses of DNS resolver endpoints for the VPC connection.
* @public */ DnsResolvers?: string[] | undefined; /** *The IAM role to associate with the VPC connection.
* @public */ RoleArn: string | undefined; /** *A map of the key-value pairs for the resource tag or tags assigned to the VPC * connection.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateVPCConnectionResponse { /** *The Amazon Resource Name (ARN) of the VPC connection.
* @public */ Arn?: string | undefined; /** *The ID for the VPC connection that * you're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services * account.
* @public */ VPCConnectionId?: string | undefined; /** *The status of the creation of the VPC connection.
* @public */ CreationStatus?: VPCConnectionResourceStatus | undefined; /** *The availability status of the VPC connection.
* @public */ AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *The custom permissions profile.
* @public */ export interface CustomPermissions { /** *The Amazon Resource Name (ARN) of the custom permissions profile.
* @public */ Arn?: string | undefined; /** *The name of the custom permissions profile.
* @public */ CustomPermissionsName?: string | undefined; /** *A set of actions in the custom permissions profile.
* @public */ Capabilities?: Capabilities | undefined; } /** *Dashboard error.
* @public */ export interface DashboardError { /** *Type.
* @public */ Type?: DashboardErrorType | undefined; /** *Message.
* @public */ Message?: string | undefined; /** *Lists the violated entities that caused the dashboard error.
* @public */ ViolatedEntities?: Entity[] | undefined; } /** *Dashboard version.
* @public */ export interface DashboardVersion { /** *The time that this dashboard version was created.
* @public */ CreatedTime?: Date | undefined; /** *Errors associated with this dashboard version.
* @public */ Errors?: DashboardError[] | undefined; /** *Version number for this version of the dashboard.
* @public */ VersionNumber?: number | undefined; /** *The HTTP status of the request.
* @public */ Status?: ResourceStatus | undefined; /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *Source entity ARN.
* @public */ SourceEntityArn?: string | undefined; /** *The Amazon Resource Numbers (ARNs) for the datasets that are associated with this * version of the dashboard.
* @public */ DataSetArns?: string[] | undefined; /** *Description.
* @public */ Description?: string | undefined; /** *The ARN of the theme associated with a version of the dashboard.
* @public */ ThemeArn?: string | undefined; /** *A list of the associated sheets with the unique identifier and name of each sheet.
* @public */ Sheets?: Sheet[] | undefined; } /** *Dashboard.
* @public */ export interface Dashboard { /** *Dashboard ID.
* @public */ DashboardId?: string | undefined; /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *A display name for the dashboard.
* @public */ Name?: string | undefined; /** *Version.
* @public */ Version?: DashboardVersion | undefined; /** *The time that this dashboard was created.
* @public */ CreatedTime?: Date | undefined; /** *The last time that this dashboard was published.
* @public */ LastPublishedTime?: Date | undefined; /** *The last time that this dashboard was updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
* @public */ LinkEntities?: string[] | undefined; } /** *A filter that you apply when searching for dashboards.
* @public */ export interface DashboardSearchFilter { /** *The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.
The name of the value that you want to use as a filter, for example, "Name":
* "QUICKSIGHT_OWNER".
Valid values are defined as follows:
*
* QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered.
* QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.
* DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.
* DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.
The value of the named item, in this case QUICKSIGHT_USER, that you want
* to use as a filter, for example, "Value":
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
Dashboard summary.
* @public */ export interface DashboardSummary { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *Dashboard ID.
* @public */ DashboardId?: string | undefined; /** *A display name for the dashboard.
* @public */ Name?: string | undefined; /** *The time that this dashboard was created.
* @public */ CreatedTime?: Date | undefined; /** *The last time that this dashboard was updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *Published version number.
* @public */ PublishedVersionNumber?: number | undefined; /** *The last time that this dashboard was published.
* @public */ LastPublishedTime?: Date | undefined; } /** *Dashboard version summary.
* @public */ export interface DashboardVersionSummary { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *The time that this dashboard version was created.
* @public */ CreatedTime?: Date | undefined; /** *Version number.
* @public */ VersionNumber?: number | undefined; /** *The HTTP status of the request.
* @public */ Status?: ResourceStatus | undefined; /** *Source entity ARN.
* @public */ SourceEntityArn?: string | undefined; /** *Description.
* @public */ Description?: string | undefined; } /** *The QA result that is made from dashboard visual.
* @public */ export interface DashboardVisualResult { /** *The ID of the dashboard.
* @public */ DashboardId?: string | undefined; /** *The name of the dashboard.
* @public */ DashboardName?: string | undefined; /** *The ID of the sheet.
* @public */ SheetId?: string | undefined; /** *The name of the sheet.
* @public */ SheetName?: string | undefined; /** *The ID of the visual.
* @public */ VisualId?: string | undefined; /** *The title of the visual.
* @public */ VisualTitle?: string | undefined; /** *The subtitle of the visual.
* @public */ VisualSubtitle?: string | undefined; /** *The URL of the dashboard.
* @public */ DashboardUrl?: string | undefined; } /** *Output column.
* @public */ export interface OutputColumn { /** *The display name of the column..
* @public */ Name?: string | undefined; /** *A unique identifier for the output column.
* @public */ Id?: string | undefined; /** *A description for a column.
* @public */ Description?: string | undefined; /** *The data type of the column.
* @public */ Type?: ColumnDataType | undefined; /** *The sub data type of the column.
* @public */ SubType?: ColumnDataSubType | undefined; } /** *Dataset.
* @public */ export interface DataSet { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *The ID of the dataset. Limited to 96 characters.
* @public */ DataSetId?: string | undefined; /** *A display name for the dataset.
* @public */ Name?: string | undefined; /** *The time that this dataset was created.
* @public */ CreatedTime?: Date | undefined; /** *The last time that this dataset was updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *Declares the physical tables that are available in the underlying data sources.
* @public */ PhysicalTableMap?: RecordConfigures the combination and transformation of the data from the physical * tables.
* @public */ LogicalTableMap?: RecordThe list of columns after all transforms. These columns are available in templates, * analyses, and dashboards.
* @public */ OutputColumns?: OutputColumn[] | undefined; /** *A value that indicates whether you want to import the data into SPICE.
* @public */ ImportMode?: DataSetImportMode | undefined; /** *The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't * imported into SPICE.
* @public */ ConsumedSpiceCapacityInBytes?: number | undefined; /** *Groupings of columns that work together in certain Quick Sight features. * Currently, only geospatial hierarchy is supported.
* @public */ ColumnGroups?: ColumnGroup[] | undefined; /** *The folder that contains fields and nested subfolders for your dataset.
* @public */ FieldFolders?: RecordThe row-level security configuration for the dataset.
* @public */ RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** *The element you can use to define tags for row-level security.
* @public */ RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** *A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
The usage configuration to apply to child datasets that reference this dataset as a source.
* @public */ DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** *The parameters that are declared in a dataset.
* @public */ DatasetParameters?: DatasetParameter[] | undefined; /** *The performance optimization configuration of a dataset.
* @public */ PerformanceConfiguration?: PerformanceConfiguration | undefined; /** *The usage of the dataset.
* @public */ UseAs?: DataSetUseAs | undefined; /** *The data preparation configuration associated with this dataset.
* @public */ DataPrepConfiguration?: DataPrepConfiguration | undefined; /** *The semantic model configuration associated with this dataset.
* @public */ SemanticModelConfiguration?: SemanticModelConfiguration | undefined; } /** *A filter that you apply when searching for datasets.
* @public */ export interface DataSetSearchFilter { /** *The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.
The name of the value that you want to use as a filter, for example, "Name":
* "QUICKSIGHT_OWNER".
Valid values are defined as follows:
*
* QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.
* QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.
* DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.
* DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.
The value of the named item, in this case QUICKSIGHT_OWNER, that you want
* to use as a filter, for example, "Value":
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
Dataset summary.
* @public */ export interface DataSetSummary { /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ Arn?: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId?: string | undefined; /** *A display name for the dataset.
* @public */ Name?: string | undefined; /** *The time that this dataset was created.
* @public */ CreatedTime?: Date | undefined; /** *The last time that this dataset was updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *A value that indicates whether you want to import the data into SPICE.
* @public */ ImportMode?: DataSetImportMode | undefined; /** *The row-level security configuration for the dataset in the legacy data preparation experience.
* @public */ RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** *The row-level security configuration for the dataset in the new data preparation experience.
* @public */ RowLevelPermissionDataSetMap?: RecordWhether or not the row level permission tags are applied.
* @public */ RowLevelPermissionTagConfigurationApplied?: boolean | undefined; /** *A value that indicates if the dataset has column level permission configured.
* @public */ ColumnLevelPermissionRulesApplied?: boolean | undefined; /** *The usage of the dataset.
* @public */ UseAs?: DataSetUseAs | undefined; } /** *Error information for the data source creation or update.
* @public */ export interface DataSourceErrorInfo { /** *Error type.
* @public */ Type?: DataSourceErrorInfoType | undefined; /** *Error message.
* @public */ Message?: string | undefined; } /** *The structure of a data source.
* @public */ export interface DataSource { /** *The Amazon Resource Name (ARN) of the data source.
* @public */ Arn?: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId?: string | undefined; /** *A display name for the data source.
* @public */ Name?: string | undefined; /** *The type of the data source. This type indicates which database engine the data source * connects to.
* @public */ Type?: DataSourceType | undefined; /** *The HTTP status of the request.
* @public */ Status?: ResourceStatus | undefined; /** *The time that this data source was created.
* @public */ CreatedTime?: Date | undefined; /** *The last time that this data source was updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The parameters that Quick Sight uses to connect to your underlying source. This * is a variant type structure. For this structure to be valid, only one of the attributes * can be non-null.
* @public */ DataSourceParameters?: DataSourceParameters | undefined; /** *A set of alternate data source parameters that you want to share for the credentials
* stored with this data source. The credentials are applied in tandem with the data source
* parameters when you copy a data source by using a create or update request. The API
* operation compares the DataSourceParameters structure that's in the request
* with the structures in the AlternateDataSourceParameters allow list. If the
* structures are an exact match, the request is allowed to use the credentials from this
* existing data source. If the AlternateDataSourceParameters list is null,
* the Credentials originally used with this DataSourceParameters
* are automatically allowed.
The VPC connection information. You need to use this parameter only when you want * Quick Sight to use a VPC connection when connecting to your underlying source.
* @public */ VpcConnectionProperties?: VpcConnectionProperties | undefined; /** *Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your * underlying source.
* @public */ SslProperties?: SslProperties | undefined; /** *Error information from the last update or the creation of the data source.
* @public */ ErrorInfo?: DataSourceErrorInfo | undefined; /** *The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
* @public */ SecretArn?: string | undefined; } /** *A filter that you apply when searching for data sources.
* @public */ export interface DataSourceSearchFilter { /** *The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.
The name of the value that you want to use as a filter, for example, "Name":
* "DIRECT_QUICKSIGHT_OWNER".
Valid values are defined as follows:
*
* DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.
* DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.
The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want
* to use as a filter, for example, "Value":
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
A DataSourceSummary object that returns a summary of a data source.
The arn of the datasource.
* @public */ Arn?: string | undefined; /** *The unique ID of the data source.
* @public */ DataSourceId?: string | undefined; /** *The name of the data source.
* @public */ Name?: string | undefined; /** *The type of the data source.
* @public */ Type?: DataSourceType | undefined; /** *The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
* @public */ CreatedTime?: Date | undefined; /** *The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
* @public */ LastUpdatedTime?: Date | undefined; } /** * @public */ export interface DeleteAccountCustomizationRequest { /** *The ID for the Amazon Web Services account that you want to delete Quick Sight customizations from.
* @public */ AwsAccountId: string | undefined; /** *The Quick Sight namespace that you're deleting the customizations from.
* @public */ Namespace?: string | undefined; } /** * @public */ export interface DeleteAccountCustomizationResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteAccountCustomPermissionRequest { /** *The ID of the Amazon Web Services account from which you want to unapply the custom permissions profile.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DeleteAccountCustomPermissionResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteAccountSubscriptionRequest { /** *The Amazon Web Services account ID of the account that you want to delete.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DeleteAccountSubscriptionResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteActionConnectorRequest { /** *The Amazon Web Services account ID that contains the action connector to delete.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier of the action connector to delete.
* @public */ ActionConnectorId: string | undefined; } /** * @public */ export interface DeleteActionConnectorResponse { /** *The Amazon Resource Name (ARN) of the deleted action connector.
* @public */ Arn?: string | undefined; /** *The unique identifier of the deleted action connector.
* @public */ ActionConnectorId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status code of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteAnalysisRequest { /** *The ID of the Amazon Web Services account where you want to delete an analysis.
* @public */ AwsAccountId: string | undefined; /** *The ID of the analysis that you're deleting.
* @public */ AnalysisId: string | undefined; /** *A value that specifies the number of days that Amazon Quick Sight waits before it deletes the
* analysis. You can't use this parameter with the ForceDeleteWithoutRecovery
* option in the same API call. The default value is 30.
This option defaults to the value NoForceDeleteWithoutRecovery. To
* immediately delete the analysis, add the ForceDeleteWithoutRecovery option.
* You can't restore an analysis after it's deleted.
The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Resource Name (ARN) of the deleted analysis.
* @public */ Arn?: string | undefined; /** *The ID of the deleted analysis.
* @public */ AnalysisId?: string | undefined; /** *The date and time that the analysis is scheduled to be deleted.
* @public */ DeletionTime?: Date | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteBrandRequest { /** *The ID of the Amazon Web Services account that owns the brand.
* @public */ AwsAccountId: string | undefined; /** *The ID of the Quick brand.
* @public */ BrandId: string | undefined; } /** * @public */ export interface DeleteBrandResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteBrandAssignmentRequest { /** *The ID of the Amazon Web Services account that owns the brand assignment.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DeleteBrandAssignmentResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteCustomPermissionsRequest { /** *The ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.
* @public */ AwsAccountId: string | undefined; /** *The name of the custom permissions profile that you want to delete.
* @public */ CustomPermissionsName: string | undefined; } /** * @public */ export interface DeleteCustomPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Resource Name (ARN) of the custom permissions profile.
* @public */ Arn?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteDashboardRequest { /** *The ID of the Amazon Web Services account that contains the dashboard that you're * deleting.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dashboard.
* @public */ DashboardId: string | undefined; /** *The version number of the dashboard. If the version number property is provided, only * the specified version of the dashboard is deleted.
* @public */ VersionNumber?: number | undefined; } /** * @public */ export interface DeleteDashboardResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Secure Socket Layer (SSL) properties that apply for the resource.
* @public */ Arn?: string | undefined; /** *The ID of the dashboard.
* @public */ DashboardId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteDataSetRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dataset that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DeleteDataSetResponse { /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ Arn?: string | undefined; /** *The ID for the dataset that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteDataSetRefreshPropertiesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DeleteDataSetRefreshPropertiesResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteDataSourceRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId: string | undefined; } /** * @public */ export interface DeleteDataSourceResponse { /** *The Amazon Resource Name (ARN) of the data source that you deleted.
* @public */ Arn?: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteDefaultQBusinessApplicationRequest { /** *The ID of the Quick Sight account that you want to disconnect from a Amazon Q Business application.
* @public */ AwsAccountId: string | undefined; /** *The Quick Sight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.
* @public */ Namespace?: string | undefined; } /** * @public */ export interface DeleteDefaultQBusinessApplicationResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteFolderRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; } /** * @public */ export interface DeleteFolderResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Resource Name of the deleted folder.
* @public */ Arn?: string | undefined; /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteFolderMembershipRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The Folder ID.
* @public */ FolderId: string | undefined; /** *The ID of the asset that you want to delete.
* @public */ MemberId: string | undefined; /** *The member type of the asset that you want to delete from a folder.
* @public */ MemberType: MemberType | undefined; } /** * @public */ export interface DeleteFolderMembershipResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteGroupRequest { /** *The name of the group that you want to delete.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace of the group that you want to delete.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteGroupResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteGroupMembershipRequest { /** *The name of the user that you want to delete from the group membership.
* @public */ MemberName: string | undefined; /** *The name of the group that you want to delete the user from.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace of the group that you want to remove a user from.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteGroupMembershipResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteIAMPolicyAssignmentRequest { /** *The Amazon Web Services account ID where you want to delete the IAM * policy assignment.
* @public */ AwsAccountId: string | undefined; /** *The name of the assignment.
* @public */ AssignmentName: string | undefined; /** *The namespace that contains the assignment.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteIAMPolicyAssignmentResponse { /** *The name of the assignment.
* @public */ AssignmentName?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteIdentityPropagationConfigRequest { /** *The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.
* @public */ AwsAccountId: string | undefined; /** *The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.
* @public */ Service: ServiceType | undefined; } /** * @public */ export interface DeleteIdentityPropagationConfigResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteNamespaceRequest { /** *The ID for the Amazon Web Services account that you want to delete the Quick Sight namespace from.
* @public */ AwsAccountId: string | undefined; /** *The namespace that you want to delete.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteNamespaceResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteRefreshScheduleRequest { /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the refresh schedule.
* @public */ ScheduleId: string | undefined; } /** * @public */ export interface DeleteRefreshScheduleResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The ID of the refresh schedule.
* @public */ ScheduleId?: string | undefined; /** *The Amazon Resource Name (ARN) for the refresh schedule.
* @public */ Arn?: string | undefined; } /** * @public */ export interface DeleteRoleCustomPermissionRequest { /** *The role that you want to remove permissions from.
* @public */ Role: Role | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that includes the role.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteRoleCustomPermissionResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteRoleMembershipRequest { /** *The name of the group.
* @public */ MemberName: string | undefined; /** *The role that you want to remove permissions from.
* @public */ Role: Role | undefined; /** *The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that contains the role.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteRoleMembershipResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteTemplateRequest { /** *The ID of the Amazon Web Services account that contains the template that you're deleting.
* @public */ AwsAccountId: string | undefined; /** *An ID for the template you want to delete.
* @public */ TemplateId: string | undefined; /** *Specifies the version of the template that you want to delete.
* If you don't provide a version number, DeleteTemplate deletes all versions of the template.
*
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *An ID for the template.
* @public */ TemplateId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteTemplateAliasRequest { /** *The ID of the Amazon Web Services account that contains the item to delete.
* @public */ AwsAccountId: string | undefined; /** *The ID for the template that the specified alias is for.
* @public */ TemplateId: string | undefined; /** *The name for the template alias. To delete a specific alias, you delete the version that the
* alias points to. You can specify the alias name, or specify the latest version of the
* template by providing the keyword $LATEST in the AliasName
* parameter.
The HTTP status of the request.
* @public */ Status?: number | undefined; /** *An ID for the template associated with the deletion.
* @public */ TemplateId?: string | undefined; /** *The name for the template alias.
* @public */ AliasName?: string | undefined; /** *The Amazon Resource Name (ARN) of the template you want to delete.
* @public */ Arn?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteThemeRequest { /** *The ID of the Amazon Web Services account that contains the theme that you're deleting.
* @public */ AwsAccountId: string | undefined; /** *An ID for the theme that you want to delete.
* @public */ ThemeId: string | undefined; /** *The version of the theme that you want to delete.
*
* Note: If you don't provide a version number, you're
* using this call to DeleteTheme to delete all versions of the theme.
The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *An ID for the theme.
* @public */ ThemeId?: string | undefined; } /** * @public */ export interface DeleteThemeAliasRequest { /** *The ID of the Amazon Web Services account that contains the theme alias to delete.
* @public */ AwsAccountId: string | undefined; /** *The ID for the theme that the specified alias is for.
* @public */ ThemeId: string | undefined; /** *The unique name for the theme alias to delete.
* @public */ AliasName: string | undefined; } /** * @public */ export interface DeleteThemeAliasResponse { /** *The name for the theme alias.
* @public */ AliasName?: string | undefined; /** *The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
* @public */ Arn?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *An ID for the theme associated with the deletion.
* @public */ ThemeId?: string | undefined; } /** * @public */ export interface DeleteTopicRequest { /** *The ID of the Amazon Web Services account that contains the topic that you want to * delete.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; } /** * @public */ export interface DeleteTopicResponse { /** *The Amazon Resource Name (ARN) of the topic.
* @public */ Arn?: string | undefined; /** *The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteTopicRefreshScheduleRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; /** *The ID of the dataset.
* @public */ DatasetId: string | undefined; } /** * @public */ export interface DeleteTopicRefreshScheduleResponse { /** *The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Resource Name (ARN) of the topic.
* @public */ TopicArn?: string | undefined; /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DatasetArn?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DeleteUserRequest { /** *The name of the user that you want to delete.
* @public */ UserName: string | undefined; /** *The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace. Currently, you should set this to default.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * * @public */ export interface DeleteUserByPrincipalIdRequest { /** *The principal ID of the user.
* @public */ PrincipalId: string | undefined; /** *The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace. Currently, you should set this to default.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteUserCustomPermissionRequest { /** *The username of the user that you want to remove custom permissions from.
* @public */ UserName: string | undefined; /** *The ID of the Amazon Web Services account that contains the custom permission configuration that you want to delete.
* @public */ AwsAccountId: string | undefined; /** *The namespace that the user belongs to.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DeleteUserCustomPermissionResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DeleteVPCConnectionRequest { /** *The Amazon Web Services account ID of the account where you want to delete a VPC * connection.
* @public */ AwsAccountId: string | undefined; /** *The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an * Amazon Web Services account.
* @public */ VPCConnectionId: string | undefined; } /** * @public */ export interface DeleteVPCConnectionResponse { /** *The Amazon Resource Name (ARN) of the deleted VPC connection.
* @public */ Arn?: string | undefined; /** *The ID of the VPC connection that * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an * Amazon Web Services account.
* @public */ VPCConnectionId?: string | undefined; /** *The deletion status of the VPC connection.
* @public */ DeletionStatus?: VPCConnectionResourceStatus | undefined; /** *The availability status of the VPC connection.
* @public */ AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeAccountCustomizationRequest { /** *The ID for the Amazon Web Services account that you want to describe Quick Sight customizations * for.
* @public */ AwsAccountId: string | undefined; /** *The Quick Sight namespace that you want to describe Quick Sight customizations * for.
* @public */ Namespace?: string | undefined; /** *The Resolved flag works with the other parameters to determine which view
* of Quick Sight customizations is returned. You can add this flag to your command to use
* the same view that Quick Sight uses to identify which customizations to apply to the
* console. Omit this flag, or set it to no-resolved, to reveal customizations
* that are configured at different levels.
The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.
* @public */ Arn?: string | undefined; /** *The ID for the Amazon Web Services account that you're describing.
* @public */ AwsAccountId?: string | undefined; /** *The Quick Sight namespace that you're describing.
* @public */ Namespace?: string | undefined; /** *The Quick Sight customizations that exist.
* @public */ AccountCustomization?: AccountCustomization | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeAccountCustomPermissionRequest { /** *The ID of the Amazon Web Services account for which you want to describe the applied custom permissions profile.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeAccountCustomPermissionResponse { /** *The name of the custom permissions profile.
* @public */ CustomPermissionsName?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeAccountSettingsRequest { /** *The ID for the Amazon Web Services account that contains the settings that you want to list.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeAccountSettingsResponse { /** *The Amazon Quick Sight settings for this Amazon Web Services account. This information * includes the edition of Amazon Quick Sight that you subscribed to (Standard or * Enterprise) and the notification email for the Amazon Quick Sight subscription.
*In the Quick Sight console, the Amazon Quick Sight subscription is sometimes referred to * as a Quick Sight "account" even though it's technically not an account by * itself. Instead, it's a subscription to the Amazon Quick Sight service for your * Amazon Web Services account. The edition that you subscribe to applies to Quick in every Amazon Web Services Region where you use it.
* @public */ AccountSettings?: AccountSettings | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeAccountSubscriptionRequest { /** *The Amazon Web Services account ID associated with your Quick Sight account.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeAccountSubscriptionResponse { /** *A structure that contains the following elements:
*Your Quick Sight account name.
*The edition of Quick Sight that your account is using.
*The notification email address that is associated with the Amazon Quick Sight * account. *
*The authentication type of the Quick Sight account.
*The status of the Quick Sight account's subscription.
*The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeActionConnectorRequest { /** *The Amazon Web Services account ID that contains the action connector.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier of the action connector to describe.
* @public */ ActionConnectorId: string | undefined; } /** * @public */ export interface DescribeActionConnectorResponse { /** *The detailed information about the action connector, including its configuration and current state.
* @public */ ActionConnector?: ActionConnector | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status code of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeActionConnectorPermissionsRequest { /** *The Amazon Web Services account ID that contains the action connector.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier of the action connector whose permissions you want to describe.
* @public */ ActionConnectorId: string | undefined; } /** * @public */ export interface DescribeActionConnectorPermissionsResponse { /** *The Amazon Resource Name (ARN) of the action connector.
* @public */ Arn?: string | undefined; /** *The unique identifier of the action connector.
* @public */ ActionConnectorId?: string | undefined; /** *The list of permissions associated with the action connector, including the principals and their allowed actions.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status code of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeAnalysisRequest { /** *The ID of the Amazon Web Services account that contains the analysis. You must be using the * Amazon Web Services account that the analysis is in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the analysis that you're describing. The ID is part of the URL of the * analysis.
* @public */ AnalysisId: string | undefined; } /** * @public */ export interface DescribeAnalysisResponse { /** *A metadata structure that contains summary information for the analysis that you're * describing.
* @public */ Analysis?: Analysis | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeAnalysisDefinitionRequest { /** *The ID of the Amazon Web Services account that contains the analysis. You must be using the * Amazon Web Services account that the analysis is in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the analysis that you're describing. The ID is part of the URL of the * analysis.
* @public */ AnalysisId: string | undefined; } /** * @public */ export interface DescribeAnalysisDefinitionResponse { /** *The ID of the analysis described.
* @public */ AnalysisId?: string | undefined; /** *The descriptive name of the analysis.
* @public */ Name?: string | undefined; /** *Errors associated with the analysis.
* @public */ Errors?: AnalysisError[] | undefined; /** *Status associated with the analysis.
*
* CREATION_IN_PROGRESS
*
* CREATION_SUCCESSFUL
*
* CREATION_FAILED
*
* UPDATE_IN_PROGRESS
*
* UPDATE_SUCCESSFUL
*
* UPDATE_FAILED
*
* DELETED
*
The ARN of the theme of the analysis.
* @public */ ThemeArn?: string | undefined; /** *The definition of an analysis.
*A definition is the data model of all features in a Dashboard, Template, or Analysis.
* @public */ Definition?: AnalysisDefinition | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeAnalysisPermissionsRequest { /** *The ID of the Amazon Web Services account that contains the analysis whose permissions you're * describing. You must be using the Amazon Web Services account that the analysis is in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the analysis whose permissions you're describing. The ID is part of the * analysis URL.
* @public */ AnalysisId: string | undefined; } /** * @public */ export interface DescribeAnalysisPermissionsResponse { /** *The ID of the analysis whose permissions you're describing.
* @public */ AnalysisId?: string | undefined; /** *The Amazon Resource Name (ARN) of the analysis whose permissions you're * describing.
* @public */ AnalysisArn?: string | undefined; /** *A structure that describes the principals and the resource-level permissions on an * analysis.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeAssetBundleExportJobRequest { /** *The ID of the Amazon Web Services account the export job is executed in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the job that you want described. The job ID is set when you start a new job
* with a StartAssetBundleExportJob API call.
Indicates the status of a job through its queuing and execution.
*Poll this DescribeAssetBundleExportApi until JobStatus is
* either SUCCESSFUL or FAILED.
The URL to download the exported asset bundle data from.
*This URL is available only after the job has succeeded. This URL is valid for 5 minutes
* after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if
* needed.
The downloaded asset bundle is a zip file named assetbundle-\{jobId\}.qs. The
* file has a .qs extension.
This URL can't be used in a StartAssetBundleImportJob API call and
* should only be used for download purposes.
An array of error records that describes any failures that occurred during the export * job processing.
*Error records accumulate while the job runs. The complete set of error records is * available after the job has completed and failed.
* @public */ Errors?: AssetBundleExportJobError[] | undefined; /** *The Amazon Resource Name (ARN) for the export job.
* @public */ Arn?: string | undefined; /** *The time that the export job was created.
* @public */ CreatedTime?: Date | undefined; /** *The ID of the job. The job ID is set when you start a new job with a
* StartAssetBundleExportJob API call.
The ID of the Amazon Web Services account that the export job was executed in.
* @public */ AwsAccountId?: string | undefined; /** *A list of resource ARNs that exported with the job.
* @public */ ResourceArns?: string[] | undefined; /** *The include dependencies flag.
* @public */ IncludeAllDependencies?: boolean | undefined; /** *The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file
* can be used to make a StartAssetBundleImportJob API call. A
* CLOUDFORMATION_JSON formatted file can be used in the CloudFormation
* console and with the CloudFormation APIs.
The CloudFormation override property configuration for the export job.
* @public */ CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the response.
* @public */ Status?: number | undefined; /** *The include permissions flag.
* @public */ IncludePermissions?: boolean | undefined; /** *The include tags flag.
* @public */ IncludeTags?: boolean | undefined; /** *The validation strategy that is used to export the analysis or dashboard.
* @public */ ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined; /** *An array of warning records that describe the analysis or dashboard that is exported. * This array includes UI errors that can be skipped during the validation process.
*This property only appears if StrictModeForAllResources in
* ValidationStrategy is set to FALSE.
The include folder memberships flag.
* @public */ IncludeFolderMemberships?: boolean | undefined; /** *A setting that determines whether folder members are included.
* @public */ IncludeFolderMembers?: IncludeFolderMembers | undefined; } /** * @public */ export interface DescribeAssetBundleImportJobRequest { /** *The ID of the Amazon Web Services account the import job was executed in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the job. The job ID is set when you start a new job with a
* StartAssetBundleImportJob API call.
Indicates the status of a job through its queuing and execution.
*Poll the DescribeAssetBundleImport API until JobStatus returns
* one of the following values:
* SUCCESSFUL
*
* FAILED
*
* FAILED_ROLLBACK_COMPLETED
*
* FAILED_ROLLBACK_ERROR
*
An array of error records that describes any failures that occurred during the export * job processing.
*Error records accumulate while the job is still running. The complete set of error * records is available after the job has completed and failed.
* @public */ Errors?: AssetBundleImportJobError[] | undefined; /** *An array of error records that describes any failures that occurred while an import job * was attempting a rollback.
*Error records accumulate while the job is still running. The complete set of error * records is available after the job has completed and failed.
* @public */ RollbackErrors?: AssetBundleImportJobError[] | undefined; /** *The Amazon Resource Name (ARN) for the import job.
* @public */ Arn?: string | undefined; /** *The time that the import job was created.
* @public */ CreatedTime?: Date | undefined; /** *The ID of the job. The job ID is set when you start a new job with a
* StartAssetBundleImportJob API call.
The ID of the Amazon Web Services account the import job was executed in.
* @public */ AwsAccountId?: string | undefined; /** *The source of the asset bundle zip file that contains the data that is imported by the * job.
* @public */ AssetBundleImportSource?: AssetBundleImportSourceDescription | undefined; /** *Optional overrides that are applied to the resource configuration before import.
* @public */ OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; /** *The failure action for the import job.
* @public */ FailureAction?: AssetBundleImportFailureAction | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the response.
* @public */ Status?: number | undefined; /** *Optional permission overrides that are applied to the resource configuration before * import.
* @public */ OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; /** *Optional tag overrides that are applied to the resource configuration before * import.
* @public */ OverrideTags?: AssetBundleImportJobOverrideTags | undefined; /** *An optional validation strategy override for all analyses and dashboards to be applied * to the resource configuration before import.
* @public */ OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; /** *An array of warning records that describe all permitted errors that are encountered * during the import job.
* @public */ Warnings?: AssetBundleImportJobWarning[] | undefined; } /** * @public */ export interface DescribeAutomationJobRequest { /** *The ID of the Amazon Web Services account that contains the automation job.
* @public */ AwsAccountId: string | undefined; /** *The ID of the automation group that contains the automation.
* @public */ AutomationGroupId: string | undefined; /** *The ID of the automation that the job belongs to.
* @public */ AutomationId: string | undefined; /** *A Boolean value that indicates whether to include the input payload in the response. If set to true, the input payload will be included. If set to false, the input payload will be returned as null.
A Boolean value that indicates whether to include the output payload in the response. If set to true, the output payload will be included. If set to false, the output payload will be returned as null.
The ID of the automation job to describe.
* @public */ JobId: string | undefined; } /** * @public */ export interface DescribeAutomationJobResponse { /** *The Amazon Resource Name (ARN) of the automation job.
* @public */ Arn: string | undefined; /** *The time that the automation job was created.
* @public */ CreatedAt?: Date | undefined; /** *The time that the automation job started running.
* @public */ StartedAt?: Date | undefined; /** *The time that the automation job finished running.
* @public */ EndedAt?: Date | undefined; /** *The current status of the automation job.
* @public */ JobStatus: AutomationJobStatus | undefined; /** *The input payload that was provided when the automation job was started. This field is only included when IncludeInputPayload is set to true in the request.
The output payload that was generated by the automation job. This field is only included when IncludeOutputPayload is set to true in the request.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeBrandRequest { /** *The ID of the Amazon Web Services account that owns the brand.
* @public */ AwsAccountId: string | undefined; /** *The ID of the Quick brand.
* @public */ BrandId: string | undefined; /** *The ID of the specific version. The default value is the latest version.
* @public */ VersionId?: string | undefined; } /** * @public */ export interface DescribeBrandResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The details of the brand.
* @public */ BrandDetail?: BrandDetail | undefined; /** *The definition of the brand.
* @public */ BrandDefinition?: BrandDefinition | undefined; } /** * @public */ export interface DescribeBrandAssignmentRequest { /** *The ID of the Amazon Web Services account that owns the brand assignment.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeBrandAssignmentResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The Amazon Resource Name (ARN) of the brand.
* @public */ BrandArn?: string | undefined; } /** * @public */ export interface DescribeBrandPublishedVersionRequest { /** *The ID of the Amazon Web Services account that owns the brand.
* @public */ AwsAccountId: string | undefined; /** *The ID of the Quick brand.
* @public */ BrandId: string | undefined; } /** * @public */ export interface DescribeBrandPublishedVersionResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The details of the brand.
* @public */ BrandDetail?: BrandDetail | undefined; /** *The definition of the brand.
* @public */ BrandDefinition?: BrandDefinition | undefined; } /** * @public */ export interface DescribeCustomPermissionsRequest { /** *The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.
* @public */ AwsAccountId: string | undefined; /** *The name of the custom permissions profile to describe.
* @public */ CustomPermissionsName: string | undefined; } /** * @public */ export interface DescribeCustomPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The custom permissions profile.
* @public */ CustomPermissions?: CustomPermissions | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeDashboardRequest { /** *The ID of the Amazon Web Services account that contains the dashboard that you're * describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dashboard.
* @public */ DashboardId: string | undefined; /** *The version number for the dashboard. If a version number isn't passed, the * latest published dashboard version is described.
* @public */ VersionNumber?: number | undefined; /** *The alias name.
* @public */ AliasName?: string | undefined; } /** * @public */ export interface DescribeDashboardResponse { /** *Information about the dashboard.
* @public */ Dashboard?: Dashboard | undefined; /** *The HTTP status of this request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeDashboardDefinitionRequest { /** *The ID of the Amazon Web Services account that contains the dashboard that you're * describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dashboard.
* @public */ DashboardId: string | undefined; /** *The version number for the dashboard. If a version number isn't passed, the * latest published dashboard version is described.
* @public */ VersionNumber?: number | undefined; /** *The alias name.
* @public */ AliasName?: string | undefined; } /** * @public */ export interface DescribeDashboardDefinitionResponse { /** *The ID of the dashboard described.
* @public */ DashboardId?: string | undefined; /** *Errors associated with this dashboard version.
* @public */ Errors?: DashboardError[] | undefined; /** *The display name of the dashboard.
* @public */ Name?: string | undefined; /** *Status associated with the dashboard version.
*
* CREATION_IN_PROGRESS
*
* CREATION_SUCCESSFUL
*
* CREATION_FAILED
*
* UPDATE_IN_PROGRESS
*
* UPDATE_SUCCESSFUL
*
* UPDATE_FAILED
*
* DELETED
*
The ARN of the theme of the dashboard.
* @public */ ThemeArn?: string | undefined; /** *The definition of a dashboard.
*A definition is the data model of all features in a Dashboard, Template, or Analysis.
* @public */ Definition?: DashboardVersionDefinition | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *Options for publishing the dashboard:
*
* AvailabilityStatus for AdHocFilteringOption - This
* status can be either ENABLED or DISABLED. When this is
* set to DISABLED, Amazon Quick Sight disables the left filter pane on
* the published dashboard, which can be used for ad hoc (one-time) filtering. This
* option is ENABLED by default.
* AvailabilityStatus for ExportToCSVOption - This
* status can be either ENABLED or DISABLED. The visual
* option to export data to .CSV format isn't enabled when this is set to
* DISABLED. This option is ENABLED by default.
*
* VisibilityState for SheetControlsOption - This
* visibility state can be either COLLAPSED or EXPANDED.
* This option is COLLAPSED by default.
* AvailabilityStatus for QuickSuiteActionsOption -
* This status can be either ENABLED or DISABLED.
* Features related to Actions in Amazon Quick Suite on dashboards are disabled
* when this is set to DISABLED. This option is DISABLED
* by default.
* AvailabilityStatus for ExecutiveSummaryOption - This
* status can be either ENABLED or DISABLED. The option
* to build an executive summary is disabled when this is set to
* DISABLED. This option is ENABLED by
* default.
* AvailabilityStatus for DataStoriesSharingOption -
* This status can be either ENABLED or DISABLED. The
* option to share a data story is disabled when this is set to
* DISABLED. This option is ENABLED by
* default.
The ID of the Amazon Web Services account that contains the dashboard that you're * describing permissions for.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dashboard, also added to the IAM policy.
* @public */ DashboardId: string | undefined; } /** * @public */ export interface DescribeDashboardPermissionsResponse { /** *The ID for the dashboard.
* @public */ DashboardId?: string | undefined; /** *The Amazon Resource Name (ARN) of the dashboard.
* @public */ DashboardArn?: string | undefined; /** *A structure that contains the permissions for the dashboard.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *A structure that contains the configuration of a shareable link that grants access to * the dashboard. Your users can use the link to view and interact with the dashboard, if * the dashboard has been shared with them. For more information about sharing dashboards, * see Sharing Dashboards.
* @public */ LinkSharingConfiguration?: LinkSharingConfiguration | undefined; } /** * @public */ export interface DescribeDashboardSnapshotJobRequest { /** *The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dashboard that you have started a snapshot job for.
* @public */ DashboardId: string | undefined; /** *The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
A structure that contains information on the Amazon S3 destinations of the generated snapshot.
* @public */ export interface SnapshotDestinationConfiguration { /** *
* A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.
*
A structure that contains the information on the snapshot files.
* @public */ export interface SnapshotFileGroup { /** *A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
Describes the configuration of the dashboard snapshot.
* @public */ export interface SnapshotConfiguration { /** *A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
* @public */ DestinationConfiguration?: SnapshotDestinationConfiguration | undefined; /** *A list of Quick Sight parameters and the list's override values.
* @public */ Parameters?: _Parameters | undefined; } /** *Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.
* @public */ export interface SnapshotAnonymousUserRedacted { /** *The tag keys for the RowLevelPermissionTags.
A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded. *
* @public */ export interface SnapshotUserConfigurationRedacted { /** ** An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded. *
* @public */ AnonymousUsers?: SnapshotAnonymousUserRedacted[] | undefined; } /** * @public */ export interface DescribeDashboardSnapshotJobResponse { /** ** The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. *
* @public */ AwsAccountId?: string | undefined; /** *The ID of the dashboard that you have started a snapshot job for.
* @public */ DashboardId?: string | undefined; /** *The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.
The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
Indicates the status of a job. The status updates as the job executes. This shows one of the following values.
*
* COMPLETED - The job was completed successfully.
* FAILED - The job failed to execute.
* QUEUED - The job is queued and hasn't started yet.
* RUNNING - The job is still running.
* The time that the snapshot job was created. *
* @public */ CreatedTime?: Date | undefined; /** ** The time that the snapshot job status was last updated. *
* @public */ LastUpdatedTime?: Date | undefined; /** ** The Amazon Web Services request ID for this operation. *
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDashboardSnapshotJobResultRequest { /** *The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dashboard that you have started a snapshot job for.
* @public */ DashboardId: string | undefined; /** *The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
An object that contains information on the error that caused the snapshot job to fail.
*For more information, see DescribeDashboardSnapshotJobResult API.
* @public */ export interface SnapshotJobErrorInfo { /** *The error message.
* @public */ ErrorMessage?: string | undefined; /** *The error type.
* @public */ ErrorType?: string | undefined; } /** *A structure that contains information about files that are requested for registered user during a StartDashboardSnapshotJob API call.
A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested for registered user during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.
* @public */ export interface SnapshotJobResult { /** * A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.
A list of RegisteredUserSnapshotJobResult objects that contain information about files that are requested for registered user during a StartDashboardSnapshotJob API call.
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
The time that a snapshot job was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that a snapshot job status was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
* @public */ Result?: SnapshotJobResult | undefined; /** *Displays information for the error that caused a job to fail.
* @public */ ErrorInfo?: SnapshotJobErrorInfo | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDashboardsQAConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want described.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeDashboardsQAConfigurationResponse { /** *The status of dashboards QA configuration that you want described.
* @public */ DashboardsQAStatus?: DashboardsQAStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSetRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DescribeDataSetResponse { /** *Information on the dataset.
* @public */ DataSet?: DataSet | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSetPermissionsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DescribeDataSetPermissionsResponse { /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DataSetArn?: string | undefined; /** *The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId?: string | undefined; /** *A list of resource permissions on the dataset.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSetRefreshPropertiesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DescribeDataSetRefreshPropertiesResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The dataset refresh properties.
* @public */ DataSetRefreshProperties?: DataSetRefreshProperties | undefined; } /** * @public */ export interface DescribeDataSourceRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId: string | undefined; } /** * @public */ export interface DescribeDataSourceResponse { /** *The information on the data source.
* @public */ DataSource?: DataSource | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSourcePermissionsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId: string | undefined; } /** * @public */ export interface DescribeDataSourcePermissionsResponse { /** *The Amazon Resource Name (ARN) of the data source.
* @public */ DataSourceArn?: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId?: string | undefined; /** *A list of resource permissions on the data source.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDefaultQBusinessApplicationRequest { /** *The ID of the Quick Sight account that is linked to the Amazon Q Business application that you want described.
* @public */ AwsAccountId: string | undefined; /** *The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
* @public */ Namespace?: string | undefined; } /** * @public */ export interface DescribeDefaultQBusinessApplicationResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The ID of the Amazon Q Business application that is linked to the Quick Sight account.
* @public */ ApplicationId?: string | undefined; } /** * @public */ export interface DescribeFolderRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; } /** *A folder in Quick Sight.
* @public */ export interface Folder { /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Resource Name (ARN) for the folder.
* @public */ Arn?: string | undefined; /** *A display name for the folder.
* @public */ Name?: string | undefined; /** *The type of folder it is.
* @public */ FolderType?: FolderType | undefined; /** *An array of ancestor ARN strings for the folder.
* @public */ FolderPath?: string[] | undefined; /** *The time that the folder was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the folder was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The sharing scope of the folder.
* @public */ SharingModel?: SharingModel | undefined; } /** * @public */ export interface DescribeFolderResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *Information about the folder.
* @public */ Folder?: Folder | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeFolderPermissionsRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The namespace of the folder whose permissions you want described.
* @public */ Namespace?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; /** *A pagination token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeFolderPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Resource Name (ARN) for the folder.
* @public */ Arn?: string | undefined; /** *Information about the permissions on the folder.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The pagination token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeFolderResolvedPermissionsRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The namespace of the folder whose permissions you want described.
* @public */ Namespace?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; /** *A pagination token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeFolderResolvedPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Resource Name (ARN) of the folder.
* @public */ Arn?: string | undefined; /** *Information about the permissions for the folder.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *A pagination token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeGroupRequest { /** *The name of the group that you want to describe.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace of the group that you want described.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DescribeGroupResponse { /** *The name of the group.
* @public */ Group?: Group | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeGroupMembershipRequest { /** *The user name of the user that you want to search for.
* @public */ MemberName: string | undefined; /** *The name of the group that you want to search.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that includes the group you are searching within.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DescribeGroupMembershipResponse { /** *A member of an Quick Sight group. Currently, group members must be users. Groups * can't be members of another group. .
* @public */ GroupMember?: GroupMember | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeIAMPolicyAssignmentRequest { /** *The ID of the Amazon Web Services account that contains the assignment that you want to * describe.
* @public */ AwsAccountId: string | undefined; /** *The name of the assignment, also called a rule.
* @public */ AssignmentName: string | undefined; /** *The namespace that contains the assignment.
* @public */ Namespace: string | undefined; } /** *An Identity and Access Management (IAM) policy assignment.
* @public */ export interface IAMPolicyAssignment { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId?: string | undefined; /** *Assignment ID.
* @public */ AssignmentId?: string | undefined; /** *Assignment name.
* @public */ AssignmentName?: string | undefined; /** *The Amazon Resource Name (ARN) for the IAM policy.
* @public */ PolicyArn?: string | undefined; /** *Identities.
* @public */ Identities?: RecordAssignment status.
* @public */ AssignmentStatus?: AssignmentStatus | undefined; } /** * @public */ export interface DescribeIAMPolicyAssignmentResponse { /** *Information describing the IAM policy assignment.
* @public */ IAMPolicyAssignment?: IAMPolicyAssignment | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeIngestionRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset used in the ingestion.
* @public */ DataSetId: string | undefined; /** *An ID for the ingestion.
* @public */ IngestionId: string | undefined; } /** *Error information for the SPICE ingestion of a dataset.
* @public */ export interface ErrorInfo { /** *Error type.
* @public */ Type?: IngestionErrorType | undefined; /** *Error message.
* @public */ Message?: string | undefined; } /** *Information about a queued dataset SPICE ingestion.
* @public */ export interface QueueInfo { /** *The ID of the queued ingestion.
* @public */ WaitingOnIngestion: string | undefined; /** *The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing * ingestion to complete.
* @public */ QueuedIngestion: string | undefined; } /** *Information about rows for a data set SPICE ingestion.
* @public */ export interface RowInfo { /** *The number of rows that were ingested.
* @public */ RowsIngested?: number | undefined; /** *The number of rows that were not ingested.
* @public */ RowsDropped?: number | undefined; /** *The total number of rows in the dataset.
* @public */ TotalRowsInDataset?: number | undefined; } /** *Information about the SPICE ingestion for a dataset.
* @public */ export interface Ingestion { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn: string | undefined; /** *Ingestion ID.
* @public */ IngestionId?: string | undefined; /** *Ingestion status.
* @public */ IngestionStatus: IngestionStatus | undefined; /** *Error information for this ingestion.
* @public */ ErrorInfo?: ErrorInfo | undefined; /** *Information about rows for a data set SPICE ingestion.
* @public */ RowInfo?: RowInfo | undefined; /** *Information about a queued dataset SPICE ingestion.
* @public */ QueueInfo?: QueueInfo | undefined; /** *The time that this ingestion started.
* @public */ CreatedTime: Date | undefined; /** *The time that this ingestion took, measured in seconds.
* @public */ IngestionTimeInSeconds?: number | undefined; /** *The size of the data ingested, in bytes.
* @public */ IngestionSizeInBytes?: number | undefined; /** *Event source for this ingestion.
* @public */ RequestSource?: IngestionRequestSource | undefined; /** *Type of this ingestion.
* @public */ RequestType?: IngestionRequestType | undefined; } /** * @public */ export interface DescribeIngestionResponse { /** *Information about the ingestion.
* @public */ Ingestion?: Ingestion | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeIpRestrictionRequest { /** *The ID of the Amazon Web Services account that contains the IP rules.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeIpRestrictionResponse { /** *The ID of the Amazon Web Services account that contains the IP rules.
* @public */ AwsAccountId?: string | undefined; /** *A map that describes the IP rules with CIDR range and description.
* @public */ IpRestrictionRuleMap?: RecordA map of allowed VPC IDs and their rule descriptions.
* @public */ VpcIdRestrictionRuleMap?: RecordA map of allowed VPC endpoint IDs and their rule descriptions.
* @public */ VpcEndpointIdRestrictionRuleMap?: RecordA value that specifies whether IP rules are turned on.
* @public */ Enabled?: boolean | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request. *
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeKeyRegistrationRequest { /** *The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.
* @public */ AwsAccountId: string | undefined; /** *Determines whether the request returns the default key only.
* @public */ DefaultKeyOnly?: boolean | undefined; } /** *A customer managed key structure that contains the information listed below:
*
* KeyArn - The ARN of a KMS key that is registered to a Quick Sight account for encryption and decryption use.
* DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.
The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use.
* @public */ KeyArn?: string | undefined; /** *Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.
A structure that contains information about the QDataKey.
The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use as a QDataKey.
The type of QDataKey.
The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.
* @public */ AwsAccountId?: string | undefined; /** *A list of RegisteredCustomerManagedKey objects in a Quick Sight account.
A list of QDataKey objects in a Quick Sight account.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeNamespaceRequest { /** *The ID for the Amazon Web Services account that contains the Quick Sight namespace that you want to describe.
* @public */ AwsAccountId: string | undefined; /** *The namespace that you want to describe.
* @public */ Namespace: string | undefined; } /** *Errors that occur during namespace creation.
* @public */ export interface NamespaceError { /** *The error type.
* @public */ Type?: NamespaceErrorType | undefined; /** *The message for the error.
* @public */ Message?: string | undefined; } /** *The error type.
* @public */ export interface NamespaceInfoV2 { /** *The name of the error.
* @public */ Name?: string | undefined; /** *The namespace ARN.
* @public */ Arn?: string | undefined; /** *The namespace Amazon Web Services Region.
* @public */ CapacityRegion?: string | undefined; /** *The creation status of a namespace that is not yet completely created.
* @public */ CreationStatus?: NamespaceStatus | undefined; /** *The identity store used for the namespace.
* @public */ IdentityStore?: IdentityStore | undefined; /** *An error that occurred when the namespace was created.
* @public */ NamespaceError?: NamespaceError | undefined; /** *The Amazon Resource Name (ARN) for the IAM Identity Center application.
* @public */ IamIdentityCenterApplicationArn?: string | undefined; /** *The Amazon Resource Name (ARN) for the IAM Identity Center instance.
* @public */ IamIdentityCenterInstanceArn?: string | undefined; } /** * @public */ export interface DescribeNamespaceResponse { /** *The information about the namespace that you're describing. The response includes
* the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also
* works for namespaces that are in the process of being created. For incomplete namespaces,
* this API operation lists the namespace error types and messages associated with the creation process.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeQPersonalizationConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeQPersonalizationConfigurationResponse { /** *A value that indicates whether personalization is enabled or not.
* @public */ PersonalizationMode?: PersonalizationMode | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeQuickSightQSearchConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that the user wants described.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeQuickSightQSearchConfigurationResponse { /** *The status of Quick Sight Q Search configuration.
* @public */ QSearchStatus?: QSearchStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeRefreshScheduleRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; /** *The ID of the refresh schedule.
* @public */ ScheduleId: string | undefined; } /** * @public */ export interface DescribeRefreshScheduleResponse { /** *The refresh schedule.
* @public */ RefreshSchedule?: RefreshSchedule | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The Amazon Resource Name (ARN) for the refresh schedule.
* @public */ Arn?: string | undefined; } /** * @public */ export interface DescribeRoleCustomPermissionRequest { /** *The name of the role whose permissions you want described.
* @public */ Role: Role | undefined; /** *The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that contains the role.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DescribeRoleCustomPermissionResponse { /** *The name of the custom permission that is described.
* @public */ CustomPermissionsName?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeSelfUpgradeConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration.
* @public */ AwsAccountId: string | undefined; /** *The Quick namespace that you want to describe the Quick self-upgrade configuration for.
* @public */ Namespace: string | undefined; } /** *The self-upgrade configuration for the Quick account.
* @public */ export interface SelfUpgradeConfiguration { /** *Status set for the self-upgrade configuration for the Quick account. It can contain the following values:
*
* AUTO_APPROVAL: All the self-upgrade requests will be auto approved.
* ADMIN_APPROVAL: All the self-upgrade requests will require admin approval.
The self-upgrade configuration for the Quick account.
* @public */ SelfUpgradeConfiguration?: SelfUpgradeConfiguration | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; }