[][src]Crate rusoto_quicksight

Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

If you're using the service, you're probably looking for QuicksightClient and Quicksight.

Structs

ActiveIAMPolicyAssignment

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

AdHocFilteringOption

Ad hoc (one-time) filtering option.

AmazonElasticsearchParameters

Amazon Elasticsearch Service parameters.

AthenaParameters

Amazon Athena parameters.

AuroraParameters

Amazon Aurora parameters.

AuroraPostgreSqlParameters

Amazon Aurora with PostgreSQL compatibility parameters.

AwsIotAnalyticsParameters

AWS IoT Analytics parameters.

CalculatedColumn

A calculated column for a dataset.

CancelIngestionRequest
CancelIngestionResponse
CastColumnTypeOperation

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

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.

ColumnSchema

The column schema.

ColumnTag

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.

CreateColumnsOperation

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

CreateDashboardRequest
CreateDashboardResponse
CreateDataSetRequest
CreateDataSetResponse
CreateDataSourceRequest
CreateDataSourceResponse
CreateGroupMembershipRequest
CreateGroupMembershipResponse
CreateGroupRequest

The request object for this operation.

CreateGroupResponse

The response object for this operation.

CreateIAMPolicyAssignmentRequest
CreateIAMPolicyAssignmentResponse
CreateIngestionRequest
CreateIngestionResponse
CreateTemplateAliasRequest
CreateTemplateAliasResponse
CreateTemplateRequest
CreateTemplateResponse
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.

DashboardSourceEntity

Dashboard source entity.

DashboardSourceTemplate

Dashboard source template.

DashboardSummary

Dashboard summary.

DashboardVersion

Dashboard version.

DashboardVersionSummary

Dashboard version summary.

DataSet

Dataset.

DataSetConfiguration

Dataset configuration.

DataSetReference

Dataset reference.

DataSetSchema

Dataset schema.

DataSetSummary

Dataset summary.

DataSource

The structure of a data source.

DataSourceCredentials

Data source credentials.

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

Date time parameter.

DecimalParameter

Decimal parameter.

DeleteDashboardRequest
DeleteDashboardResponse
DeleteDataSetRequest
DeleteDataSetResponse
DeleteDataSourceRequest
DeleteDataSourceResponse
DeleteGroupMembershipRequest
DeleteGroupMembershipResponse
DeleteGroupRequest
DeleteGroupResponse
DeleteIAMPolicyAssignmentRequest
DeleteIAMPolicyAssignmentResponse
DeleteTemplateAliasRequest
DeleteTemplateAliasResponse
DeleteTemplateRequest
DeleteTemplateResponse
DeleteUserByPrincipalIdRequest

DeleteUserByPrincipalIdResponse
DeleteUserRequest
DeleteUserResponse
DescribeDashboardPermissionsRequest
DescribeDashboardPermissionsResponse
DescribeDashboardRequest
DescribeDashboardResponse
DescribeDataSetPermissionsRequest
DescribeDataSetPermissionsResponse
DescribeDataSetRequest
DescribeDataSetResponse
DescribeDataSourcePermissionsRequest
DescribeDataSourcePermissionsResponse
DescribeDataSourceRequest
DescribeDataSourceResponse
DescribeGroupRequest
DescribeGroupResponse
DescribeIAMPolicyAssignmentRequest
DescribeIAMPolicyAssignmentResponse
DescribeIngestionRequest
DescribeIngestionResponse
DescribeTemplateAliasRequest
DescribeTemplateAliasResponse
DescribeTemplatePermissionsRequest
DescribeTemplatePermissionsResponse
DescribeTemplateRequest
DescribeTemplateResponse
DescribeUserRequest
DescribeUserResponse
ErrorInfo

Error information for the SPICE ingestion of a dataset.

ExportToCSVOption

Export to .csv option.

FilterOperation

A transform operation that filters rows based on a condition.

GeoSpatialColumnGroup

Geospatial column group that denotes a hierarchy.

GetDashboardEmbedUrlRequest
GetDashboardEmbedUrlResponse
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. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.

GroupMember

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

IAMPolicyAssignment

An 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

Integer parameter.

JiraParameters

Jira parameters.

JoinInstruction

Join instruction.

ListDashboardVersionsRequest
ListDashboardVersionsResponse
ListDashboardsRequest
ListDashboardsResponse
ListDataSetsRequest
ListDataSetsResponse
ListDataSourcesRequest
ListDataSourcesResponse
ListGroupMembershipsRequest
ListGroupMembershipsResponse
ListGroupsRequest
ListGroupsResponse
ListIAMPolicyAssignmentsForUserRequest
ListIAMPolicyAssignmentsForUserResponse
ListIAMPolicyAssignmentsRequest
ListIAMPolicyAssignmentsResponse
ListIngestionsRequest
ListIngestionsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListTemplateAliasesRequest
ListTemplateAliasesResponse
ListTemplateVersionsRequest
ListTemplateVersionsResponse
ListTemplatesRequest
ListTemplatesResponse
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.

MariaDbParameters

MariaDB parameters.

MySqlParameters

MySQL parameters.

OutputColumn

Output column.

Parameters

Parameters.

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

PostgreSQL parameters.

PrestoParameters

Presto parameters.

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.

QuicksightClient

A client for the Amazon QuickSight API.

RdsParameters

Amazon RDS parameters.

RedshiftParameters

Amazon Redshift parameters. 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.

RegisterUserRequest
RegisterUserResponse
RelationalTable

A physical table type for relational data sources.

RenameColumnOperation

A transform operation that renames a column.

ResourcePermission

Permission for the resource.

RowInfo

Information about rows for a data set SPICE ingestion.

RowLevelPermissionDataSet

The row-level security configuration for the dataset.

S3Parameters

S3 parameters.

S3Source

A physical table type for as S3 data source.

ServiceNowParameters

ServiceNow parameters.

SheetControlsOption

Sheet controls option.

SnowflakeParameters

Snowflake parameters.

SparkParameters

Spark parameters.

SqlServerParameters

SQL Server parameters.

SslProperties

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

StringParameter

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 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 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.

You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing 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

Teradata parameters.

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

Twitter parameters.

UntagResourceRequest
UntagResourceResponse
UpdateDashboardPermissionsRequest
UpdateDashboardPermissionsResponse
UpdateDashboardPublishedVersionRequest
UpdateDashboardPublishedVersionResponse
UpdateDashboardRequest
UpdateDashboardResponse
UpdateDataSetPermissionsRequest
UpdateDataSetPermissionsResponse
UpdateDataSetRequest
UpdateDataSetResponse
UpdateDataSourcePermissionsRequest
UpdateDataSourcePermissionsResponse
UpdateDataSourceRequest
UpdateDataSourceResponse
UpdateGroupRequest
UpdateGroupResponse
UpdateIAMPolicyAssignmentRequest
UpdateIAMPolicyAssignmentResponse
UpdateTemplateAliasRequest
UpdateTemplateAliasResponse
UpdateTemplatePermissionsRequest
UpdateTemplatePermissionsResponse
UpdateTemplateRequest
UpdateTemplateResponse
UpdateUserRequest
UpdateUserResponse
UploadSettings

Information about the format for a source file or files.

User

A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.

VpcConnectionProperties

VPC connection properties.

Enums

CancelIngestionError

Errors returned by CancelIngestion

CreateDashboardError

Errors returned by CreateDashboard

CreateDataSetError

Errors returned by CreateDataSet

CreateDataSourceError

Errors returned by CreateDataSource

CreateGroupError

Errors returned by CreateGroup

CreateGroupMembershipError

Errors returned by CreateGroupMembership

CreateIAMPolicyAssignmentError

Errors returned by CreateIAMPolicyAssignment

CreateIngestionError

Errors returned by CreateIngestion

CreateTemplateAliasError

Errors returned by CreateTemplateAlias

CreateTemplateError

Errors returned by CreateTemplate

DeleteDashboardError

Errors returned by DeleteDashboard

DeleteDataSetError

Errors returned by DeleteDataSet

DeleteDataSourceError

Errors returned by DeleteDataSource

DeleteGroupError

Errors returned by DeleteGroup

DeleteGroupMembershipError

Errors returned by DeleteGroupMembership

DeleteIAMPolicyAssignmentError

Errors returned by DeleteIAMPolicyAssignment

DeleteTemplateAliasError

Errors returned by DeleteTemplateAlias

DeleteTemplateError

Errors returned by DeleteTemplate

DeleteUserByPrincipalIdError

Errors returned by DeleteUserByPrincipalId

DeleteUserError

Errors returned by DeleteUser

DescribeDashboardError

Errors returned by DescribeDashboard

DescribeDashboardPermissionsError

Errors returned by DescribeDashboardPermissions

DescribeDataSetError

Errors returned by DescribeDataSet

DescribeDataSetPermissionsError

Errors returned by DescribeDataSetPermissions

DescribeDataSourceError

Errors returned by DescribeDataSource

DescribeDataSourcePermissionsError

Errors returned by DescribeDataSourcePermissions

DescribeGroupError

Errors returned by DescribeGroup

DescribeIAMPolicyAssignmentError

Errors returned by DescribeIAMPolicyAssignment

DescribeIngestionError

Errors returned by DescribeIngestion

DescribeTemplateAliasError

Errors returned by DescribeTemplateAlias

DescribeTemplateError

Errors returned by DescribeTemplate

DescribeTemplatePermissionsError

Errors returned by DescribeTemplatePermissions

DescribeUserError

Errors returned by DescribeUser

GetDashboardEmbedUrlError

Errors returned by GetDashboardEmbedUrl

ListDashboardVersionsError

Errors returned by ListDashboardVersions

ListDashboardsError

Errors returned by ListDashboards

ListDataSetsError

Errors returned by ListDataSets

ListDataSourcesError

Errors returned by ListDataSources

ListGroupMembershipsError

Errors returned by ListGroupMemberships

ListGroupsError

Errors returned by ListGroups

ListIAMPolicyAssignmentsError

Errors returned by ListIAMPolicyAssignments

ListIAMPolicyAssignmentsForUserError

Errors returned by ListIAMPolicyAssignmentsForUser

ListIngestionsError

Errors returned by ListIngestions

ListTagsForResourceError

Errors returned by ListTagsForResource

ListTemplateAliasesError

Errors returned by ListTemplateAliases

ListTemplateVersionsError

Errors returned by ListTemplateVersions

ListTemplatesError

Errors returned by ListTemplates

ListUserGroupsError

Errors returned by ListUserGroups

ListUsersError

Errors returned by ListUsers

RegisterUserError

Errors returned by RegisterUser

TagResourceError

Errors returned by TagResource

UntagResourceError

Errors returned by UntagResource

UpdateDashboardError

Errors returned by UpdateDashboard

UpdateDashboardPermissionsError

Errors returned by UpdateDashboardPermissions

UpdateDashboardPublishedVersionError

Errors returned by UpdateDashboardPublishedVersion

UpdateDataSetError

Errors returned by UpdateDataSet

UpdateDataSetPermissionsError

Errors returned by UpdateDataSetPermissions

UpdateDataSourceError

Errors returned by UpdateDataSource

UpdateDataSourcePermissionsError

Errors returned by UpdateDataSourcePermissions

UpdateGroupError

Errors returned by UpdateGroup

UpdateIAMPolicyAssignmentError

Errors returned by UpdateIAMPolicyAssignment

UpdateTemplateAliasError

Errors returned by UpdateTemplateAlias

UpdateTemplateError

Errors returned by UpdateTemplate

UpdateTemplatePermissionsError

Errors returned by UpdateTemplatePermissions

UpdateUserError

Errors returned by UpdateUser

Traits

Quicksight

Trait representing the capabilities of the Amazon QuickSight API. Amazon QuickSight clients implement this trait.