Awso_quicksight.Values_1SourceA structure that contains information that identifies the snapshot that needs to be generated.
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.
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.
Represents a column that will be included in the result of an append operation, combining data from multiple sources.
A transform operation that combines rows from two data sources by stacking them vertically (union operation).
The contextual accent palette.
The navigation bar style.
The element style.
The color palette.
The application theme.
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.
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.
The override parameters for a single analysis that is being imported.
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.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
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.
The configuration settings for the email alerts that are sent when a dataset refresh fails.
The failure configuration of a dataset.
The lookback window setup of an incremental refresh configuration.
The incremental refresh configuration for a dataset.
The refresh configuration of a dataset.
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.
A username and password credential pair to use to import a data source resource.
The login credentials to use to import a data source resource.
VPC connection properties.
Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.
The parameters for a web crawler data source.
The parameters for Twitter.
The parameters that are required to connect to a Trino data source.
The parameters for Teradata.
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.
The parameters that are required to connect to a Starburst data source.
The parameters for SQL Server.
The parameters for Spark.
The parameters for Snowflake.
The parameters for ServiceNow.
The parameters for S3 Tables.
Amazon S3 manifest file location.
The parameters for S3.
The parameters that are required to connect to a S3 Knowledge Base data source.
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.
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.
The parameters for Amazon RDS.
The parameters that are required to connect to an Amazon Q Business data source.
The parameters for Presto.
The parameters for PostgreSQL.
The parameters for Oracle.
The parameters for MySQL.
The parameters for MariaDB.
The parameters for Jira.
The parameters that are required to connect to a Impala data source.
The required parameters for connecting to an Exasol data source.
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.
The parameters that are required to connect to a Confluence data source
The parameters that are required to connect to a Google BigQuery data source.
The parameters for IoT Analytics.
Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
Parameters for Amazon Aurora.
Parameters for Amazon Athena.
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.
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.
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.
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.
Authentication metadata for connections that do not require authentication credentials.
Authentication metadata for IAM-based connections, used for first-party Amazon Web Services service integrations.
Configuration details for OAuth2 client credentials grant flow, including client ID, client secret, token endpoint, and optional scopes.
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.
Union type containing authentication metadata for different authentication methods.
Authentication configuration for connecting to external services.
The authorized targets that are associated with a service.
The definition for a VisualOptions.
The definition for the identifier.
The definition for a TopicSortClause.
The definition of a TopicIRComparisonMethod.
The definition for a NamedEntityRef.
A structure that represents a negative format.
A structure that represents additional options for display formatting.
The definition for a TopicIRMetric.
The definition for a TopicIRGroupBy.
The definition for a CollectiveConstantEntry.
The definition for a TopicConstantValue.
The definition for the FilterAggMetrics.
The definition for a TopicIRFilterOption.
The definition for the ContributionAnalysisTimeRanges.
The definition for the ContributionAnalysisFactor.
The definition for a TopicIRContributionAnalysis.
module TopicVisual : sig ... endThe definition for a TopicVisual.
module TopicVisuals : sig ... endThe definition for a TopicTemplate.
The definition for a CreateTopicReviewedAnswer.
Creates new reviewed answers for a Q Topic.
Access is throttled.
The definition for a SucceededTopicReviewedAnswer.
One or more resources can't be found.
The definition for a InvalidTopicReviewedAnswer.
One or more parameters has a value that isn't valid.
An internal failure occurred.
Creates new reviewed answers for a Q Topic.
Deletes reviewed answers for Q Topic.
Updating or deleting a resource can cause an inconsistent state.
Deletes reviewed answers for Q Topic.
The bookmarks configuration of an embedded dashboard.
String to encapsulate the most generic way Color can be formatted (words, hexStrings etc)
The display options for tile borders for visuals.
The source of the image.
The logo image configuration.
The image set configuration.
The logo set configuration.
The logo configuration.
The definition of the brand.
The details of the brand.
A summary of the brand.
A calculated column for a dataset.
Cancels an ongoing ingestion of data into SPICE.
The resource specified already exists.
Cancels an ongoing ingestion of data into SPICE.
A set of actions that correspond to Amazon Quick Sight permissions.
A transform operation that casts a column to a different type.
A transform operation that changes the data types of one or more columns in the dataset.
A structure that represents the cell value synonym.
A structure that represents a collective constant.
Metadata that contains a description for a column.
Geospatial column group that denotes a hierarchy.
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.
A structure describing the name, data type, and geographic role of the columns.
The column group schema.
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.
The column schema.
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.
Specifies a column to be unpivoted, transforming it from a column into rows with associated values.
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.
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.
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.
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.
Permission for the resource.
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.
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.
A string parameter.
An integer parameter.
A decimal parameter.
A date-time parameter.
A list of Quick Sight parameters and the list's override values.
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.
A limit is exceeded.
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
Creates an Quick Sight brand.
You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
An internal service exception.
Creates an Quick Sight brand.
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Creates a custom permissions profile.
Creates a custom permissions profile.
A structure that contains the configuration of a shareable link to the dashboard.
The contents of a dashboard.
Dashboard source template.
Dashboard source entity.
The axis sort options for a visual.
The sheet layout maximization options of a dashbaord.
Sheet controls option.
Determines if Actions in Amazon Quick Suite are enabled in a dashboard..
Determines whether or not hidden fields are visible on exported dashbaords.
Export to .csv option.
Data stories sharing option.
Executive summary option.
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.
The data point tooltip options.
The data point menu options of a dashboard.
The drill down options for data points in a dashbaord.
Determines if hidden fields are included in an exported dashboard.
The visual publish options of a visual in a dashboard
Dashboard publish options.
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.
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.
A set of rules associated with a tag.
The configuration of tags on a dataset to set row-level security.
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.
A semantic table that represents the final analytical structure of the data.
Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.
An element in the hierarchical path to a table within a data source, containing both name and identifier.
Metadata for a column that is used as the input of a transform operation.
A table from a Software-as-a-Service (SaaS) data source, including connection details and column definitions.
Information about the format for a source file or files.
A physical table type for relational data sources.
A physical table type built from the results of the custom SQL query.
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.
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
An identifier for the logical table that is defined in the dataset
A transform operation that removes tags associated with a column.
A transform operation that tags a column with additional information.
A transform operation that renames a column.
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.
The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.
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.
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.
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.
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.
A transform operation that filters rows based on a condition.
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.
Properties associated with the columns participating in a join.
The instructions associated with 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.
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.
A FieldFolder element is a folder that contains fields and nested subfolders.
The default values of a string parameter.
A string parameter for a dataset.
The default values of an integer parameter.
An integer parameter for a dataset.
The default values of a decimal parameter.
A decimal parameter for a dataset.
The default values of a date time parameter.
A date time parameter for a dataset.
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
The usage configuration to apply to child datasets that reference this dataset as a source.
A transform operation that converts columns into rows, normalizing the data structure.
A transform operation that renames one or more columns in the dataset.
Configuration for how to handle value columns in pivot operations, including aggregation settings.
Specifies a label value to be pivoted into a separate column, including the new column name and identifier.
Configuration for a pivot operation, specifying which column contains labels and how to pivot them.
A transform operation that pivots data by converting row values into columns.
Specifies a mapping to override the name of an output column from a transform operation.
Properties that control how columns are handled for a join operand, including column name overrides.
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.
A transform operation that imports data from a source table.
A transform operation that applies one or more filter conditions.
A step in data preparation that performs a specific operation on the data.
References a parent dataset that serves as a data source, including its columns and metadata.
A source table that provides initial data from either a physical table or parent dataset.
Specifies the source of data for a destination table, including the transform operation and column mappings.
Defines a destination table in data preparation that receives the final transformed data.
Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables.
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.
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
The credentials for authenticating with a web proxy server.
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.
The combination of username, private key and passphrase that are used as credentials.
The combination of user name and password that are used as credentials.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Creates a data source.
The customer managed key that is registered to your Amazon Quick Sight account is unavailable.
Creates a data source.
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
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.
Creates an empty shared folder.
Creates an empty shared folder.
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
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.
The request object for this operation.
A group in Quick Sight consists of a set of users. You can use groups to make it easier to manage access and security.
The response object for this operation.
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.
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.
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.
(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.
(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.
The refresh on entity for weekly or monthly schedules.
Specifies the interval between each scheduled refresh of a dataset.
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.
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.
Creates a template alias for a template.
The template alias.
Creates a template alias for a template.
Dataset schema.
Dataset configuration.
The detailed definition of a template.
The source template of the template.
The source analysis of the template.
The source entity of the template.
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.
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.
Creates a theme alias for a theme.
An alias for a theme.
Creates a theme alias for a theme.
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.
Configures the display properties of the visual title.
Configures the display properties of the visual sub-title.
Determines the typography options.
The display options for margins around the outside edge of sheets.
The display options for gutter spacing between tiles on a sheet.
The display options for the layout of tiles on a sheet.
The background configuration for sheets.
The theme display options for sheets.
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 theme configuration. This configuration contains all of the display properties for a theme.
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.
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.
A structure that represents a topic refresh schedule.
Creates a topic refresh schedule.
Creates a topic refresh schedule.
Configuration options for a Topic.
A structure that represents a semantic entity type.
A structure that represents a metric.
A structure that represents a named entity.
A structure that represents a named entity.
A structure that represents a singular filter constant, used in filters to specify a single value to match against.
A structure that represents a relative date filter.
A structure that represents a range constant.
A constant value that is used in a range filter to specify the endpoints of the range.
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.
The structure that represents a null filter.
A filter used to restrict data based on a range of dates or times.
A constant used in a category filter.
A structure that represents a category filter.
A structure that represents a filter used to select items for a topic.
A structure that represents a semantic type.
A structure that represents a default formatting definition.
Represents a column in a dataset.
A structure that represents a calculated field.
A structure that represents a data aggregation.
A structure that represents a dataset.
A structure that describes the details of a topic, such as its name, description, and associated data sets.
Instructions that provide additional guidance and context for response generation.
Creates a new Q topic.
Creates a new Q topic.
Creates a new VPC connection.
Creates a new VPC connection.
The custom permissions profile.
Dashboard error.
Dashboard version.
The dashboard customization summary configuration for an embedded Quick Sight dashboard.
A filter that you apply when searching for dashboards.
Dashboard summary.
Dashboard version summary.
The QA result that is made from dashboard visual.
Output column.
A filter that you apply when searching for datasets.
Dataset summary.
Error information for the data source creation or update.
The structure of a data source.
A filter that you apply when searching for data sources.
A DataSourceSummary object that returns a summary of a data source.
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.
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 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.
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.
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.
Deletes a dashboard.
Deletes a dashboard.
Deletes the dataset refresh properties of the dataset.
Deletes the dataset refresh properties of the dataset.
Deletes a dataset.
Deletes a dataset.
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
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.
Deletes an empty folder.
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.
Removes a user group from Amazon Quick Sight.
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.
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 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.
Deletes a template.
Deletes a template.
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.
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.
Deletes a theme.