Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/quicksight.ts?docs=full";

§Classes

QuickSight

§Interfaces

AccountCustomization

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

AccountSettings

The Amazon QuickSight settings associated with your Amazon Web Services account.

ActiveIAMPolicyAssignment

The active Identity and Access Management (IAM) policy assignment.

AdHocFilteringOption

Ad hoc (one-time) filtering option.

AmazonElasticsearchParameters

The parameters for OpenSearch.

AmazonOpenSearchParameters

The parameters for OpenSearch.

Analysis

Metadata structure for an analysis in Amazon QuickSight

AnalysisError

Analysis error.

AnalysisSearchFilter

A filter that you apply when searching for one or more analyses.

AnalysisSourceEntity

The source entity of an analysis.

AnalysisSourceTemplate

The source template of an analysis.

AnalysisSummary

The summary metadata that describes an analysis.

AnonymousUserDashboardEmbeddingConfiguration

Information about the dashboard that you want to embed.

AnonymousUserEmbeddingExperienceConfiguration

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

AthenaParameters

Parameters for Amazon Athena.

AuroraParameters

Parameters for Amazon Aurora.

AuroraPostgreSqlParameters

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

AwsIotAnalyticsParameters

The parameters for IoT Analytics.

BorderStyle

The display options for tile borders for visuals.

CalculatedColumn

A calculated column for a dataset.

CancelIngestionRequest
CancelIngestionResponse
CastColumnTypeOperation

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

ColumnDescription

Metadata that contains a description for a column.

ColumnGroup

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

ColumnGroupColumnSchema

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

ColumnGroupSchema

The column group schema.

ColumnLevelPermissionRule

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.

ColumnSchema

The column schema.

ColumnTag

A tag for a column in a [TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html) structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

CreateAccountCustomizationRequest
CreateAccountCustomizationResponse
CreateAnalysisRequest
CreateAnalysisResponse
CreateColumnsOperation

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

CreateDashboardRequest
CreateDashboardResponse
CreateDataSetRequest
CreateDataSetResponse
CreateDataSourceRequest
CreateDataSourceResponse
CreateFolderMembershipRequest
CreateFolderMembershipResponse
CreateFolderRequest
CreateFolderResponse
CreateGroupMembershipRequest
CreateGroupMembershipResponse
CreateGroupRequest

The request object for this operation.

CreateGroupResponse

The response object for this operation.

CreateIAMPolicyAssignmentRequest
CreateIAMPolicyAssignmentResponse
CreateIngestionRequest
CreateIngestionResponse
CreateNamespaceRequest
CreateNamespaceResponse
CreateTemplateAliasRequest
CreateTemplateAliasResponse
CreateTemplateRequest
CreateTemplateResponse
CreateThemeAliasRequest
CreateThemeAliasResponse
CreateThemeRequest
CreateThemeResponse
CredentialPair

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

CustomSql

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

Dashboard

Dashboard.

DashboardError

Dashboard error.

DashboardPublishOptions

Dashboard publish options.

DashboardSearchFilter

A filter that you apply when searching for dashboards.

DashboardSourceEntity

Dashboard source entity.

DashboardSourceTemplate

Dashboard source template.

DashboardSummary

Dashboard summary.

DashboardVersion

Dashboard version.

DashboardVersionSummary

Dashboard version summary.

DataColorPalette

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.

DataSet

Dataset.

DataSetConfiguration

Dataset configuration.

DataSetReference

Dataset reference.

DataSetSchema

Dataset schema.

DataSetSummary

Dataset summary.

DataSetUsageConfiguration

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

DataSource

The structure of a data source.

DataSourceCredentials

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

DataSourceErrorInfo

Error information for the data source creation or update.

DataSourceParameters

The parameters that Amazon QuickSight 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.

DateTimeParameter

A date-time parameter.

DecimalParameter

A decimal parameter.

DeleteAccountCustomizationRequest
DeleteAccountCustomizationResponse
DeleteAnalysisRequest
DeleteAnalysisResponse
DeleteDashboardRequest
DeleteDashboardResponse
DeleteDataSetRequest
DeleteDataSetResponse
DeleteDataSourceRequest
DeleteDataSourceResponse
DeleteFolderMembershipRequest
DeleteFolderMembershipResponse
DeleteFolderRequest
DeleteFolderResponse
DeleteGroupMembershipRequest
DeleteGroupMembershipResponse
DeleteGroupRequest
DeleteGroupResponse
DeleteIAMPolicyAssignmentRequest
DeleteIAMPolicyAssignmentResponse
DeleteNamespaceRequest
DeleteNamespaceResponse
DeleteTemplateAliasRequest
DeleteTemplateAliasResponse
DeleteTemplateRequest
DeleteTemplateResponse
DeleteThemeAliasRequest
DeleteThemeAliasResponse
DeleteThemeRequest
DeleteThemeResponse
DeleteUserByPrincipalIdRequest
DeleteUserByPrincipalIdResponse
DeleteUserRequest
DeleteUserResponse
DescribeAccountCustomizationRequest
DescribeAccountCustomizationResponse
DescribeAccountSettingsRequest
DescribeAccountSettingsResponse
DescribeAnalysisPermissionsRequest
DescribeAnalysisPermissionsResponse
DescribeAnalysisRequest
DescribeAnalysisResponse
DescribeDashboardPermissionsRequest
DescribeDashboardPermissionsResponse
DescribeDashboardRequest
DescribeDashboardResponse
DescribeDataSetPermissionsRequest
DescribeDataSetPermissionsResponse
DescribeDataSetRequest
DescribeDataSetResponse
DescribeDataSourcePermissionsRequest
DescribeDataSourcePermissionsResponse
DescribeDataSourceRequest
DescribeDataSourceResponse
DescribeFolderPermissionsRequest
DescribeFolderPermissionsResponse
DescribeFolderRequest
DescribeFolderResolvedPermissionsRequest
DescribeFolderResolvedPermissionsResponse
DescribeFolderResponse
DescribeGroupRequest
DescribeGroupResponse
DescribeIAMPolicyAssignmentRequest
DescribeIAMPolicyAssignmentResponse
DescribeIngestionRequest
DescribeIngestionResponse
DescribeIpRestrictionRequest
DescribeIpRestrictionResponse
DescribeNamespaceRequest
DescribeNamespaceResponse
DescribeTemplateAliasRequest
DescribeTemplateAliasResponse
DescribeTemplatePermissionsRequest
DescribeTemplatePermissionsResponse
DescribeTemplateRequest
DescribeTemplateResponse
DescribeThemeAliasRequest
DescribeThemeAliasResponse
DescribeThemePermissionsRequest
DescribeThemePermissionsResponse
DescribeThemeRequest
DescribeThemeResponse
DescribeUserRequest
DescribeUserResponse
ErrorInfo

Error information for the SPICE ingestion of a dataset.

ExasolParameters

The required parameters for connecting to an Exasol data source.

ExportToCSVOption

Export to .csv option.

FieldFolder

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

FilterOperation

A transform operation that filters rows based on a condition.

Folder

A folder in Amazon QuickSight.

FolderMember

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

FolderSearchFilter

A filter to use to search a Amazon QuickSight folder.

FolderSummary

A summary of information about an existing Amazon QuickSight folder.

GenerateEmbedUrlForAnonymousUserRequest
GenerateEmbedUrlForAnonymousUserResponse
GenerateEmbedUrlForRegisteredUserRequest
GenerateEmbedUrlForRegisteredUserResponse
GeoSpatialColumnGroup

Geospatial column group that denotes a hierarchy.

GetDashboardEmbedUrlRequest
GetDashboardEmbedUrlResponse

Output returned from the GetDashboardEmbedUrl operation.

GetSessionEmbedUrlRequest
GetSessionEmbedUrlResponse
Group

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

GroupMember

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

GutterStyle

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

IAMPolicyAssignment

An Identity and Access Management (IAM) policy assignment.

IAMPolicyAssignmentSummary

IAM policy assignment summary.

Ingestion

Information about the SPICE ingestion for a dataset.

InputColumn

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

IntegerParameter

An integer parameter.

JiraParameters

The parameters for Jira.

JoinInstruction

The instructions associated with a join.

JoinKeyProperties

Properties associated with the columns participating in a join.

LinkSharingConfiguration

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

ListAnalysesRequest
ListAnalysesResponse
ListDashboardsRequest
ListDashboardsResponse
ListDashboardVersionsRequest
ListDashboardVersionsResponse
ListDataSetsRequest
ListDataSetsResponse
ListDataSourcesRequest
ListDataSourcesResponse
ListFolderMembersRequest
ListFolderMembersResponse
ListFoldersRequest
ListFoldersResponse
ListGroupMembershipsRequest
ListGroupMembershipsResponse
ListGroupsRequest
ListGroupsResponse
ListIAMPolicyAssignmentsForUserRequest
ListIAMPolicyAssignmentsForUserResponse
ListIAMPolicyAssignmentsRequest
ListIAMPolicyAssignmentsResponse
ListIngestionsRequest
ListIngestionsResponse
ListNamespacesRequest
ListNamespacesResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListTemplateAliasesRequest
ListTemplateAliasesResponse
ListTemplatesRequest
ListTemplatesResponse
ListTemplateVersionsRequest
ListTemplateVersionsResponse
ListThemeAliasesRequest
ListThemeAliasesResponse
ListThemesRequest
ListThemesResponse
ListThemeVersionsRequest
ListThemeVersionsResponse
ListUserGroupsRequest
ListUserGroupsResponse
ListUsersRequest
ListUsersResponse
LogicalTable

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.

LogicalTableSource

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.

ManifestFileLocation

Amazon S3 manifest file location.

MarginStyle

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

MariaDbParameters

The parameters for MariaDB.

MemberIdArnPair

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

MySqlParameters

The parameters for MySQL.

NamespaceError

Errors that occur during namespace creation.

NamespaceInfoV2

The error type.

OracleParameters

The parameters for Oracle.

OutputColumn

Output column.

Parameters

A list of Amazon QuickSight parameters and the list's override values.

PhysicalTable

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.

PostgreSqlParameters

The parameters for PostgreSQL.

PrestoParameters

The parameters for Presto.

ProjectOperation

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

QueueInfo

Information about a queued dataset SPICE ingestion.

RdsParameters

The parameters for Amazon RDS.

RedshiftParameters

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.

RegisteredUserDashboardEmbeddingConfiguration

Information about the dashboard you want to embed.

RegisteredUserEmbeddingExperienceConfiguration

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

RegisteredUserQSearchBarEmbeddingConfiguration

Information about the Q search bar embedding experience.

RegisteredUserQuickSightConsoleEmbeddingConfiguration

Information about the Amazon QuickSight console that you want to embed.

RegisterUserRequest
RegisterUserResponse
RelationalTable

A physical table type for relational data sources.

RenameColumnOperation

A transform operation that renames a column.

ResourcePermission

Permission for the resource.

RestoreAnalysisRequest
RestoreAnalysisResponse
RowInfo

Information about rows for a data set SPICE ingestion.

RowLevelPermissionDataSet

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 Amazon QuickSight User Guide.

RowLevelPermissionTagConfiguration

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

RowLevelPermissionTagRule

A set of rules associated with a tag.

S3Parameters

The parameters for S3.

S3Source

A physical table type for an S3 data source.

SearchAnalysesRequest
SearchAnalysesResponse
SearchDashboardsRequest
SearchDashboardsResponse
SearchFoldersRequest
SearchFoldersResponse
ServiceNowParameters

The parameters for ServiceNow.

SessionTag

The key-value pair used for the row-level security tags feature.

Sheet

A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

SheetControlsOption

Sheet controls option.

SheetStyle

The theme display options for sheets.

SnowflakeParameters

The parameters for Snowflake.

SparkParameters

The parameters for Spark.

SqlServerParameters

The parameters for SQL Server.

SslProperties

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

StringParameter

A string parameter.

Tag

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

TagColumnOperation

A transform operation that tags a column with additional information.

TagResourceRequest
TagResourceResponse
Template

A template object. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an 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.

TemplateAlias

The template alias.

TemplateError

List of errors that occurred when the template version creation failed.

TemplateSourceAnalysis

The source analysis of the template.

TemplateSourceEntity

The source entity of the template.

TemplateSourceTemplate

The source template of the template.

TemplateSummary

The template summary.

TemplateVersion

A version of a template.

TemplateVersionSummary

The template version.

TeradataParameters

The parameters for Teradata.

Theme

Summary information about a theme.

ThemeAlias

An alias for a theme.

ThemeConfiguration

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

ThemeError

Theme error.

ThemeSummary

The theme summary.

ThemeVersion

A version of a theme.

ThemeVersionSummary

The theme version.

TileLayoutStyle

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

TileStyle

Display options related to tiles on a sheet.

TransformOperation

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.

TwitterParameters

The parameters for Twitter.

UIColorPalette

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 Amazon QuickSight in the Amazon QuickSight User Guide.

UntagColumnOperation

A transform operation that removes tags associated with a column.

UntagResourceRequest
UntagResourceResponse
UpdateAccountCustomizationRequest
UpdateAccountCustomizationResponse
UpdateAccountSettingsRequest
UpdateAccountSettingsResponse
UpdateAnalysisPermissionsRequest
UpdateAnalysisPermissionsResponse
UpdateAnalysisRequest
UpdateAnalysisResponse
UpdateDashboardPermissionsRequest
UpdateDashboardPermissionsResponse
UpdateDashboardPublishedVersionRequest
UpdateDashboardPublishedVersionResponse
UpdateDashboardRequest
UpdateDashboardResponse
UpdateDataSetPermissionsRequest
UpdateDataSetPermissionsResponse
UpdateDataSetRequest
UpdateDataSetResponse
UpdateDataSourcePermissionsRequest
UpdateDataSourcePermissionsResponse
UpdateDataSourceRequest
UpdateDataSourceResponse
UpdateFolderPermissionsRequest
UpdateFolderPermissionsResponse
UpdateFolderRequest
UpdateFolderResponse
UpdateGroupRequest
UpdateGroupResponse
UpdateIAMPolicyAssignmentRequest
UpdateIAMPolicyAssignmentResponse
UpdateIpRestrictionRequest
UpdateIpRestrictionResponse
UpdateTemplateAliasRequest
UpdateTemplateAliasResponse
UpdateTemplatePermissionsRequest
UpdateTemplatePermissionsResponse
UpdateTemplateRequest
UpdateTemplateResponse
UpdateThemeAliasRequest
UpdateThemeAliasResponse
UpdateThemePermissionsRequest
UpdateThemePermissionsResponse
UpdateThemeRequest
UpdateThemeResponse
UpdateUserRequest
UpdateUserResponse
UploadSettings

Information about the format for a source file or files.

User

A registered user of Amazon QuickSight.

VpcConnectionProperties

VPC connection properties.

§Type Aliases

AnalysisErrorType
AnalysisFilterAttribute
AssignmentStatus
ColumnDataType
ColumnTagName
DashboardBehavior
DashboardErrorType
DashboardFilterAttribute
DashboardUIState
DataSetImportMode
DataSourceErrorInfoType
DataSourceType
Edition
EmbeddingIdentityType
FileFormat
FilterOperator
FolderFilterAttribute
FolderType
GeoSpatialCountryCode
GeoSpatialDataRole
IdentityStore
IdentityType
IngestionErrorType
IngestionRequestSource
IngestionRequestType

This defines the type of ingestion request. This is returned as part of create ingestion response.

IngestionStatus
IngestionType

This defines the type of ingestion user wants to trigger. This is part of create ingestion request.

InputColumnDataType
JoinType
MemberType
NamespaceErrorType
NamespaceStatus
ResourceStatus
RowLevelPermissionFormatVersion
RowLevelPermissionPolicy
Status
TemplateErrorType
TextQualifier
ThemeErrorType
ThemeType
UserRole