Module Awso_quicksight.Values_1Source

A structure that contains information that identifies the snapshot that needs to be generated.

Sourcemodule SnapshotFileFormatType : sig ... end
Sourcemodule SnapshotFile : sig ... end

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

Sourcemodule SnapshotFileList : sig ... end

A structure that contains information on the generated snapshot file groups.

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.

Sourcemodule AnswerId : sig ... end
Sourcemodule AnswerIds : sig ... end
Sourcemodule AppendedColumn : sig ... end

Represents a column that will be included in the result of an append operation, combining data from multiple sources.

Sourcemodule AppendedColumnList : sig ... end
Sourcemodule AppendOperation : sig ... end

A transform operation that combines rows from two data sources by stacking them vertically (union operation).

Sourcemodule ApplicationArn : sig ... end
Sourcemodule Palette : sig ... end

The color palette.

Sourcemodule ContextualAccentPalette : sig ... end

The contextual accent palette.

Sourcemodule NavbarStyle : sig ... end

The navigation bar style.

Sourcemodule BrandElementStyle : sig ... end

The element style.

Sourcemodule BrandColorPalette : sig ... end

The color palette.

Sourcemodule ApplicationTheme : sig ... end

The application theme.

Sourcemodule ArnList : sig ... end

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

An optional structure that configures resource ID overrides for the export job.

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

Controls how a specific Folder resource is parameterized in the returned CloudFormation template.

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

An optional collection of CloudFormation property configurations that control how the export job is generated.

Sourcemodule AssetBundleExportFormat : sig ... end
Sourcemodule AssetBundleExportJobError : sig ... end

Describes an error that occurred during an Asset Bundle export job.

A summary of the export job that includes details of the job's configuration and its current status.

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

Describes a warning that occurred during an Asset Bundle export job.

Sourcemodule AssetBundleImportBodyBlob : sig ... end
Sourcemodule ResourceName : sig ... end
Sourcemodule ResourceId : sig ... end

The override parameters for a single analysis that is being imported.

Sourcemodule Principal : sig ... end
Sourcemodule AssetBundlePrincipalList : sig ... end

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

An object that contains a list of permissions to be applied to a list of analysis IDs.

Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule Tag : sig ... end

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Sourcemodule TagList : sig ... end

An object that contains a list of tags to be assigned to a list of analysis IDs.

The override parameters for a single dashboard that is being imported.

A structure that contains the configuration of a shared link to an Amazon Quick Sight dashboard.

An object that contains a list of permissions to be applied to a list of dashboard IDs.

An object that contains a list of tags to be assigned to a list of dashboard IDs.

Sourcemodule RefreshFailureAlertStatus : sig ... end
Sourcemodule RefreshFailureEmailAlert : sig ... end

The configuration settings for the email alerts that are sent when a dataset refresh fails.

The failure configuration of a dataset.

Sourcemodule PositiveLong : sig ... end
Sourcemodule LookbackWindowSizeUnit : sig ... end
Sourcemodule LookbackWindow : sig ... end

The lookback window setup of an incremental refresh configuration.

Sourcemodule IncrementalRefresh : sig ... end

The incremental refresh configuration for a dataset.

Sourcemodule RefreshConfiguration : sig ... end

The refresh configuration of a dataset.

Sourcemodule DataSetRefreshProperties : sig ... end

The refresh properties of a dataset.

The override parameters for a single dataset that is being imported.

An object that contains a list of permissions to be applied to a list of dataset IDs.

An object that contains a list of tags to be assigned to a list of dataset IDs.

Sourcemodule Password : sig ... end
Sourcemodule DbUsername : sig ... end

A username and password credential pair to use to import a data source resource.

Sourcemodule SecretArn : sig ... end

The login credentials to use to import a data source resource.

Sourcemodule VpcConnectionProperties : sig ... end

VPC connection properties.

Sourcemodule SslProperties : sig ... end

Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.

Sourcemodule XpathFields : sig ... end
Sourcemodule WebCrawlerAuthType : sig ... end
Sourcemodule SiteBaseUrl : sig ... end
Sourcemodule OptionalPort : sig ... end
Sourcemodule Host : sig ... end
Sourcemodule WebCrawlerParameters : sig ... end

The parameters for a web crawler data source.

Sourcemodule Query : sig ... end
Sourcemodule PositiveInteger : sig ... end
Sourcemodule TwitterParameters : sig ... end

The parameters for Twitter.

Sourcemodule Port : sig ... end
Sourcemodule Catalog : sig ... end
Sourcemodule TrinoParameters : sig ... end

The parameters that are required to connect to a Trino data source.

Sourcemodule Database : sig ... end
Sourcemodule TeradataParameters : sig ... end

The parameters for Teradata.

Sourcemodule StarburstProductType : sig ... end
Sourcemodule TokenProviderUrl : sig ... end
Sourcemodule OAuthScope : sig ... end
Sourcemodule CACertificatesBundleS3Uri : sig ... end
Sourcemodule OAuthParameters : sig ... end

An object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.

Sourcemodule DatabaseAccessControlRole : sig ... end
Sourcemodule AuthenticationType : sig ... end
Sourcemodule StarburstParameters : sig ... end

The parameters that are required to connect to a Starburst data source.

Sourcemodule SqlServerParameters : sig ... end

The parameters for SQL Server.

Sourcemodule SparkParameters : sig ... end

The parameters for Spark.

Sourcemodule Warehouse : sig ... end
Sourcemodule SnowflakeParameters : sig ... end

The parameters for Snowflake.

Sourcemodule ServiceNowParameters : sig ... end

The parameters for ServiceNow.

Sourcemodule S3TableBucketArn : sig ... end
Sourcemodule S3TablesParameters : sig ... end

The parameters for S3 Tables.

Sourcemodule S3Key : sig ... end
Sourcemodule S3Bucket : sig ... end
Sourcemodule ManifestFileLocation : sig ... end

Amazon S3 manifest file location.

Sourcemodule S3Parameters : sig ... end

The parameters for S3.

Sourcemodule MetadataFilesLocation : sig ... end
Sourcemodule S3KnowledgeBaseParameters : sig ... end

The parameters that are required to connect to a S3 Knowledge Base data source.

Sourcemodule DatabaseUser : sig ... end
Sourcemodule DatabaseGroup : sig ... end
Sourcemodule DatabaseGroupList : sig ... end
Sourcemodule RedshiftIAMParameters : sig ... end

A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials .

The parameters for an IAM Identity Center configuration.

Sourcemodule ClusterId : sig ... end
Sourcemodule RedshiftParameters : sig ... end

The parameters for Amazon Redshift. The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

Sourcemodule InstanceId : sig ... end
Sourcemodule RdsParameters : sig ... end

The parameters for Amazon RDS.

Sourcemodule QBusinessParameters : sig ... end

The parameters that are required to connect to an Amazon Q Business data source.

Sourcemodule PrestoParameters : sig ... end

The parameters for Presto.

Sourcemodule PostgreSqlParameters : sig ... end

The parameters for PostgreSQL.

Sourcemodule OracleParameters : sig ... end

The parameters for Oracle.

Sourcemodule MySqlParameters : sig ... end

The parameters for MySQL.

Sourcemodule MariaDbParameters : sig ... end

The parameters for MariaDB.

Sourcemodule JiraParameters : sig ... end

The parameters for Jira.

Sourcemodule SqlEndpointPath : sig ... end
Sourcemodule ImpalaParameters : sig ... end

The parameters that are required to connect to a Impala data source.

Sourcemodule ExasolParameters : sig ... end

The required parameters for connecting to an Exasol data source.

Sourcemodule DatabricksParameters : sig ... end

The parameters that are required to connect to a Databricks data source.

The parameters that are required to connect to a custom connection data source.

Sourcemodule ConfluenceParameters : sig ... end

The parameters that are required to connect to a Confluence data source

Sourcemodule ProjectId : sig ... end
Sourcemodule DataSetRegion : sig ... end
Sourcemodule BigQueryParameters : sig ... end

The parameters that are required to connect to a Google BigQuery data source.

Sourcemodule DataSetName : sig ... end
Sourcemodule AwsIotAnalyticsParameters : sig ... end

The parameters for IoT Analytics.

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

Sourcemodule AuroraParameters : sig ... end

Parameters for Amazon Aurora.

Sourcemodule WorkGroup : sig ... end
Sourcemodule AthenaParameters : sig ... end

Parameters for Amazon Athena.

Sourcemodule DataSourceParameters : sig ... end

The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

The override parameters for a single data source that is being imported.

An object that contains a list of permissions to be applied to a list of data source IDs.

An object that contains a list of tags to be assigned to a list of data source IDs.

Sourcemodule AssetBundleImportJobError : sig ... end

Describes an error that occurred within an Asset Bundle import execution.

The override parameters for a single folder that is being imported.

An object that contains a list of permissions to be applied to a list of folder IDs.

An object that contains a list of tags to be assigned to a list of folder IDs.

Sourcemodule SubnetId : sig ... end
Sourcemodule SubnetIdList : sig ... end
Sourcemodule SecurityGroupId : sig ... end
Sourcemodule SecurityGroupIdList : sig ... end
Sourcemodule IPv4Address : sig ... end
Sourcemodule DnsResolverList : sig ... end

The override parameters for a single VPC connection that is imported.

The override parameters for a single theme that is imported.

An optional structure that configures resource ID overrides for the import job.

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

An object that contains a list of permissions to be applied to a list of theme IDs.

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

An object that contains a list of tags to be assigned to a list of theme IDs.

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

A summary of the import job that includes details of the requested job's configuration and its current status.

Describes a warning that occurred during an Asset Bundle import job.

Sourcemodule S3Uri : sig ... end
Sourcemodule AssetBundleImportSource : sig ... end

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

Sourcemodule AssetBundleResourceArns : sig ... end
Sourcemodule AssignmentStatus : sig ... end
Sourcemodule NoneConnectionMetadata : sig ... end

Authentication metadata for connections that do not require authentication credentials.

Sourcemodule IAMConnectionMetadata : sig ... end

Authentication metadata for IAM-based connections, used for first-party Amazon Web Services service integrations.

Sourcemodule ClientSecret : sig ... end

Configuration details for OAuth2 client credentials grant flow, including client ID, client secret, token endpoint, and optional scopes.

Sourcemodule ClientCredentialsDetails : sig ... end

Details for OAuth 2.0 client credentials grant authentication.

Configuration for OAuth 2.0 client credentials grant authentication, including client ID, client secret, token endpoint, and optional scopes.

Metadata for basic authentication using username and password.

Configuration details for OAuth 2.0 authorization code grant flow.

Details for OAuth 2.0 authorization code grant credentials.

Metadata for OAuth 2.0 authorization code grant authentication.

Sourcemodule AuthenticationMetadata : sig ... end

Union type containing authentication metadata for different authentication methods.

Sourcemodule AuthConfig : sig ... end

Authentication configuration for connecting to external services.

Sourcemodule ServiceType : sig ... end
Sourcemodule AuthorizedTargetsList : sig ... end

The authorized targets that are associated with a service.

Sourcemodule AutomateId : sig ... end
Sourcemodule AutomationJobStatus : sig ... end
Sourcemodule AwsAccountId : sig ... end
Sourcemodule AwsAndAccountId : sig ... end
Sourcemodule TopicId : sig ... end
Sourcemodule VisualRole : sig ... end
Sourcemodule VisualOptions : sig ... end

The definition for a VisualOptions.

Sourcemodule TopicSortDirection : sig ... end
Sourcemodule Identifier : sig ... end

The definition for the identifier.

Sourcemodule TopicSortClause : sig ... end

The definition for a TopicSortClause.

Sourcemodule ComparisonMethodType : sig ... end
Sourcemodule TopicIRComparisonMethod : sig ... end

The definition of a TopicIRComparisonMethod.

Sourcemodule OperandList : sig ... end
Sourcemodule NamedEntityRef : sig ... end

The definition for a NamedEntityRef.

Sourcemodule NegativeFormat : sig ... end

A structure that represents a negative format.

Sourcemodule DisplayFormatOptions : sig ... end

A structure that represents additional options for display formatting.

Sourcemodule DisplayFormat : sig ... end
Sourcemodule TopicIRMetric : sig ... end

The definition for a TopicIRMetric.

Sourcemodule TopicIRMetricList : sig ... end
Sourcemodule TopicIRGroupBy : sig ... end

The definition for a TopicIRGroupBy.

Sourcemodule TopicIRGroupByList : sig ... end
Sourcemodule TopicIRFilterType : sig ... end
Sourcemodule TopicIRFilterFunction : sig ... end
Sourcemodule ConstantValueString : sig ... end
Sourcemodule ConstantType : sig ... end
Sourcemodule CollectiveConstantEntry : sig ... end

The definition for a CollectiveConstantEntry.

Sourcemodule TopicConstantValue : sig ... end

The definition for a TopicConstantValue.

Sourcemodule NullFilterOption : sig ... end
Sourcemodule FilterClass : sig ... end
Sourcemodule FilterAggMetrics : sig ... end

The definition for the FilterAggMetrics.

Sourcemodule FilterAggMetricsList : sig ... end
Sourcemodule TopicIRFilterOption : sig ... end

The definition for a TopicIRFilterOption.

Sourcemodule TopicIRFilterEntry : sig ... end
Sourcemodule TopicIRFilterList : sig ... end

The definition for the ContributionAnalysisTimeRanges.

The definition for the ContributionAnalysisFactor.

The definition for a TopicIRContributionAnalysis.

Sourcemodule TopicIR : sig ... end

The definition for a TopicIR.

module TopicVisual : sig ... end

The definition for a TopicVisual.

module TopicVisuals : sig ... end
Sourcemodule Slot : sig ... end

The definition for the slot.

Sourcemodule Slots : sig ... end
Sourcemodule TopicTemplate : sig ... end

The definition for a TopicTemplate.

Sourcemodule CreateTopicReviewedAnswer : sig ... end

The definition for a CreateTopicReviewedAnswer.

Creates new reviewed answers for a Q Topic.

Sourcemodule ThrottlingException : sig ... end

Access is throttled.

The definition for a SucceededTopicReviewedAnswer.

Sourcemodule StatusCode : sig ... end
Sourcemodule ExceptionResourceType : sig ... end
Sourcemodule ResourceNotFoundException : sig ... end

One or more resources can't be found.

Sourcemodule ReviewedAnswerErrorCode : sig ... end

The definition for a InvalidTopicReviewedAnswer.

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

Sourcemodule InternalFailureException : sig ... end

An internal failure occurred.

Creates new reviewed answers for a Q Topic.

Deletes reviewed answers for Q Topic.

Sourcemodule ConflictException : sig ... end

Updating or deleting a resource can cause an inconsistent state.

Deletes reviewed answers for Q Topic.

Sourcemodule BookmarksConfigurations : sig ... end

The bookmarks configuration of an embedded dashboard.

Sourcemodule Color : sig ... end

String to encapsulate the most generic way Color can be formatted (words, hexStrings etc)

Sourcemodule BorderStyle : sig ... end

The display options for tile borders for visuals.

Sourcemodule Name : sig ... end
Sourcemodule ImageSource : sig ... end

The source of the image.

Sourcemodule ImageConfiguration : sig ... end

The logo image configuration.

Sourcemodule ImageSetConfiguration : sig ... end

The image set configuration.

Sourcemodule LogoSetConfiguration : sig ... end

The logo set configuration.

Sourcemodule LogoConfiguration : sig ... end

The logo configuration.

Sourcemodule Description : sig ... end
Sourcemodule BrandDefinition : sig ... end

The definition of the brand.

Sourcemodule Image : sig ... end

The logo image.

Sourcemodule ImageSet : sig ... end

The image set.

Sourcemodule LogoSet : sig ... end

A set of logos.

The logo configuration.

Sourcemodule ErrorMessage : sig ... end
Sourcemodule ErrorList : sig ... end
Sourcemodule BrandVersionStatus : sig ... end
Sourcemodule BrandStatus : sig ... end
Sourcemodule BrandDetail : sig ... end

The details of the brand.

Sourcemodule BrandSummary : sig ... end

A summary of the brand.

Sourcemodule BrandSummaryList : sig ... end
Sourcemodule CIDR : sig ... end
Sourcemodule CalculatedColumn : sig ... end

A calculated column for a dataset.

Sourcemodule CalculatedColumnList : sig ... end
Sourcemodule IngestionId : sig ... end
Sourcemodule CancelIngestionRequest : sig ... end

Cancels an ongoing ingestion of data into SPICE.

Sourcemodule ResourceExistsException : sig ... end

The resource specified already exists.

Sourcemodule CancelIngestionResponse : sig ... end

Cancels an ongoing ingestion of data into SPICE.

Sourcemodule CapabilityState : sig ... end
Sourcemodule Capabilities : sig ... end

A set of actions that correspond to Amazon Quick Sight permissions.

Sourcemodule TypeCastFormat : sig ... end
Sourcemodule ColumnDataType : sig ... end
Sourcemodule ColumnDataSubType : sig ... end
Sourcemodule CastColumnTypeOperation : sig ... end

A transform operation that casts a column to a different type.

Sourcemodule CastColumnTypesOperation : sig ... end

A transform operation that changes the data types of one or more columns in the dataset.

Sourcemodule CategoryFilterFunction : sig ... end
Sourcemodule CategoryFilterType : sig ... end
Sourcemodule CellValue : sig ... end
Sourcemodule StringList : sig ... end
Sourcemodule CellValueSynonym : sig ... end

A structure that represents the cell value synonym.

Sourcemodule CellValueSynonyms : sig ... end
Sourcemodule CollectiveConstant : sig ... end

A structure that represents a collective constant.

Sourcemodule ColorList : sig ... end
Sourcemodule ColumnDataRole : sig ... end
Sourcemodule ColumnDescriptiveText : sig ... end
Sourcemodule ColumnDescription : sig ... end

Metadata that contains a description for a column.

Sourcemodule GeoSpatialCountryCode : sig ... end
Sourcemodule ColumnList : sig ... end
Sourcemodule ColumnGroupName : sig ... end
Sourcemodule GeoSpatialColumnGroup : sig ... end

Geospatial column group that denotes a hierarchy.

Sourcemodule ColumnGroup : sig ... end

Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Sourcemodule ColumnGroupColumnSchema : sig ... end

A structure describing the name, data type, and geographic role of the columns.

Sourcemodule ColumnGroupList : sig ... end
Sourcemodule ColumnGroupSchema : sig ... end

The column group schema.

Sourcemodule ColumnGroupSchemaList : sig ... end
Sourcemodule PrincipalList : sig ... end
Sourcemodule ColumnLevelPermissionRule : sig ... end

A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

Sourcemodule ColumnOrderingType : sig ... end
Sourcemodule ColumnSchema : sig ... end

The column schema.

Sourcemodule ColumnSchemaList : sig ... end
Sourcemodule GeoSpatialDataRole : sig ... end
Sourcemodule ColumnTag : sig ... end

A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Sourcemodule ColumnTagList : sig ... end
Sourcemodule ColumnTagName : sig ... end
Sourcemodule ColumnTagNames : sig ... end
Sourcemodule ColumnToUnpivot : sig ... end

Specifies a column to be unpivoted, transforming it from a column into rows with associated values.

Sourcemodule ColumnToUnpivotList : sig ... end
Sourcemodule ComparativeOrder : sig ... end

A structure that represents a comparative order.

A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.

Configures the display properties of the control title.

Sourcemodule CopySourceArn : sig ... end

Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

This resource is currently unavailable.

Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

Sourcemodule GroupsList : sig ... end

Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.

Sourcemodule SignupResponse : sig ... end

A SignupResponse object that contains a summary of a newly created account.

One or more preconditions aren't met.

Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide. You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.

Sourcemodule ResourcePermission : sig ... end

Permission for the resource.

Sourcemodule ResourcePermissionList : sig ... end

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Sourcemodule ValidationStrategyMode : sig ... end
Sourcemodule ValidationStrategy : sig ... end

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

Sourcemodule SensitiveStringList : sig ... end
Sourcemodule StringParameter : sig ... end

A string parameter.

Sourcemodule StringParameterList : sig ... end
Sourcemodule SensitiveLongList : sig ... end
Sourcemodule IntegerParameter : sig ... end

An integer parameter.

Sourcemodule IntegerParameterList : sig ... end
Sourcemodule SensitiveDoubleList : sig ... end
Sourcemodule DecimalParameter : sig ... end

A decimal parameter.

Sourcemodule DecimalParameterList : sig ... end
Sourcemodule SensitiveTimestampList : sig ... end
Sourcemodule DateTimeParameter : sig ... end

A date-time parameter.

Sourcemodule DateTimeParameterList : sig ... end
Sourcemodule Parameters : sig ... end

A list of Quick Sight parameters and the list's override values.

Sourcemodule FolderArnList : sig ... end
Sourcemodule CreateAnalysisRequest : sig ... end

Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.

This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

Sourcemodule LimitExceededException : sig ... end

A limit is exceeded.

Sourcemodule CreateAnalysisResponse : sig ... end

Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.

Sourcemodule CreateBrandRequest : sig ... end

Creates an Quick Sight brand.

Sourcemodule InvalidRequestException : sig ... end

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

Sourcemodule InternalServerException : sig ... end

An internal service exception.

Sourcemodule CreateBrandResponse : sig ... end

Creates an Quick Sight brand.

Sourcemodule CreateColumnsOperation : sig ... end

A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.

Sourcemodule CustomPermissionsName : sig ... end

Creates a custom permissions profile.

Creates a custom permissions profile.

Sourcemodule VersionDescription : sig ... end
Sourcemodule LinkSharingConfiguration : sig ... end

A structure that contains the configuration of a shareable link to the dashboard.

Sourcemodule LinkEntityArn : sig ... end
Sourcemodule LinkEntityArnList : sig ... end

The contents of a dashboard.

Sourcemodule DashboardSourceTemplate : sig ... end

Dashboard source template.

Sourcemodule DashboardSourceEntity : sig ... end

Dashboard source entity.

Sourcemodule VisualAxisSortOption : sig ... end

The axis sort options for a visual.

The sheet layout maximization options of a dashbaord.

Sourcemodule DashboardUIState : sig ... end
Sourcemodule SheetControlsOption : sig ... end

Sheet controls option.

Sourcemodule QuickSuiteActionsOption : sig ... end

Determines if Actions in Amazon Quick Suite are enabled in a dashboard..

Determines whether or not hidden fields are visible on exported dashbaords.

Sourcemodule ExportToCSVOption : sig ... end

Export to .csv option.

Sourcemodule ExecutiveSummaryOption : sig ... end

Data stories sharing option.

Sourcemodule DataStoriesSharingOption : sig ... end

Executive summary option.

Sourcemodule DataQAEnabledOption : sig ... end

Adds Q&A capabilities to a dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is enabled.

Sourcemodule DataPointTooltipOption : sig ... end

The data point tooltip options.

Sourcemodule DataPointMenuLabelOption : sig ... end

The data point menu options of a dashboard.

The drill down options for data points in a dashbaord.

Sourcemodule ExportHiddenFieldsOption : sig ... end

Determines if hidden fields are included in an exported dashboard.

The visual publish options of a visual in a dashboard

Sourcemodule DashboardPublishOptions : sig ... end

Dashboard publish options.

Sourcemodule DashboardName : sig ... end
Sourcemodule CreateDashboardRequest : sig ... end

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Sourcemodule CreateDashboardResponse : sig ... end

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Sourcemodule SemanticTableAlias : sig ... end
Sourcemodule Status : sig ... end
Sourcemodule SessionTagValue : sig ... end
Sourcemodule SessionTagKey : sig ... end
Sourcemodule RowLevelPermissionTagRule : sig ... end

A set of rules associated with a tag.

The configuration of tags on a dataset to set row-level security.

Sourcemodule RowLevelPermissionPolicy : sig ... end
Sourcemodule RowLevelPermissionDataSet : sig ... end

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.

Configuration for row level security.

Sourcemodule SemanticTable : sig ... end

A semantic table that represents the final analytical structure of the data.

Sourcemodule SemanticTableMap : sig ... end

Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.

Sourcemodule PhysicalTableId : sig ... end
Sourcemodule TablePathElementName : sig ... end
Sourcemodule TablePathElementId : sig ... end
Sourcemodule TablePathElement : sig ... end

An element in the hierarchical path to a table within a data source, containing both name and identifier.

Sourcemodule TablePathElementList : sig ... end
Sourcemodule InputColumnDataType : sig ... end
Sourcemodule InputColumn : sig ... end

Metadata for a column that is used as the input of a transform operation.

Sourcemodule InputColumnList : sig ... end
Sourcemodule SaaSTable : sig ... end

A table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions.

Sourcemodule TextQualifier : sig ... end
Sourcemodule FileFormat : sig ... end
Sourcemodule Delimiter : sig ... end
Sourcemodule UploadSettings : sig ... end

Information about the format for a source file or files.

Sourcemodule S3Source : sig ... end

A physical table type for an S3 data source.

Sourcemodule RelationalTableSchema : sig ... end
Sourcemodule RelationalTableName : sig ... end
Sourcemodule RelationalTableCatalog : sig ... end
Sourcemodule RelationalTable : sig ... end

A physical table type for relational data sources.

Sourcemodule SqlQuery : sig ... end
Sourcemodule CustomSqlName : sig ... end
Sourcemodule CustomSql : sig ... end

A physical table type built from the results of the custom SQL query.

Sourcemodule PhysicalTable : sig ... end

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.

Sourcemodule PhysicalTableMap : sig ... end
Sourcemodule UniqueKeyColumnNameList : sig ... end
Sourcemodule UniqueKey : sig ... end

A UniqueKey configuration that references a dataset column.

Sourcemodule UniqueKeyList : sig ... end
Sourcemodule PerformanceConfiguration : sig ... end

The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.

Sourcemodule LogicalTableId : sig ... end

An identifier for the logical table that is defined in the dataset

Sourcemodule UntagColumnOperation : sig ... end

A transform operation that removes tags associated with a column.

Sourcemodule TagColumnOperation : sig ... end

A transform operation that tags a column with additional information.

Sourcemodule RenameColumnOperation : sig ... end

A transform operation that renames a column.

Sourcemodule ProjectedColumnNameList : sig ... end
Sourcemodule ProjectOperation : sig ... end

A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.

The default value for the string parameter.

The default value for the integer parameter.

The default value for the decimal parameter.

The default value for the date time parameter.

Sourcemodule NewDefaultValues : sig ... end

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

Sourcemodule DatasetParameterName : sig ... end

A transform operation that overrides the dataset parameter values that are defined in another dataset.

Represents a list of string values used in filter conditions.

A filter condition that includes or excludes string values from a specified list.

Sourcemodule DataSetStringFilterValue : sig ... end

Represents a string value used in filter conditions.

A filter condition that compares string values using operators like EQUALS, CONTAINS, or STARTS_WITH.

A filter condition for string columns, supporting both comparison and list-based filtering.

Sourcemodule DataSetNumericFilterValue : sig ... end

Represents a numeric value used in filter conditions.

A filter condition that filters numeric values within a specified range.

A filter condition that compares numeric values using operators like EQUALS, GREATER_THAN, or LESS_THAN.

A filter condition for numeric columns, supporting both comparison and range-based filtering.

Sourcemodule DataSetDateFilterValue : sig ... end

Represents a date value used in filter conditions.

A filter condition that filters date values within a specified range.

A filter condition that compares date values using operators like BEFORE, AFTER, or their inclusive variants.

A filter condition for date columns, supporting both comparison and range-based filtering.

Sourcemodule FilterOperation : sig ... end

A transform operation that filters rows based on a condition.

Sourcemodule TransformOperation : sig ... end

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.

Sourcemodule TransformOperationList : sig ... end
Sourcemodule OnClause : sig ... end
Sourcemodule JoinType : sig ... end
Sourcemodule JoinKeyProperties : sig ... end

Properties associated with the columns participating in a join.

Sourcemodule JoinInstruction : sig ... end

The instructions associated with a join.

Sourcemodule LogicalTableSource : sig ... end

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.

Sourcemodule LogicalTableAlias : sig ... end
Sourcemodule LogicalTable : sig ... end

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.

Sourcemodule LogicalTableMap : sig ... end
Sourcemodule FieldFolderPath : sig ... end
Sourcemodule FolderColumnList : sig ... end
Sourcemodule FieldFolderDescription : sig ... end
Sourcemodule FieldFolder : sig ... end

A FieldFolder element is a folder that contains fields and nested subfolders.

Sourcemodule FieldFolderMap : sig ... end

The default values of a string parameter.

Sourcemodule DatasetParameterValueType : sig ... end
Sourcemodule DatasetParameterId : sig ... end
Sourcemodule StringDatasetParameter : sig ... end

A string parameter for a dataset.

The default values of an integer parameter.

Sourcemodule IntegerDatasetParameter : sig ... end

An integer parameter for a dataset.

The default values of a decimal parameter.

Sourcemodule DecimalDatasetParameter : sig ... end

A decimal parameter for a dataset.

The default values of a date time parameter.

Sourcemodule DateTimeDatasetParameter : sig ... end

A date time parameter for a dataset.

Sourcemodule DatasetParameter : sig ... end

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

Sourcemodule DatasetParameterList : sig ... end
Sourcemodule DataSetUseAs : sig ... end
Sourcemodule DataSetUsageConfiguration : sig ... end

The usage configuration to apply to child datasets that reference this dataset as a source.

Sourcemodule DataSetImportMode : sig ... end
Sourcemodule UnpivotOperation : sig ... end

A transform operation that converts columns into rows, normalizing the data structure.

Sourcemodule RenameColumnOperationList : sig ... end
Sourcemodule RenameColumnsOperation : sig ... end

A transform operation that renames one or more columns in the dataset.

Sourcemodule ValueColumnConfiguration : sig ... end

Configuration for how to handle value columns in pivot operations, including aggregation settings.

Sourcemodule PivotedLabel : sig ... end

Specifies a label value to be pivoted into a separate column, including the new column name and identifier.

Sourcemodule PivotedLabelList : sig ... end
Sourcemodule PivotConfiguration : sig ... end

Configuration for a pivot operation, specifying which column contains labels and how to pivot them.

Sourcemodule PivotOperation : sig ... end

A transform operation that pivots data by converting row values into columns.

Sourcemodule JoinOperationType : sig ... end
Sourcemodule JoinOperationOnClause : sig ... end
Sourcemodule OutputColumnNameOverride : sig ... end

Specifies a mapping to override the name of an output column from a transform operation.

Sourcemodule JoinOperandProperties : sig ... end

Properties that control how columns are handled for a join operand, including column name overrides.

Sourcemodule JoinOperation : sig ... end

A transform operation that combines data from two sources based on specified join conditions.

Specifies the source table and column mappings for an import table operation.

Sourcemodule ImportTableOperation : sig ... end

A transform operation that imports data from a source table.

Sourcemodule FilterOperationList : sig ... end
Sourcemodule FiltersOperation : sig ... end

A transform operation that applies one or more filter conditions.

Sourcemodule TransformStep : sig ... end

A step in data preparation that performs a specific operation on the data.

Sourcemodule TransformStepMap : sig ... end
Sourcemodule ParentDataSet : sig ... end

References a parent dataset that serves as a data source, including its columns and metadata.

Sourcemodule SourceTable : sig ... end

A source table that provides initial data from either a physical table or parent dataset.

Sourcemodule SourceTableMap : sig ... end
Sourcemodule DestinationTableSource : sig ... end

Specifies the source of data for a destination table, including the transform operation and column mappings.

Sourcemodule DestinationTableAlias : sig ... end
Sourcemodule DestinationTable : sig ... end

Defines a destination table in data preparation that receives the final transformed data.

Sourcemodule DestinationTableMap : sig ... end
Sourcemodule DataPrepConfiguration : sig ... end

Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables.

Sourcemodule CreateDataSetRequest : sig ... end

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

An exception thrown when an invalid parameter value is provided for dataset operations.

Sourcemodule CreateDataSetResponse : sig ... end

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Sourcemodule DataSourceType : sig ... end
Sourcemodule WebProxyCredentials : sig ... end

The credentials for authenticating with a web proxy server.

Sourcemodule OAuthUsername : sig ... end
Sourcemodule OAuthClientSecret : sig ... end
Sourcemodule OAuthClientId : sig ... end
Sourcemodule OAuthClientCredentials : sig ... end

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.

Sourcemodule PrivateKeyPassphrase : sig ... end
Sourcemodule PrivateKey : sig ... end
Sourcemodule KeyPairCredentials : sig ... end

The combination of username, private key and passphrase that are used as credentials.

Sourcemodule DataSourceParametersList : sig ... end
Sourcemodule CredentialPair : sig ... end

The combination of user name and password that are used as credentials.

Sourcemodule DataSourceCredentials : sig ... end

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Sourcemodule CreateDataSourceRequest : sig ... end

Creates a data source.

The customer managed key that is registered to your Amazon Quick Sight account is unavailable.

Sourcemodule CreateDataSourceResponse : sig ... end

Creates a data source.

Sourcemodule MemberType : sig ... end

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

Sourcemodule FolderMember : sig ... end

An asset in a Quick Sight folder, such as a dashboard, analysis, or dataset.

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

Sourcemodule SharingModel : sig ... end
Sourcemodule FolderType : sig ... end
Sourcemodule FolderName : sig ... end
Sourcemodule CreateFolderRequest : sig ... end

Creates an empty shared folder.

Sourcemodule CreateFolderResponse : sig ... end

Creates an empty shared folder.

Sourcemodule GroupName : sig ... end
Sourcemodule GroupMemberName : sig ... end

Adds an Amazon Quick Sight user to an Amazon Quick Sight group.

Sourcemodule GroupMember : sig ... end

A member of an Quick Sight group. Currently, group members must be users. Groups can't be members of another group. .

Adds an Amazon Quick Sight user to an Amazon Quick Sight group.

Sourcemodule GroupDescription : sig ... end
Sourcemodule CreateGroupRequest : sig ... end

The request object for this operation.

Sourcemodule Group : sig ... end

A group in Quick Sight consists of a set of users. You can use groups to make it easier to manage access and security.

Sourcemodule CreateGroupResponse : sig ... end

The response object for this operation.

Sourcemodule IdentityName : sig ... end
Sourcemodule IdentityNameList : sig ... end
Sourcemodule IdentityMap : sig ... end

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

Sourcemodule IngestionType : sig ... end
Sourcemodule CreateIngestionRequest : sig ... end

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Sourcemodule IngestionStatus : sig ... end
Sourcemodule CreateIngestionResponse : sig ... end

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Sourcemodule IdentityStore : sig ... end
Sourcemodule CreateNamespaceRequest : sig ... end

(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

Sourcemodule NamespaceStatus : sig ... end
Sourcemodule CreateNamespaceResponse : sig ... end

(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

Sourcemodule DayOfWeek : sig ... end
Sourcemodule DayOfMonth : sig ... end
Sourcemodule ScheduleRefreshOnEntity : sig ... end

The refresh on entity for weekly or monthly schedules.

Sourcemodule RefreshInterval : sig ... end
Sourcemodule RefreshFrequency : sig ... end

Specifies the interval between each scheduled refresh of a dataset.

Sourcemodule RefreshSchedule : sig ... end

The refresh schedule of a dataset.

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

Sourcemodule Role : sig ... end

Use CreateRoleMembership to add an existing Quick Sight group to an existing role.

Use CreateRoleMembership to add an existing Quick Sight group to an existing role.

Sourcemodule VersionNumber : sig ... end

Creates a template alias for a template.

Sourcemodule TemplateAlias : sig ... end

The template alias.

Creates a template alias for a template.

Sourcemodule DataSetSchema : sig ... end

Dataset schema.

Sourcemodule DataSetConfiguration : sig ... end

Dataset configuration.

Sourcemodule DataSetConfigurationList : sig ... end
Sourcemodule TemplateVersionDefinition : sig ... end

The detailed definition of a template.

Sourcemodule TemplateSourceTemplate : sig ... end

The source template of the template.

Sourcemodule TemplateSourceAnalysis : sig ... end

The source analysis of the template.

Sourcemodule TemplateSourceEntity : sig ... end

The source entity of the template.

Sourcemodule TemplateName : sig ... end
Sourcemodule CreateTemplateRequest : sig ... end

Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

Sourcemodule CreateTemplateResponse : sig ... end

Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

Sourcemodule CreateThemeAliasRequest : sig ... end

Creates a theme alias for a theme.

Sourcemodule ThemeAlias : sig ... end

An alias for a theme.

Sourcemodule CreateThemeAliasResponse : sig ... end

Creates a theme alias for a theme.

Sourcemodule ThemeName : sig ... end
Sourcemodule UIColorPalette : sig ... end

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.

Sourcemodule TextTransform : sig ... end

Configures the display properties of the visual title.

Configures the display properties of the visual sub-title.

Sourcemodule Font : sig ... end

Determines the font settings.

Sourcemodule FontList : sig ... end
Sourcemodule Typography : sig ... end

Determines the typography options.

Sourcemodule TileStyle : sig ... end

Display options related to tiles on a sheet.

Sourcemodule MarginStyle : sig ... end

The display options for margins around the outside edge of sheets.

Sourcemodule GutterStyle : sig ... end

The display options for gutter spacing between tiles on a sheet.

Sourcemodule TileLayoutStyle : sig ... end

The display options for the layout of tiles on a sheet.

Sourcemodule SheetBackgroundStyle : sig ... end

The background configuration for sheets.

Sourcemodule SheetStyle : sig ... end

The theme display options for sheets.

Sourcemodule DataColorPalette : sig ... end

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.

Sourcemodule ThemeConfiguration : sig ... end

The theme configuration. This configuration contains all of the display properties for a theme.

Sourcemodule CreateThemeRequest : sig ... end

Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.

Sourcemodule CreateThemeResponse : sig ... end

Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.

Sourcemodule TopicScheduleType : sig ... end
Sourcemodule NullableBoolean : sig ... end
Sourcemodule TopicRefreshSchedule : sig ... end

A structure that represents a topic refresh schedule.

Creates a topic refresh schedule.

Creates a topic refresh schedule.

Sourcemodule TopicConfigOptions : sig ... end

Configuration options for a Topic.

Sourcemodule Synonyms : sig ... end
Sourcemodule TypeParameters : sig ... end
Sourcemodule SemanticEntityType : sig ... end

A structure that represents a semantic entity type.

Sourcemodule PropertyUsage : sig ... end
Sourcemodule PropertyRole : sig ... end
Sourcemodule NamedEntityAggType : sig ... end

A structure that represents a metric.

Sourcemodule NamedEntityDefinition : sig ... end

A structure that represents a named entity.

Sourcemodule NamedEntityDefinitions : sig ... end
Sourcemodule TopicNamedEntity : sig ... end

A structure that represents a named entity.

Sourcemodule TopicNamedEntities : sig ... end

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

Sourcemodule TopicRelativeDateFilter : sig ... end

A structure that represents a relative date filter.

Sourcemodule RangeConstant : sig ... end

A structure that represents a range constant.

Sourcemodule TopicRangeFilterConstant : sig ... end

A constant value that is used in a range filter to specify the endpoints of the range.

Sourcemodule NamedFilterAggType : sig ... end
Sourcemodule TopicNumericRangeFilter : sig ... end

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.

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.

Sourcemodule NullFilterType : sig ... end
Sourcemodule TopicNullFilter : sig ... end

The structure that represents a null filter.

Sourcemodule TopicDateRangeFilter : sig ... end

A filter used to restrict data based on a range of dates or times.

A constant used in a category filter.

Sourcemodule TopicCategoryFilter : sig ... end

A structure that represents a category filter.

Sourcemodule NamedFilterType : sig ... end
Sourcemodule TopicFilter : sig ... end

A structure that represents a filter used to select items for a topic.

Sourcemodule TopicFilters : sig ... end
Sourcemodule SemanticType : sig ... end

A structure that represents a semantic type.

Sourcemodule DefaultFormatting : sig ... end

A structure that represents a default formatting definition.

Sourcemodule DefaultAggregation : sig ... end
Sourcemodule TopicColumn : sig ... end

Represents a column in a dataset.

Sourcemodule TopicColumns : sig ... end
Sourcemodule TopicCalculatedField : sig ... end

A structure that represents a calculated field.

Sourcemodule TopicCalculatedFields : sig ... end
Sourcemodule DataAggregation : sig ... end

A structure that represents a data aggregation.

Sourcemodule DatasetMetadata : sig ... end

A structure that represents a dataset.

Sourcemodule Datasets : sig ... end
Sourcemodule TopicDetails : sig ... end

A structure that describes the details of a topic, such as its name, description, and associated data sets.

Sourcemodule CustomInstructionsString : sig ... end
Sourcemodule CustomInstructions : sig ... end

Instructions that provide additional guidance and context for response generation.

Sourcemodule CreateTopicRequest : sig ... end

Creates a new Q topic.

Sourcemodule CreateTopicResponse : sig ... end

Creates a new Q topic.

Creates a new VPC connection.

Creates a new VPC connection.

Sourcemodule CustomPermissions : sig ... end

The custom permissions profile.

Sourcemodule CustomPermissionsList : sig ... end
Sourcemodule DashboardErrorType : sig ... end
Sourcemodule DashboardError : sig ... end

Dashboard error.

Sourcemodule DashboardErrorList : sig ... end
Sourcemodule DashboardVersion : sig ... end

Dashboard version.

Sourcemodule Dashboard : sig ... end

Dashboard.

The dashboard customization summary configuration for an embedded Quick Sight dashboard.

Sourcemodule DashboardFilterAttribute : sig ... end
Sourcemodule DashboardSearchFilter : sig ... end

A filter that you apply when searching for dashboards.

Sourcemodule DashboardSearchFilterList : sig ... end
Sourcemodule DashboardSummary : sig ... end

Dashboard summary.

Sourcemodule DashboardSummaryList : sig ... end
Sourcemodule DashboardVersionSummary : sig ... end

Dashboard version summary.

Sourcemodule VisualTitle : sig ... end
Sourcemodule VisualSubtitle : sig ... end
Sourcemodule QAUrl : sig ... end
Sourcemodule DashboardVisualResult : sig ... end

The QA result that is made from dashboard visual.

Sourcemodule DashboardsQAStatus : sig ... end
Sourcemodule OutputColumn : sig ... end

Output column.

Sourcemodule OutputColumnList : sig ... end
Sourcemodule DataSet : sig ... end

Dataset.

Sourcemodule DataSetFilterAttribute : sig ... end
Sourcemodule DataSetSearchFilter : sig ... end

A filter that you apply when searching for datasets.

Sourcemodule DataSetSearchFilterList : sig ... end
Sourcemodule DataSetSummary : sig ... end

Dataset summary.

Sourcemodule DataSetSummaryList : sig ... end
Sourcemodule DataSourceErrorInfoType : sig ... end
Sourcemodule DataSourceErrorInfo : sig ... end

Error information for the data source creation or update.

Sourcemodule DataSource : sig ... end

The structure of a data source.

Sourcemodule DataSourceFilterAttribute : sig ... end
Sourcemodule DataSourceList : sig ... end
Sourcemodule DataSourceSearchFilter : sig ... end

A filter that you apply when searching for data sources.

Sourcemodule DataSourceSummary : sig ... end

A DataSourceSummary object that returns a summary of a data source.

Sourcemodule DataSourceSummaryList : sig ... end

Unapplies a custom permissions profile from an account.

Unapplies a custom permissions profile from an account.

This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.

This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.

Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users. Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients. User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators. No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored. Consider exporting critical dashboards and data before proceeding with account deletion. Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.

Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.

Sourcemodule RecoveryWindowInDays : sig ... end
Sourcemodule DeleteAnalysisRequest : sig ... end

Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

Sourcemodule DeleteAnalysisResponse : sig ... end

Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

Deletes a brand assignment.

Deletes a brand assignment.

Sourcemodule DeleteBrandRequest : sig ... end

This API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all its associated branding elements are permanently removed Any applications or dashboards using this brand will revert to default styling This action cannot be undone through the API Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand. Deletes an Quick Sight brand.

Sourcemodule DeleteBrandResponse : sig ... end

This API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all its associated branding elements are permanently removed Any applications or dashboards using this brand will revert to default styling This action cannot be undone through the API Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand. Deletes an Quick Sight brand.

Deletes a custom permissions profile.

Deletes a custom permissions profile.

Sourcemodule DeleteDashboardRequest : sig ... end

Deletes a dashboard.

Sourcemodule DeleteDashboardResponse : sig ... end

Deletes a dashboard.

Deletes the dataset refresh properties of the dataset.

Deletes the dataset refresh properties of the dataset.

Sourcemodule DeleteDataSetRequest : sig ... end

Deletes a dataset.

Sourcemodule DeleteDataSetResponse : sig ... end

Deletes a dataset.

Sourcemodule DeleteDataSourceRequest : sig ... end

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

Sourcemodule DeleteDataSourceResponse : sig ... end

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

Deletes a linked Amazon Q Business application from an Quick Sight account

Deletes a linked Amazon Q Business application from an Quick Sight account

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

Sourcemodule DeleteFolderRequest : sig ... end

Deletes an empty folder.

Sourcemodule DeleteFolderResponse : sig ... end

Deletes an empty folder.

Removes a user from a group so that the user is no longer a member of the group.

Removes a user from a group so that the user is no longer a member of the group.

Sourcemodule DeleteGroupRequest : sig ... end

Removes a user group from Amazon Quick Sight.

Sourcemodule DeleteGroupResponse : sig ... end

Removes a user group from Amazon Quick Sight.

Deletes an existing IAM policy assignment.

Deletes an existing IAM policy assignment.

Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

Sourcemodule DeleteNamespaceRequest : sig ... end

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

Sourcemodule DeleteNamespaceResponse : sig ... end

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

Deletes a refresh schedule from a dataset.

Deletes a refresh schedule from a dataset.

Removes custom permissions from the role.

Removes custom permissions from the role.

Removes a group from a role.

Removes a group from a role.

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

Sourcemodule DeleteTemplateRequest : sig ... end

Deletes a template.

Sourcemodule DeleteTemplateResponse : sig ... end

Deletes a template.

Sourcemodule DeleteThemeAliasRequest : sig ... end

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

Sourcemodule DeleteThemeAliasResponse : sig ... end

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

Sourcemodule DeleteThemeRequest : sig ... end

Deletes a theme.