Definition of the AWS::QuickSight::ActionConnector Resource Type.

CfnActionConnector

actionConnectorId

awsAccountId

name

type

authenticationConfig

description

permissions

vpcConnectionArn

Creates an analysis in Amazon QuickSight.

CfnAnalysis

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

analysisId

The ID of the AWS account where you are creating an analysis.

A descriptive name for the analysis that you're creating.

This name displays for the analysis in the Amazon Quick Sight console.

definition

errors

folderArns

The parameter names and override values that you want to use.

An analysis can have any parameter type, and some parameters might accept multiple values.

parameters

A structure that describes the principals and the resource-level permissions on an analysis.

You can use the `Permissions` structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit `Permissions` .

A list of the associated sheets with the unique identifier and name of each sheet.

sheets

A source entity to use for the analysis that you're creating.

This metadata structure contains details that describe a source template and one or more datasets.

Either a `SourceEntity` or a `Definition` must be provided in order for the request to be valid.

sourceEntity

status

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

The ARN for the theme to apply to the analysis that you're creating.

To see the theme in the Amazon Quick Sight console, make sure that you have access to it.

themeArn

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.

validationStrategy

CfnCustomPermissions

The ID of the AWS account that contains the custom permission configuration that you want to update.

The name of the custom permissions profile.

customPermissionsName

A set of actions in the custom permissions profile.

capabilities

The tags to associate with the custom permissions profile.

Creates a dashboard from a template. To first create a template, see the `CreateTemplate` API operation.

A dashboard is an entity in Quick that identifies Quick reports, created from analyses. You can share Quick 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 AWS account .

CfnDashboard

The ID of the AWS account where you want to create the dashboard.

The ID for the dashboard, also added to the IAM policy.

dashboardId

Options for publishing the dashboard when you create it:.

- `AvailabilityStatus` for `AdHocFilteringOption` - This status can be either `ENABLED` or `DISABLED` . When this is set to `DISABLED` , Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is `ENABLED` by default.
- `AvailabilityStatus` for `ExportToCSVOption` - This status can be either `ENABLED` or `DISABLED` . The visual option to export data to .CSV format isn't enabled when this is set to `DISABLED` . This option is `ENABLED` by default.
- `VisibilityState` for `SheetControlsOption` - This visibility state can be either `COLLAPSED` or `EXPANDED` . This option is `COLLAPSED` by default.
- `AvailabilityStatus` for `QuickSuiteActionsOption` - This status can be either `ENABLED` or `DISABLED` . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to `DISABLED` . This option is `DISABLED` by default.
- `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can be either `ENABLED` or `DISABLED` . The option to build an executive summary is disabled when this is set to `DISABLED` . This option is `ENABLED` by default.
- `AvailabilityStatus` for `DataStoriesSharingOption` - This status can be either `ENABLED` or `DISABLED` . The option to share a data story is disabled when this is set to `DISABLED` . This option is `ENABLED` by default.

dashboardPublishOptions

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

linkEntities

A structure that contains the link sharing configurations that you want to apply overrides to.

linkSharingConfiguration

The parameters for the creation of the dashboard, which you want to use to override the default settings.

A dashboard can have any type of parameters, and some parameters might accept multiple values.

A structure that contains the permissions of the dashboard.

You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

The entity that you are using as a source when you create the dashboard.

In `SourceEntity` , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a `SourceTemplate` entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the `CreateTemplate` API operation. For `SourceTemplate` , specify the Amazon Resource Name (ARN) of the source template. The `SourceTemplate` ARN can contain any AWS account; and any QuickSight-supported AWS Region .

Use the `DataSetReferences` entity within `SourceTemplate` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

A description for the first version of the dashboard being created.

versionDescription

Creates a dataset.

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

CfnDataSet

Groupings of columns that work together in certain Amazon Quick Sight features.

Currently, only geospatial hierarchy is supported.

columnGroups

A set of one or more definitions of a `ColumnLevelPermissionRule` .

columnLevelPermissionRules

The data preparation configuration associated with this dataset.

dataPrepConfiguration

An ID for the dataset that you want to create.

This ID is unique per AWS Region for each AWS account.

dataSetId

The parameters that are declared in a dataset.

datasetParameters

dataSetRefreshProperties

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

dataSetUsageConfiguration

The folder that contains fields and nested subfolders for your dataset.

fieldFolders

When you create the dataset, Amazon QuickSight adds the dataset to these folders..

Indicates whether you want to import the data into SPICE.

importMode

The wait policy to use when creating or updating a Dataset.

The default is to wait for SPICE ingestion to finish with timeout of 36 hours.

ingestionWaitPolicy

logicalTableMap

The performance optimization configuration of a dataset.

performanceConfiguration

A list of resource permissions on the dataset.

Declares the physical tables that are available in the underlying data sources.

physicalTableMap

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
 <a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the Amazon QuickSight User
 Guide.
 The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
 not supported for new RLS datasets.

rowLevelPermissionDataSet

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

rowLevelPermissionTagConfiguration

The semantic model configuration associated with this dataset.

semanticModelConfiguration

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

useAs

CfnDataSource

The type of the data source. To return a list of all data sources, use `ListDataSources` .

Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.

A set of alternate data source parameters that you want to share for the credentials stored with this data source.

The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the `DataSourceParameters` structure that's in the request with the structures in the `AlternateDataSourceParameters` allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the `AlternateDataSourceParameters` list is null, the `Credentials` originally used with this `DataSourceParameters` are automatically allowed.

alternateDataSourceParameters

The credentials Amazon Quick Sight that uses to connect to your underlying source.

Currently, only credentials based on user name and password are supported.

credentials

An ID for the data source.

This ID is unique per AWS Region for each AWS account.

dataSourceId

The parameters that Amazon Quick Sight uses to connect to your underlying source.

dataSourceParameters

Error information from the last update or the creation of the data source.

errorInfo

A list of resource permissions on the data source.

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

sslProperties

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

vpcConnectionProperties

CfnFolder

The ID for the AWS account where you want to create the folder.

folderId

folderType

The Amazon Resource Name (ARN) for the folder.

parentFolderArn

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit `Permissions` .

sharingModel

A list of tags for the folders that you want to apply overrides to.

Creates a refresh schedule for a dataset in Quick .

CfnRefreshSchedule

The AWS account ID of the account that you are creating a schedule in.

The ID of the dataset that you are creating a refresh schedule for.

schedule

Creates a template from an existing Quick analysis or template.

You can use the resulting template to create a dashboard.

A *template* is an entity in Quick 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.

CfnTemplate

The ID for the AWS account that the group is in.

You use the ID for the AWS account that contains your Amazon Quick Sight account.

An ID for the template that you want to create.

This template is unique per AWS Region ; in each AWS account.

templateId

A list of resource permissions to be set on the template.

The entity that you are using as a source when you create the template.

In `SourceEntity` , you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis. Both of these require an Amazon Resource Name (ARN). For `SourceTemplate` , specify the ARN of the source template. For `SourceAnalysis` , specify the ARN of the source analysis. The `SourceTemplate` ARN can contain any AWS account and any Quick Sight-supported AWS Region .

Use the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Either a `SourceEntity` or a `Definition` must be provided in order for the request to be valid.

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

A description of the current template version being created.

This API operation creates the first version of the template. Every time `UpdateTemplate` is called, a new version is created. Each version of the template maintains a description of the version in the `VersionDescription` field.

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](https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the *Amazon Quick User Guide* .

CfnTheme

The ID of the AWS account where you want to store the new theme.

The ID of the theme that a custom theme will inherit from.

All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use `ListThemes` or choose *Themes* from within an analysis.

baseThemeId

The theme configuration, which contains the theme display properties.

configuration

An ID for the theme that you want to create.

The theme ID is unique per AWS Region in each AWS account.

themeId

A valid grouping of resource permissions to apply to the new theme.

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

A description of the first version of the theme that you're creating.

Every time `UpdateTheme` is called, a new version is created. Each version of the theme has a description of the version in the `VersionDescription` field.

CfnTopic

The ID of the AWS account that you want to create a topic in.

configOptions

customInstructions

The data sets that the topic is associated with.

dataSets

The ID for the topic.

This ID is unique per AWS Region for each AWS account.

topicId

The user experience version of the topic.

userExperienceVersion

CfnVPCConnection

The availability status of the VPC connection.

availabilityStatus

The AWS account ID of the account where you want to create a new VPC connection.

A list of IP addresses of DNS resolver endpoints for the VPC connection.

dnsResolvers

The ARN of the IAM role associated with the VPC connection.

roleArn

The Amazon EC2 security group IDs associated with the VPC connection.

securityGroupIds

A list of subnet IDs for the VPC connection.

subnetIds

A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

The ID of the VPC connection that you're creating.

This ID is a unique identifier for each AWS Region in an AWS account.

AWS quicksight

L1 Constructs12