package types

import "github.com/aws/aws-sdk-go-v2/service/quicksight/types"

Index

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	RequestId *string
}

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AccountCustomization

type AccountCustomization struct {

	// The default theme for this QuickSight subscription.
	DefaultTheme *string
}

The customizations associated with your AWS account for QuickSight.

type AccountSettings

type AccountSettings struct {

	// The name associated with the QuickSight subscription in your AWS account.
	AccountName *string

	// The default QuickSight namespace for your AWS account.
	DefaultNamespace *string

	// The edition of QuickSight that you're currently subscribed to.
	Edition Edition

	// The main notification email for your QuickSight subscription.
	NotificationEmail *string
}

The QuickSight settings associated with your AWS account.

type ActiveIAMPolicyAssignment

type ActiveIAMPolicyAssignment struct {

	// A name for the IAM policy assignment.
	AssignmentName *string

	// The Amazon Resource Name (ARN) of the resource.
	PolicyArn *string
}

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

type AdHocFilteringOption

type AdHocFilteringOption struct {

	// Availability status.
	AvailabilityStatus DashboardBehavior
}

Ad hoc (one-time) filtering option.

type AmazonElasticsearchParameters

type AmazonElasticsearchParameters struct {

	// The Amazon Elasticsearch Service domain.
	//
	// This member is required.
	Domain *string
}

Amazon Elasticsearch Service parameters.

type AssignmentStatus

type AssignmentStatus string
const (
	AssignmentStatusEnabled  AssignmentStatus = "ENABLED"
	AssignmentStatusDraft    AssignmentStatus = "DRAFT"
	AssignmentStatusDisabled AssignmentStatus = "DISABLED"
)

Enum values for AssignmentStatus

type AthenaParameters

type AthenaParameters struct {

	// The workgroup that Amazon Athena uses.
	WorkGroup *string
}

Amazon Athena parameters.

type AuroraParameters

type AuroraParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

Amazon Aurora parameters.

type AuroraPostgreSqlParameters

type AuroraPostgreSqlParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

Amazon Aurora with PostgreSQL compatibility parameters.

type AwsIotAnalyticsParameters

type AwsIotAnalyticsParameters struct {

	// Dataset name.
	//
	// This member is required.
	DataSetName *string
}

AWS IoT Analytics parameters.

type BorderStyle

type BorderStyle struct {

	// The option to enable display of borders for visuals.
	Show *bool
}

The display options for tile borders for visuals.

type CalculatedColumn

type CalculatedColumn struct {

	// A unique ID to identify a calculated column. During a dataset update, if the
	// column ID of a calculated column matches that of an existing calculated column,
	// Amazon QuickSight preserves the existing calculated column.
	//
	// This member is required.
	ColumnId *string

	// Column name.
	//
	// This member is required.
	ColumnName *string

	// An expression that defines the calculated column.
	//
	// This member is required.
	Expression *string
}

A calculated column for a dataset.

type CastColumnTypeOperation

type CastColumnTypeOperation struct {

	// Column name.
	//
	// This member is required.
	ColumnName *string

	// New column data type.
	//
	// This member is required.
	NewColumnType ColumnDataType

	// When casting a column from string to datetime type, you can supply a string in a
	// format supported by Amazon QuickSight to denote the source data format.
	Format *string
}

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

type ColumnDataType

type ColumnDataType string
const (
	ColumnDataTypeString   ColumnDataType = "STRING"
	ColumnDataTypeInteger  ColumnDataType = "INTEGER"
	ColumnDataTypeDecimal  ColumnDataType = "DECIMAL"
	ColumnDataTypeDatetime ColumnDataType = "DATETIME"
)

Enum values for ColumnDataType

type ColumnGroup

type ColumnGroup struct {

	// Geospatial column group that denotes a hierarchy.
	GeoSpatialColumnGroup *GeoSpatialColumnGroup
}

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.

type ColumnGroupColumnSchema

type ColumnGroupColumnSchema struct {

	// The name of the column group's column schema.
	Name *string
}

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

type ColumnGroupSchema

type ColumnGroupSchema struct {

	// A structure containing the list of schemas for column group columns.
	ColumnGroupColumnSchemaList []*ColumnGroupColumnSchema

	// The name of the column group schema.
	Name *string
}

The column group schema.

type ColumnSchema

type ColumnSchema struct {

	// The data type of the column schema.
	DataType *string

	// The geographic role of the column schema.
	GeographicRole *string

	// The name of the column schema.
	Name *string
}

The column schema.

type ColumnTag

type ColumnTag struct {

	// A geospatial role for a column.
	ColumnGeographicRole GeoSpatialDataRole
}

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.

type ConcurrentUpdatingException

type ConcurrentUpdatingException struct {
	Message *string

	RequestId *string
}

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

func (*ConcurrentUpdatingException) Error

func (*ConcurrentUpdatingException) ErrorCode

func (e *ConcurrentUpdatingException) ErrorCode() string

func (*ConcurrentUpdatingException) ErrorFault

func (*ConcurrentUpdatingException) ErrorMessage

func (e *ConcurrentUpdatingException) ErrorMessage() string

type ConflictException

type ConflictException struct {
	Message *string

	RequestId *string
}

Updating or deleting a resource can cause an inconsistent state.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type CreateColumnsOperation

type CreateColumnsOperation struct {

	// Calculated columns to create.
	//
	// This member is required.
	Columns []*CalculatedColumn
}

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

type CredentialPair

type CredentialPair struct {

	// Password.
	//
	// This member is required.
	Password *string

	// User name.
	//
	// This member is required.
	Username *string

	// A set of alternate data source parameters that you want to share for these
	// credentials. 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 compares the DataSourceParameters structure that's in the request with the
	// structures in the AlternateDataSourceParameters allowlist. If the structures are
	// an exact match, the request is allowed to use the new data source with the
	// existing credentials. If the AlternateDataSourceParameters list is null, the
	// DataSourceParameters originally used with these Credentials is automatically
	// allowed.
	AlternateDataSourceParameters []*DataSourceParameters
}

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

type CustomSql

type CustomSql struct {

	// The Amazon Resource Name (ARN) of the data source.
	//
	// This member is required.
	DataSourceArn *string

	// A display name for the SQL query result.
	//
	// This member is required.
	Name *string

	// The SQL query.
	//
	// This member is required.
	SqlQuery *string

	// The column schema from the SQL query result set.
	Columns []*InputColumn
}

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

type Dashboard

type Dashboard struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The time that this dataset was created.
	CreatedTime *time.Time

	// Dashboard ID.
	DashboardId *string

	// The last time that this dataset was published.
	LastPublishedTime *time.Time

	// The last time that this dataset was updated.
	LastUpdatedTime *time.Time

	// A display name for the dashboard.
	Name *string

	// Version.
	Version *DashboardVersion
}

Dashboard.

type DashboardBehavior

type DashboardBehavior string
const (
	DashboardBehaviorEnabled  DashboardBehavior = "ENABLED"
	DashboardBehaviorDisabled DashboardBehavior = "DISABLED"
)

Enum values for DashboardBehavior

type DashboardError

type DashboardError struct {

	// Message.
	Message *string

	// Type.
	Type DashboardErrorType
}

Dashboard error.

type DashboardErrorType

type DashboardErrorType string
const (
	DashboardErrorTypeAccess_denied                   DashboardErrorType = "ACCESS_DENIED"
	DashboardErrorTypeSource_not_found                DashboardErrorType = "SOURCE_NOT_FOUND"
	DashboardErrorTypeData_set_not_found              DashboardErrorType = "DATA_SET_NOT_FOUND"
	DashboardErrorTypeInternal_failure                DashboardErrorType = "INTERNAL_FAILURE"
	DashboardErrorTypeParameter_value_incompatible    DashboardErrorType = "PARAMETER_VALUE_INCOMPATIBLE"
	DashboardErrorTypeParameter_type_invalid          DashboardErrorType = "PARAMETER_TYPE_INVALID"
	DashboardErrorTypeParameter_not_found             DashboardErrorType = "PARAMETER_NOT_FOUND"
	DashboardErrorTypeColumn_type_mismatch            DashboardErrorType = "COLUMN_TYPE_MISMATCH"
	DashboardErrorTypeColumn_geographic_role_mismatch DashboardErrorType = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
	DashboardErrorTypeColumn_replacement_missing      DashboardErrorType = "COLUMN_REPLACEMENT_MISSING"
)

Enum values for DashboardErrorType

type DashboardFilterAttribute

type DashboardFilterAttribute string
const (
	DashboardFilterAttributeQuicksight_user DashboardFilterAttribute = "QUICKSIGHT_USER"
)

Enum values for DashboardFilterAttribute

type DashboardPublishOptions

type DashboardPublishOptions struct {

	// Ad hoc (one-time) filtering option.
	AdHocFilteringOption *AdHocFilteringOption

	// Export to .csv option.
	ExportToCSVOption *ExportToCSVOption

	// Sheet controls option.
	SheetControlsOption *SheetControlsOption
}

Dashboard publish options.

type DashboardSearchFilter

type DashboardSearchFilter struct {

	// The comparison operator that you want to use as a filter, for example,
	// "Operator": "StringEquals".
	//
	// This member is required.
	Operator FilterOperator

	// The name of the value that you want to use as a filter, for example, "Name":
	// "QUICKSIGHT_USER".
	Name DashboardFilterAttribute

	// The value of the named item, in this case QUICKSIGHT_USER, that you want to use
	// as a filter, for example, "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
	Value *string
}

A filter that you apply when searching for dashboards.

type DashboardSourceEntity

type DashboardSourceEntity struct {

	// Source template.
	SourceTemplate *DashboardSourceTemplate
}

Dashboard source entity.

type DashboardSourceTemplate

type DashboardSourceTemplate struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	Arn *string

	// Dataset references.
	//
	// This member is required.
	DataSetReferences []*DataSetReference
}

Dashboard source template.

type DashboardSummary

type DashboardSummary struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The time that this dashboard was created.
	CreatedTime *time.Time

	// Dashboard ID.
	DashboardId *string

	// The last time that this dashboard was published.
	LastPublishedTime *time.Time

	// The last time that this dashboard was updated.
	LastUpdatedTime *time.Time

	// A display name for the dashboard.
	Name *string

	// Published version number.
	PublishedVersionNumber *int64
}

Dashboard summary.

type DashboardUIState

type DashboardUIState string
const (
	DashboardUIStateExpanded  DashboardUIState = "EXPANDED"
	DashboardUIStateCollapsed DashboardUIState = "COLLAPSED"
)

Enum values for DashboardUIState

type DashboardVersion

type DashboardVersion struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The time that this dashboard version was created.
	CreatedTime *time.Time

	// The Amazon Resource Numbers (ARNs) for the datasets that are associated with a
	// version of the dashboard.
	DataSetArns []*string

	// Description.
	Description *string

	// Errors.
	Errors []*DashboardError

	// Source entity ARN.
	SourceEntityArn *string

	// The HTTP status of the request.
	Status ResourceStatus

	// Version number.
	VersionNumber *int64
}

Dashboard version.

type DashboardVersionSummary

type DashboardVersionSummary struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The time that this dashboard version was created.
	CreatedTime *time.Time

	// Description.
	Description *string

	// Source entity ARN.
	SourceEntityArn *string

	// The HTTP status of the request.
	Status ResourceStatus

	// Version number.
	VersionNumber *int64
}

Dashboard version summary.

type DataColorPalette

type DataColorPalette struct {

	// The hexadecimal codes for the colors.
	Colors []*string

	// The hexadecimal code of a color that applies to charts where a lack of data is
	// highlighted.
	EmptyFillColor *string

	// The minimum and maximum hexadecimal codes that describe a color gradient.
	MinMaxGradient []*string
}

The theme colors that are used for data colors in charts. The colors description is a hexidecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

type DataSet

type DataSet struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// Groupings of columns that work together in certain Amazon QuickSight features.
	// Currently, only geospatial hierarchy is supported.
	ColumnGroups []*ColumnGroup

	// The amount of SPICE capacity used by this dataset. This is 0 if the dataset
	// isn't imported into SPICE.
	ConsumedSpiceCapacityInBytes *int64

	// The time that this dataset was created.
	CreatedTime *time.Time

	// The ID of the dataset.
	DataSetId *string

	// Indicates whether you want to import the data into SPICE.
	ImportMode DataSetImportMode

	// The last time that this dataset was updated.
	LastUpdatedTime *time.Time

	// Configures the combination and transformation of the data from the physical
	// tables.
	LogicalTableMap map[string]*LogicalTable

	// A display name for the dataset.
	Name *string

	// The list of columns after all transforms. These columns are available in
	// templates, analyses, and dashboards.
	OutputColumns []*OutputColumn

	// Declares the physical tables that are available in the underlying data sources.
	PhysicalTableMap map[string]*PhysicalTable

	// The row-level security configuration for the dataset.
	RowLevelPermissionDataSet *RowLevelPermissionDataSet
}

Dataset.

type DataSetConfiguration

type DataSetConfiguration struct {

	// A structure containing the list of column group schemas.
	ColumnGroupSchemaList []*ColumnGroupSchema

	// Dataset schema.
	DataSetSchema *DataSetSchema

	// Placeholder.
	Placeholder *string
}

Dataset configuration.

type DataSetImportMode

type DataSetImportMode string
const (
	DataSetImportModeSpice        DataSetImportMode = "SPICE"
	DataSetImportModeDirect_query DataSetImportMode = "DIRECT_QUERY"
)

Enum values for DataSetImportMode

type DataSetReference

type DataSetReference struct {

	// Dataset Amazon Resource Name (ARN).
	//
	// This member is required.
	DataSetArn *string

	// Dataset placeholder.
	//
	// This member is required.
	DataSetPlaceholder *string
}

Dataset reference.

type DataSetSchema

type DataSetSchema struct {

	// A structure containing the list of column schemas.
	ColumnSchemaList []*ColumnSchema
}

Dataset schema.

type DataSetSummary

type DataSetSummary struct {

	// The Amazon Resource Name (ARN) of the dataset.
	Arn *string

	// The time that this dataset was created.
	CreatedTime *time.Time

	// The ID of the dataset.
	DataSetId *string

	// Indicates whether you want to import the data into SPICE.
	ImportMode DataSetImportMode

	// The last time that this dataset was updated.
	LastUpdatedTime *time.Time

	// A display name for the dataset.
	Name *string

	// The row-level security configuration for the dataset.
	RowLevelPermissionDataSet *RowLevelPermissionDataSet
}

Dataset summary.

type DataSource

type DataSource struct {

	// 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 compares the DataSourceParameters structure that's in
	// the request with the structures in the AlternateDataSourceParameters allowlist.
	// 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 []*DataSourceParameters

	// The Amazon Resource Name (ARN) of the data source.
	Arn *string

	// The time that this data source was created.
	CreatedTime *time.Time

	// The ID of the data source. This ID is unique per AWS Region for each AWS
	// account.
	DataSourceId *string

	// The parameters that Amazon QuickSight uses to connect to your underlying source.
	// This is a variant type structure. For this structure to be valid, only one of
	// the attributes can be non-null.
	DataSourceParameters *DataSourceParameters

	// Error information from the last update or the creation of the data source.
	ErrorInfo *DataSourceErrorInfo

	// The last time that this data source was updated.
	LastUpdatedTime *time.Time

	// A display name for the data source.
	Name *string

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

	// The HTTP status of the request.
	Status ResourceStatus

	// The type of the data source. This type indicates which database engine the data
	// source connects to.
	Type DataSourceType

	// The VPC connection information. You need to use this parameter only when you
	// want QuickSight to use a VPC connection when connecting to your underlying
	// source.
	VpcConnectionProperties *VpcConnectionProperties
}

The structure of a data source.

type DataSourceCredentials

type DataSourceCredentials struct {

	// The Amazon Resource Name (ARN) of a data source that has the credential pair
	// that you want to use. When CopySourceArn is not null, the credential pair from
	// the data source in the ARN is used as the credentials for the
	// DataSourceCredentials structure.
	CopySourceArn *string

	// Credential pair. For more information, see CredentialPair.
	CredentialPair *CredentialPair
}

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

type DataSourceErrorInfo

type DataSourceErrorInfo struct {

	// Error message.
	Message *string

	// Error type.
	Type DataSourceErrorInfoType
}

Error information for the data source creation or update.

type DataSourceErrorInfoType

type DataSourceErrorInfoType string
const (
	DataSourceErrorInfoTypeAccess_denied                DataSourceErrorInfoType = "ACCESS_DENIED"
	DataSourceErrorInfoTypeCopy_source_not_found        DataSourceErrorInfoType = "COPY_SOURCE_NOT_FOUND"
	DataSourceErrorInfoTypeTimeout                      DataSourceErrorInfoType = "TIMEOUT"
	DataSourceErrorInfoTypeEngine_version_not_supported DataSourceErrorInfoType = "ENGINE_VERSION_NOT_SUPPORTED"
	DataSourceErrorInfoTypeUnknown_host                 DataSourceErrorInfoType = "UNKNOWN_HOST"
	DataSourceErrorInfoTypeGeneric_sql_failure          DataSourceErrorInfoType = "GENERIC_SQL_FAILURE"
	DataSourceErrorInfoTypeConflict                     DataSourceErrorInfoType = "CONFLICT"
	DataSourceErrorInfoTypeUnknown                      DataSourceErrorInfoType = "UNKNOWN"
)

Enum values for DataSourceErrorInfoType

type DataSourceParameters

type DataSourceParameters struct {

	// Amazon Elasticsearch Service parameters.
	AmazonElasticsearchParameters *AmazonElasticsearchParameters

	// Amazon Athena parameters.
	AthenaParameters *AthenaParameters

	// Amazon Aurora MySQL parameters.
	AuroraParameters *AuroraParameters

	// Aurora PostgreSQL parameters.
	AuroraPostgreSqlParameters *AuroraPostgreSqlParameters

	// AWS IoT Analytics parameters.
	AwsIotAnalyticsParameters *AwsIotAnalyticsParameters

	// Jira parameters.
	JiraParameters *JiraParameters

	// MariaDB parameters.
	MariaDbParameters *MariaDbParameters

	// MySQL parameters.
	MySqlParameters *MySqlParameters

	// PostgreSQL parameters.
	PostgreSqlParameters *PostgreSqlParameters

	// Presto parameters.
	PrestoParameters *PrestoParameters

	// Amazon RDS parameters.
	RdsParameters *RdsParameters

	// Amazon Redshift parameters.
	RedshiftParameters *RedshiftParameters

	// S3 parameters.
	S3Parameters *S3Parameters

	// ServiceNow parameters.
	ServiceNowParameters *ServiceNowParameters

	// Snowflake parameters.
	SnowflakeParameters *SnowflakeParameters

	// Spark parameters.
	SparkParameters *SparkParameters

	// SQL Server parameters.
	SqlServerParameters *SqlServerParameters

	// Teradata parameters.
	TeradataParameters *TeradataParameters

	// Twitter parameters.
	TwitterParameters *TwitterParameters
}

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.

type DataSourceType

type DataSourceType string
const (
	DataSourceTypeAdobe_analytics      DataSourceType = "ADOBE_ANALYTICS"
	DataSourceTypeAmazon_elasticsearch DataSourceType = "AMAZON_ELASTICSEARCH"
	DataSourceTypeAthena               DataSourceType = "ATHENA"
	DataSourceTypeAurora               DataSourceType = "AURORA"
	DataSourceTypeAurora_postgresql    DataSourceType = "AURORA_POSTGRESQL"
	DataSourceTypeAws_iot_analytics    DataSourceType = "AWS_IOT_ANALYTICS"
	DataSourceTypeGithub               DataSourceType = "GITHUB"
	DataSourceTypeJira                 DataSourceType = "JIRA"
	DataSourceTypeMariadb              DataSourceType = "MARIADB"
	DataSourceTypeMysql                DataSourceType = "MYSQL"
	DataSourceTypePostgresql           DataSourceType = "POSTGRESQL"
	DataSourceTypePresto               DataSourceType = "PRESTO"
	DataSourceTypeRedshift             DataSourceType = "REDSHIFT"
	DataSourceTypeS3                   DataSourceType = "S3"
	DataSourceTypeSalesforce           DataSourceType = "SALESFORCE"
	DataSourceTypeServicenow           DataSourceType = "SERVICENOW"
	DataSourceTypeSnowflake            DataSourceType = "SNOWFLAKE"
	DataSourceTypeSpark                DataSourceType = "SPARK"
	DataSourceTypeSqlserver            DataSourceType = "SQLSERVER"
	DataSourceTypeTeradata             DataSourceType = "TERADATA"
	DataSourceTypeTwitter              DataSourceType = "TWITTER"
)

Enum values for DataSourceType

type DateTimeParameter

type DateTimeParameter struct {

	// A display name for the dataset.
	//
	// This member is required.
	Name *string

	// Values.
	//
	// This member is required.
	Values []*time.Time
}

Date time parameter.

type DecimalParameter

type DecimalParameter struct {

	// A display name for the dataset.
	//
	// This member is required.
	Name *string

	// Values.
	//
	// This member is required.
	Values []*float64
}

Decimal parameter.

type DomainNotWhitelistedException

type DomainNotWhitelistedException struct {
	Message *string

	RequestId *string
}

The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.

func (*DomainNotWhitelistedException) Error

func (*DomainNotWhitelistedException) ErrorCode

func (e *DomainNotWhitelistedException) ErrorCode() string

func (*DomainNotWhitelistedException) ErrorFault

func (*DomainNotWhitelistedException) ErrorMessage

func (e *DomainNotWhitelistedException) ErrorMessage() string

type Edition

type Edition string
const (
	EditionStandard   Edition = "STANDARD"
	EditionEnterprise Edition = "ENTERPRISE"
)

Enum values for Edition

type ErrorInfo

type ErrorInfo struct {

	// Error message.
	Message *string

	// Error type.
	Type IngestionErrorType
}

Error information for the SPICE ingestion of a dataset.

type ExceptionResourceType

type ExceptionResourceType string
const (
	ExceptionResourceTypeUser                 ExceptionResourceType = "USER"
	ExceptionResourceTypeGroup                ExceptionResourceType = "GROUP"
	ExceptionResourceTypeNamespace            ExceptionResourceType = "NAMESPACE"
	ExceptionResourceTypeAccount_settings     ExceptionResourceType = "ACCOUNT_SETTINGS"
	ExceptionResourceTypeIampolicy_assignment ExceptionResourceType = "IAMPOLICY_ASSIGNMENT"
	ExceptionResourceTypeData_source          ExceptionResourceType = "DATA_SOURCE"
	ExceptionResourceTypeData_set             ExceptionResourceType = "DATA_SET"
	ExceptionResourceTypeVpc_connection       ExceptionResourceType = "VPC_CONNECTION"
	ExceptionResourceTypeIngestion            ExceptionResourceType = "INGESTION"
)

Enum values for ExceptionResourceType

type ExportToCSVOption

type ExportToCSVOption struct {

	// Availability status.
	AvailabilityStatus DashboardBehavior
}

Export to .csv option.

type FileFormat

type FileFormat string
const (
	FileFormatCsv  FileFormat = "CSV"
	FileFormatTsv  FileFormat = "TSV"
	FileFormatClf  FileFormat = "CLF"
	FileFormatElf  FileFormat = "ELF"
	FileFormatXlsx FileFormat = "XLSX"
	FileFormatJson FileFormat = "JSON"
)

Enum values for FileFormat

type FilterOperation

type FilterOperation struct {

	// An expression that must evaluate to a Boolean value. Rows for which the
	// expression evaluates to true are kept in the dataset.
	//
	// This member is required.
	ConditionExpression *string
}

A transform operation that filters rows based on a condition.

type FilterOperator

type FilterOperator string
const (
	FilterOperatorStringequals FilterOperator = "StringEquals"
)

Enum values for FilterOperator

type GeoSpatialColumnGroup

type GeoSpatialColumnGroup struct {

	// Columns in this hierarchy.
	//
	// This member is required.
	Columns []*string

	// Country code.
	//
	// This member is required.
	CountryCode GeoSpatialCountryCode

	// A display name for the hierarchy.
	//
	// This member is required.
	Name *string
}

Geospatial column group that denotes a hierarchy.

type GeoSpatialCountryCode

type GeoSpatialCountryCode string
const (
	GeoSpatialCountryCodeUs GeoSpatialCountryCode = "US"
)

Enum values for GeoSpatialCountryCode

type GeoSpatialDataRole

type GeoSpatialDataRole string
const (
	GeoSpatialDataRoleCountry   GeoSpatialDataRole = "COUNTRY"
	GeoSpatialDataRoleState     GeoSpatialDataRole = "STATE"
	GeoSpatialDataRoleCounty    GeoSpatialDataRole = "COUNTY"
	GeoSpatialDataRoleCity      GeoSpatialDataRole = "CITY"
	GeoSpatialDataRolePostcode  GeoSpatialDataRole = "POSTCODE"
	GeoSpatialDataRoleLongitude GeoSpatialDataRole = "LONGITUDE"
	GeoSpatialDataRoleLatitude  GeoSpatialDataRole = "LATITUDE"
)

Enum values for GeoSpatialDataRole

type Group

type Group struct {

	// The Amazon Resource Name (ARN) for the group.
	Arn *string

	// The group description.
	Description *string

	// The name of the group.
	GroupName *string

	// The principal ID of the group.
	PrincipalId *string
}

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.

type GroupMember

type GroupMember struct {

	// The Amazon Resource Name (ARN) for the group member (user).
	Arn *string

	// The name of the group member (user).
	MemberName *string
}

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

type GutterStyle

type GutterStyle struct {

	// This Boolean value controls whether to display a gutter space between sheet
	// tiles.
	Show *bool
}

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

type IAMPolicyAssignment

type IAMPolicyAssignment struct {

	// Assignment ID.
	AssignmentId *string

	// Assignment name.
	AssignmentName *string

	// Assignment status.
	AssignmentStatus AssignmentStatus

	// The AWS account ID.
	AwsAccountId *string

	// Identities.
	Identities map[string][]*string

	// The Amazon Resource Name (ARN) for the IAM policy.
	PolicyArn *string
}

An AWS Identity and Access Management (IAM) policy assignment.

type IAMPolicyAssignmentSummary

type IAMPolicyAssignmentSummary struct {

	// Assignment name.
	AssignmentName *string

	// Assignment status.
	AssignmentStatus AssignmentStatus
}

IAM policy assignment summary.

type IdentityStore

type IdentityStore string
const (
	IdentityStoreQuicksight IdentityStore = "QUICKSIGHT"
)

Enum values for IdentityStore

type IdentityType

type IdentityType string
const (
	IdentityTypeIam        IdentityType = "IAM"
	IdentityTypeQuicksight IdentityType = "QUICKSIGHT"
)

Enum values for IdentityType

type IdentityTypeNotSupportedException

type IdentityTypeNotSupportedException struct {
	Message *string

	RequestId *string
}

The identity type specified isn't supported. Supported identity types include IAM and QUICKSIGHT.

func (*IdentityTypeNotSupportedException) Error

func (*IdentityTypeNotSupportedException) ErrorCode

func (*IdentityTypeNotSupportedException) ErrorFault

func (*IdentityTypeNotSupportedException) ErrorMessage

func (e *IdentityTypeNotSupportedException) ErrorMessage() string

type Ingestion

type Ingestion struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	Arn *string

	// The time that this ingestion started.
	//
	// This member is required.
	CreatedTime *time.Time

	// Ingestion status.
	//
	// This member is required.
	IngestionStatus IngestionStatus

	// Error information for this ingestion.
	ErrorInfo *ErrorInfo

	// Ingestion ID.
	IngestionId *string

	// The size of the data ingested, in bytes.
	IngestionSizeInBytes *int64

	// The time that this ingestion took, measured in seconds.
	IngestionTimeInSeconds *int64

	// Information about a queued dataset SPICE ingestion.
	QueueInfo *QueueInfo

	// Event source for this ingestion.
	RequestSource IngestionRequestSource

	// Type of this ingestion.
	RequestType IngestionRequestType

	// Information about rows for a data set SPICE ingestion.
	RowInfo *RowInfo
}

Information about the SPICE ingestion for a dataset.

type IngestionErrorType

type IngestionErrorType string
const (
	IngestionErrorTypeFailure_to_assume_role             IngestionErrorType = "FAILURE_TO_ASSUME_ROLE"
	IngestionErrorTypeIngestion_superseded               IngestionErrorType = "INGESTION_SUPERSEDED"
	IngestionErrorTypeIngestion_canceled                 IngestionErrorType = "INGESTION_CANCELED"
	IngestionErrorTypeData_set_deleted                   IngestionErrorType = "DATA_SET_DELETED"
	IngestionErrorTypeData_set_not_spice                 IngestionErrorType = "DATA_SET_NOT_SPICE"
	IngestionErrorTypeS3_uploaded_file_deleted           IngestionErrorType = "S3_UPLOADED_FILE_DELETED"
	IngestionErrorTypeS3_manifest_error                  IngestionErrorType = "S3_MANIFEST_ERROR"
	IngestionErrorTypeData_tolerance_exception           IngestionErrorType = "DATA_TOLERANCE_EXCEPTION"
	IngestionErrorTypeSpice_table_not_found              IngestionErrorType = "SPICE_TABLE_NOT_FOUND"
	IngestionErrorTypeData_set_size_limit_exceeded       IngestionErrorType = "DATA_SET_SIZE_LIMIT_EXCEEDED"
	IngestionErrorTypeRow_size_limit_exceeded            IngestionErrorType = "ROW_SIZE_LIMIT_EXCEEDED"
	IngestionErrorTypeAccount_capacity_limit_exceeded    IngestionErrorType = "ACCOUNT_CAPACITY_LIMIT_EXCEEDED"
	IngestionErrorTypeCustomer_error                     IngestionErrorType = "CUSTOMER_ERROR"
	IngestionErrorTypeData_source_not_found              IngestionErrorType = "DATA_SOURCE_NOT_FOUND"
	IngestionErrorTypeIam_role_not_available             IngestionErrorType = "IAM_ROLE_NOT_AVAILABLE"
	IngestionErrorTypeConnection_failure                 IngestionErrorType = "CONNECTION_FAILURE"
	IngestionErrorTypeSql_table_not_found                IngestionErrorType = "SQL_TABLE_NOT_FOUND"
	IngestionErrorTypePermission_denied                  IngestionErrorType = "PERMISSION_DENIED"
	IngestionErrorTypeSsl_certificate_validation_failure IngestionErrorType = "SSL_CERTIFICATE_VALIDATION_FAILURE"
	IngestionErrorTypeOauth_token_failure                IngestionErrorType = "OAUTH_TOKEN_FAILURE"
	IngestionErrorTypeSource_api_limit_exceeded_failure  IngestionErrorType = "SOURCE_API_LIMIT_EXCEEDED_FAILURE"
	IngestionErrorTypePassword_authentication_failure    IngestionErrorType = "PASSWORD_AUTHENTICATION_FAILURE"
	IngestionErrorTypeSql_schema_mismatch_error          IngestionErrorType = "SQL_SCHEMA_MISMATCH_ERROR"
	IngestionErrorTypeInvalid_date_format                IngestionErrorType = "INVALID_DATE_FORMAT"
	IngestionErrorTypeInvalid_dataprep_syntax            IngestionErrorType = "INVALID_DATAPREP_SYNTAX"
	IngestionErrorTypeSource_resource_limit_exceeded     IngestionErrorType = "SOURCE_RESOURCE_LIMIT_EXCEEDED"
	IngestionErrorTypeSql_invalid_parameter_value        IngestionErrorType = "SQL_INVALID_PARAMETER_VALUE"
	IngestionErrorTypeQuery_timeout                      IngestionErrorType = "QUERY_TIMEOUT"
	IngestionErrorTypeSql_numeric_overflow               IngestionErrorType = "SQL_NUMERIC_OVERFLOW"
	IngestionErrorTypeUnresolvable_host                  IngestionErrorType = "UNRESOLVABLE_HOST"
	IngestionErrorTypeUnroutable_host                    IngestionErrorType = "UNROUTABLE_HOST"
	IngestionErrorTypeSql_exception                      IngestionErrorType = "SQL_EXCEPTION"
	IngestionErrorTypeS3_file_inaccessible               IngestionErrorType = "S3_FILE_INACCESSIBLE"
	IngestionErrorTypeIot_file_not_found                 IngestionErrorType = "IOT_FILE_NOT_FOUND"
	IngestionErrorTypeIot_data_set_file_empty            IngestionErrorType = "IOT_DATA_SET_FILE_EMPTY"
	IngestionErrorTypeInvalid_data_source_config         IngestionErrorType = "INVALID_DATA_SOURCE_CONFIG"
	IngestionErrorTypeData_source_auth_failed            IngestionErrorType = "DATA_SOURCE_AUTH_FAILED"
	IngestionErrorTypeData_source_connection_failed      IngestionErrorType = "DATA_SOURCE_CONNECTION_FAILED"
	IngestionErrorTypeFailure_to_process_json_file       IngestionErrorType = "FAILURE_TO_PROCESS_JSON_FILE"
	IngestionErrorTypeInternal_service_error             IngestionErrorType = "INTERNAL_SERVICE_ERROR"
)

Enum values for IngestionErrorType

type IngestionRequestSource

type IngestionRequestSource string
const (
	IngestionRequestSourceManual    IngestionRequestSource = "MANUAL"
	IngestionRequestSourceScheduled IngestionRequestSource = "SCHEDULED"
)

Enum values for IngestionRequestSource

type IngestionRequestType

type IngestionRequestType string
const (
	IngestionRequestTypeInitial_ingestion   IngestionRequestType = "INITIAL_INGESTION"
	IngestionRequestTypeEdit                IngestionRequestType = "EDIT"
	IngestionRequestTypeIncremental_refresh IngestionRequestType = "INCREMENTAL_REFRESH"
	IngestionRequestTypeFull_refresh        IngestionRequestType = "FULL_REFRESH"
)

Enum values for IngestionRequestType

type IngestionStatus

type IngestionStatus string
const (
	IngestionStatusInitialized IngestionStatus = "INITIALIZED"
	IngestionStatusQueued      IngestionStatus = "QUEUED"
	IngestionStatusRunning     IngestionStatus = "RUNNING"
	IngestionStatusFailed      IngestionStatus = "FAILED"
	IngestionStatusCompleted   IngestionStatus = "COMPLETED"
	IngestionStatusCancelled   IngestionStatus = "CANCELLED"
)

Enum values for IngestionStatus

type InputColumn

type InputColumn struct {

	// The name of this column in the underlying data source.
	//
	// This member is required.
	Name *string

	// The data type of the column.
	//
	// This member is required.
	Type InputColumnDataType
}

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

type InputColumnDataType

type InputColumnDataType string
const (
	InputColumnDataTypeString   InputColumnDataType = "STRING"
	InputColumnDataTypeInteger  InputColumnDataType = "INTEGER"
	InputColumnDataTypeDecimal  InputColumnDataType = "DECIMAL"
	InputColumnDataTypeDatetime InputColumnDataType = "DATETIME"
	InputColumnDataTypeBit      InputColumnDataType = "BIT"
	InputColumnDataTypeBoolean  InputColumnDataType = "BOOLEAN"
	InputColumnDataTypeJson     InputColumnDataType = "JSON"
)

Enum values for InputColumnDataType

type IntegerParameter

type IntegerParameter struct {

	// A display name for the dataset.
	//
	// This member is required.
	Name *string

	// Values.
	//
	// This member is required.
	Values []*int64
}

Integer parameter.

type InternalFailureException

type InternalFailureException struct {
	Message *string

	RequestId *string
}

An internal failure occurred.

func (*InternalFailureException) Error

func (e *InternalFailureException) Error() string

func (*InternalFailureException) ErrorCode

func (e *InternalFailureException) ErrorCode() string

func (*InternalFailureException) ErrorFault

func (e *InternalFailureException) ErrorFault() smithy.ErrorFault

func (*InternalFailureException) ErrorMessage

func (e *InternalFailureException) ErrorMessage() string

type InvalidNextTokenException

type InvalidNextTokenException struct {
	Message *string

	RequestId *string
}

The NextToken value isn't valid.

func (*InvalidNextTokenException) Error

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault

func (*InvalidNextTokenException) ErrorMessage

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidParameterValueException

type InvalidParameterValueException struct {
	Message *string

	RequestId *string
}

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

func (*InvalidParameterValueException) Error

func (*InvalidParameterValueException) ErrorCode

func (e *InvalidParameterValueException) ErrorCode() string

func (*InvalidParameterValueException) ErrorFault

func (*InvalidParameterValueException) ErrorMessage

func (e *InvalidParameterValueException) ErrorMessage() string

type JiraParameters

type JiraParameters struct {

	// The base URL of the Jira site.
	//
	// This member is required.
	SiteBaseUrl *string
}

Jira parameters.

type JoinInstruction

type JoinInstruction struct {

	// Left operand.
	//
	// This member is required.
	LeftOperand *string

	// On Clause.
	//
	// This member is required.
	OnClause *string

	// Right operand.
	//
	// This member is required.
	RightOperand *string

	// Type.
	//
	// This member is required.
	Type JoinType
}

Join instruction.

type JoinType

type JoinType string
const (
	JoinTypeInner JoinType = "INNER"
	JoinTypeOuter JoinType = "OUTER"
	JoinTypeLeft  JoinType = "LEFT"
	JoinTypeRight JoinType = "RIGHT"
)

Enum values for JoinType

type LimitExceededException

type LimitExceededException struct {
	Message *string

	RequestId    *string
	ResourceType ExceptionResourceType
}

A limit is exceeded.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

type LogicalTable

type LogicalTable struct {

	// A display name for the logical table.
	//
	// This member is required.
	Alias *string

	// Source of this logical table.
	//
	// This member is required.
	Source *LogicalTableSource

	// Transform operations that act on this logical table.
	DataTransforms []*TransformOperation
}

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.

type LogicalTableSource

type LogicalTableSource struct {

	// Specifies the result of a join of two logical tables.
	JoinInstruction *JoinInstruction

	// Physical table ID.
	PhysicalTableId *string
}

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.

type ManifestFileLocation

type ManifestFileLocation struct {

	// Amazon S3 bucket.
	//
	// This member is required.
	Bucket *string

	// Amazon S3 key that identifies an object.
	//
	// This member is required.
	Key *string
}

Amazon S3 manifest file location.

type MarginStyle

type MarginStyle struct {

	// This Boolean value controls whether to display sheet margins.
	Show *bool
}

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

type MariaDbParameters

type MariaDbParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

MariaDB parameters.

type MySqlParameters

type MySqlParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

MySQL parameters.

type NamespaceError

type NamespaceError struct {

	// The message for the error.
	Message *string

	// The error type.
	Type NamespaceErrorType
}

Errors that occur during namespace creation.

type NamespaceErrorType

type NamespaceErrorType string
const (
	NamespaceErrorTypePermission_denied      NamespaceErrorType = "PERMISSION_DENIED"
	NamespaceErrorTypeInternal_service_error NamespaceErrorType = "INTERNAL_SERVICE_ERROR"
)

Enum values for NamespaceErrorType

type NamespaceInfoV2

type NamespaceInfoV2 struct {

	// The namespace ARN.
	Arn *string

	// The namespace AWS Region.
	CapacityRegion *string

	// The creation status of a namespace that is not yet completely created.
	CreationStatus NamespaceStatus

	// The identity store used for the namespace.
	IdentityStore IdentityStore

	// The name of the error.
	Name *string

	// An error that occured when the namespace was created.
	NamespaceError *NamespaceError
}

The error type.

type NamespaceStatus

type NamespaceStatus string
const (
	NamespaceStatusCreated               NamespaceStatus = "CREATED"
	NamespaceStatusCreating              NamespaceStatus = "CREATING"
	NamespaceStatusDeleting              NamespaceStatus = "DELETING"
	NamespaceStatusRetryable_failure     NamespaceStatus = "RETRYABLE_FAILURE"
	NamespaceStatusNon_retryable_failure NamespaceStatus = "NON_RETRYABLE_FAILURE"
)

Enum values for NamespaceStatus

type OutputColumn

type OutputColumn struct {

	// A display name for the dataset.
	Name *string

	// Type.
	Type ColumnDataType
}

Output column.

type Parameters

type Parameters struct {

	// DateTime parameters.
	DateTimeParameters []*DateTimeParameter

	// Decimal parameters.
	DecimalParameters []*DecimalParameter

	// Integer parameters.
	IntegerParameters []*IntegerParameter

	// String parameters.
	StringParameters []*StringParameter
}

Parameters.

type PhysicalTable

type PhysicalTable struct {

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

	// A physical table type for relational data sources.
	RelationalTable *RelationalTable

	// A physical table type for as S3 data source.
	S3Source *S3Source
}

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.

type PostgreSqlParameters

type PostgreSqlParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

PostgreSQL parameters.

type PreconditionNotMetException

type PreconditionNotMetException struct {
	Message *string

	RequestId *string
}

One or more preconditions aren't met.

func (*PreconditionNotMetException) Error

func (*PreconditionNotMetException) ErrorCode

func (e *PreconditionNotMetException) ErrorCode() string

func (*PreconditionNotMetException) ErrorFault

func (*PreconditionNotMetException) ErrorMessage

func (e *PreconditionNotMetException) ErrorMessage() string

type PrestoParameters

type PrestoParameters struct {

	// Catalog.
	//
	// This member is required.
	Catalog *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

Presto parameters.

type ProjectOperation

type ProjectOperation struct {

	// Projected columns.
	//
	// This member is required.
	ProjectedColumns []*string
}

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

type QueueInfo

type QueueInfo struct {

	// The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing
	// ingestion to complete.
	//
	// This member is required.
	QueuedIngestion *string

	// The ID of the queued ingestion.
	//
	// This member is required.
	WaitingOnIngestion *string
}

Information about a queued dataset SPICE ingestion.

type QuickSightUserNotFoundException

type QuickSightUserNotFoundException struct {
	Message *string

	RequestId *string
}

The user with the provided name isn't found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.

func (*QuickSightUserNotFoundException) Error

func (*QuickSightUserNotFoundException) ErrorCode

func (e *QuickSightUserNotFoundException) ErrorCode() string

func (*QuickSightUserNotFoundException) ErrorFault

func (*QuickSightUserNotFoundException) ErrorMessage

func (e *QuickSightUserNotFoundException) ErrorMessage() string

type RdsParameters

type RdsParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Instance ID.
	//
	// This member is required.
	InstanceId *string
}

Amazon RDS parameters.

type RedshiftParameters

type RedshiftParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Cluster ID. This field can be blank if the Host and Port are provided.
	ClusterId *string

	// Host. This field can be blank if ClusterId is provided.
	Host *string

	// Port. This field can be blank if the ClusterId is provided.
	Port *int32
}

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.

type RelationalTable

type RelationalTable struct {

	// The Amazon Resource Name (ARN) for the data source.
	//
	// This member is required.
	DataSourceArn *string

	// The column schema of the table.
	//
	// This member is required.
	InputColumns []*InputColumn

	// The name of the relational table.
	//
	// This member is required.
	Name *string

	// The schema name. This name applies to certain relational database engines.
	Schema *string
}

A physical table type for relational data sources.

type RenameColumnOperation

type RenameColumnOperation struct {

	// The name of the column to be renamed.
	//
	// This member is required.
	ColumnName *string

	// The new name for the column.
	//
	// This member is required.
	NewColumnName *string
}

A transform operation that renames a column.

type ResourceExistsException

type ResourceExistsException struct {
	Message *string

	ResourceType ExceptionResourceType
	RequestId    *string
}

The resource specified already exists.

func (*ResourceExistsException) Error

func (e *ResourceExistsException) Error() string

func (*ResourceExistsException) ErrorCode

func (e *ResourceExistsException) ErrorCode() string

func (*ResourceExistsException) ErrorFault

func (e *ResourceExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceExistsException) ErrorMessage

func (e *ResourceExistsException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	RequestId    *string
	ResourceType ExceptionResourceType
}

One or more resources can't be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourcePermission

type ResourcePermission struct {

	// The action to grant or revoke permissions on, for example
	// "quicksight:DescribeDashboard".
	//
	// This member is required.
	Actions []*string

	// The Amazon Resource Name (ARN) of the principal. This can be one of the
	// following:
	//
	//     * The ARN of an Amazon QuickSight user, group, or namespace.
	// (This is most common.)
	//
	//     * The ARN of an AWS account root: This is an IAM ARN
	// rather than a QuickSight ARN. Use this option only to share resources
	// (templates) across AWS accounts. (This is less common.)
	//
	// This member is required.
	Principal *string
}

Permission for the resource.

type ResourceStatus

type ResourceStatus string
const (
	ResourceStatusCreation_in_progress ResourceStatus = "CREATION_IN_PROGRESS"
	ResourceStatusCreation_successful  ResourceStatus = "CREATION_SUCCESSFUL"
	ResourceStatusCreation_failed      ResourceStatus = "CREATION_FAILED"
	ResourceStatusUpdate_in_progress   ResourceStatus = "UPDATE_IN_PROGRESS"
	ResourceStatusUpdate_successful    ResourceStatus = "UPDATE_SUCCESSFUL"
	ResourceStatusUpdate_failed        ResourceStatus = "UPDATE_FAILED"
)

Enum values for ResourceStatus

type ResourceUnavailableException

type ResourceUnavailableException struct {
	Message *string

	ResourceType ExceptionResourceType
	RequestId    *string
}

This resource is currently unavailable.

func (*ResourceUnavailableException) Error

func (*ResourceUnavailableException) ErrorCode

func (e *ResourceUnavailableException) ErrorCode() string

func (*ResourceUnavailableException) ErrorFault

func (*ResourceUnavailableException) ErrorMessage

func (e *ResourceUnavailableException) ErrorMessage() string

type RowInfo

type RowInfo struct {

	// The number of rows that were not ingested.
	RowsDropped *int64

	// The number of rows that were ingested.
	RowsIngested *int64
}

Information about rows for a data set SPICE ingestion.

type RowLevelPermissionDataSet

type RowLevelPermissionDataSet struct {

	// The Amazon Resource Name (ARN) of the permission dataset.
	//
	// This member is required.
	Arn *string

	// Permission policy.
	//
	// This member is required.
	PermissionPolicy RowLevelPermissionPolicy

	// The namespace associated with the row-level permissions dataset.
	Namespace *string
}

The row-level security configuration for the dataset.

type RowLevelPermissionPolicy

type RowLevelPermissionPolicy string
const (
	RowLevelPermissionPolicyGrant_access RowLevelPermissionPolicy = "GRANT_ACCESS"
	RowLevelPermissionPolicyDeny_access  RowLevelPermissionPolicy = "DENY_ACCESS"
)

Enum values for RowLevelPermissionPolicy

type S3Parameters

type S3Parameters struct {

	// Location of the Amazon S3 manifest file. This is NULL if the manifest file was
	// uploaded in the console.
	//
	// This member is required.
	ManifestFileLocation *ManifestFileLocation
}

S3 parameters.

type S3Source

type S3Source struct {

	// The amazon Resource Name (ARN) for the data source.
	//
	// This member is required.
	DataSourceArn *string

	// A physical table type for as S3 data source.
	//
	// This member is required.
	InputColumns []*InputColumn

	// Information about the format for the S3 source file or files.
	UploadSettings *UploadSettings
}

A physical table type for as S3 data source.

type ServiceNowParameters

type ServiceNowParameters struct {

	// URL of the base site.
	//
	// This member is required.
	SiteBaseUrl *string
}

ServiceNow parameters.

type SessionLifetimeInMinutesInvalidException

type SessionLifetimeInMinutesInvalidException struct {
	Message *string

	RequestId *string
}

The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.

func (*SessionLifetimeInMinutesInvalidException) Error

func (*SessionLifetimeInMinutesInvalidException) ErrorCode

func (*SessionLifetimeInMinutesInvalidException) ErrorFault

func (*SessionLifetimeInMinutesInvalidException) ErrorMessage

type SheetControlsOption

type SheetControlsOption struct {

	// Visibility state.
	VisibilityState DashboardUIState
}

Sheet controls option.

type SheetStyle

type SheetStyle struct {

	// The display options for tiles.
	Tile *TileStyle

	// The layout options for tiles.
	TileLayout *TileLayoutStyle
}

The theme display options for sheets.

type SnowflakeParameters

type SnowflakeParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Warehouse.
	//
	// This member is required.
	Warehouse *string
}

Snowflake parameters.

type SparkParameters

type SparkParameters struct {

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

Spark parameters.

type SqlServerParameters

type SqlServerParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

SQL Server parameters.

type SslProperties

type SslProperties struct {

	// A Boolean option to control whether SSL should be disabled.
	DisableSsl *bool
}

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

type StringParameter

type StringParameter struct {

	// A display name for the dataset.
	//
	// This member is required.
	Name *string

	// Values.
	//
	// This member is required.
	Values []*string
}

String parameter.

type Tag

type Tag struct {

	// Tag key.
	//
	// This member is required.
	Key *string

	// Tag value.
	//
	// This member is required.
	Value *string
}

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

type TagColumnOperation

type TagColumnOperation struct {

	// The column that this operation acts on.
	//
	// This member is required.
	ColumnName *string

	// The dataset column tag, currently only used for geospatial type tagging. . This
	// is not tags for the AWS tagging feature. .
	//
	// This member is required.
	Tags []*ColumnTag
}

A transform operation that tags a column with additional information.

type Template

type Template struct {

	// The Amazon Resource Name (ARN) of the template.
	Arn *string

	// Time when this was created.
	CreatedTime *time.Time

	// Time when this was last updated.
	LastUpdatedTime *time.Time

	// The display name of the template.
	Name *string

	// The ID for the template. This is unique per AWS Region for each AWS account.
	TemplateId *string

	// A structure describing the versions of the template.
	Version *TemplateVersion
}

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.

type TemplateAlias

type TemplateAlias struct {

	// The display name of the template alias.
	AliasName *string

	// The Amazon Resource Name (ARN) of the template alias.
	Arn *string

	// The version number of the template alias.
	TemplateVersionNumber *int64
}

The template alias.

type TemplateError

type TemplateError struct {

	// Description of the error type.
	Message *string

	// Type of error.
	Type TemplateErrorType
}

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

type TemplateErrorType

type TemplateErrorType string
const (
	TemplateErrorTypeSource_not_found   TemplateErrorType = "SOURCE_NOT_FOUND"
	TemplateErrorTypeData_set_not_found TemplateErrorType = "DATA_SET_NOT_FOUND"
	TemplateErrorTypeInternal_failure   TemplateErrorType = "INTERNAL_FAILURE"
)

Enum values for TemplateErrorType

type TemplateSourceAnalysis

type TemplateSourceAnalysis struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	Arn *string

	// A structure containing information about the dataset references used as
	// placeholders in the template.
	//
	// This member is required.
	DataSetReferences []*DataSetReference
}

The source analysis of the template.

type TemplateSourceEntity

type TemplateSourceEntity struct {

	// The source analysis, if it is based on an analysis.
	SourceAnalysis *TemplateSourceAnalysis

	// The source template, if it is based on an template.
	SourceTemplate *TemplateSourceTemplate
}

The source entity of the template.

type TemplateSourceTemplate

type TemplateSourceTemplate struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	Arn *string
}

The source template of the template.

type TemplateSummary

type TemplateSummary struct {

	// A summary of a template.
	Arn *string

	// The last time that this template was created.
	CreatedTime *time.Time

	// The last time that this template was updated.
	LastUpdatedTime *time.Time

	// A structure containing a list of version numbers for the template summary.
	LatestVersionNumber *int64

	// A display name for the template.
	Name *string

	// The ID of the template. This ID is unique per AWS Region for each AWS account.
	TemplateId *string
}

The template summary.

type TemplateVersion

type TemplateVersion struct {

	// The time that this template version was created.
	CreatedTime *time.Time

	// Schema of the dataset identified by the placeholder. The idea is that any
	// dashboard created from the template should be bound to new datasets matching the
	// same schema described through this API. .
	DataSetConfigurations []*DataSetConfiguration

	// The description of the template.
	Description *string

	// Errors associated with the template.
	Errors []*TemplateError

	// The Amazon Resource Name (ARN) of the analysis or template which was used to
	// create this template.
	SourceEntityArn *string

	// The HTTP status of the request.
	Status ResourceStatus

	// The version number of the template.
	VersionNumber *int64
}

A version of a template.

type TemplateVersionSummary

type TemplateVersionSummary struct {

	// The Amazon Resource Name (ARN) of the template version.
	Arn *string

	// The time that this template version was created.
	CreatedTime *time.Time

	// The description of the template version.
	Description *string

	// The status of the template version.
	Status ResourceStatus

	// The version number of the template version.
	VersionNumber *int64
}

The template version.

type TeradataParameters

type TeradataParameters struct {

	// Database.
	//
	// This member is required.
	Database *string

	// Host.
	//
	// This member is required.
	Host *string

	// Port.
	//
	// This member is required.
	Port *int32
}

Teradata parameters.

type TextQualifier

type TextQualifier string
const (
	TextQualifierDouble_quote TextQualifier = "DOUBLE_QUOTE"
	TextQualifierSingle_quote TextQualifier = "SINGLE_QUOTE"
)

Enum values for TextQualifier

type Theme

type Theme struct {

	// The Amazon Resource Name (ARN) of the theme.
	Arn *string

	// The date and time that the theme was created.
	CreatedTime *time.Time

	// The date and time that the theme was last updated.
	LastUpdatedTime *time.Time

	// The name that the user gives to the theme.
	Name *string

	// The identifier that the user gives to the theme.
	ThemeId *string

	// The type of theme, based on how it was created. Valid values include: QUICKSIGHT
	// and CUSTOM.
	Type ThemeType

	// A version of a theme.
	Version *ThemeVersion
}

type ThemeAlias

type ThemeAlias struct {

	// The display name of the theme alias.
	AliasName *string

	// The Amazon Resource Name (ARN) of the theme alias.
	Arn *string

	// The version number of the theme alias.
	ThemeVersionNumber *int64
}

An alias for a theme.

type ThemeConfiguration

type ThemeConfiguration struct {

	// Color properties that apply to chart data colors.
	DataColorPalette *DataColorPalette

	// Display options related to sheets.
	Sheet *SheetStyle

	// Color properties that apply to the UI and to charts, excluding the colors that
	// apply to data.
	UIColorPalette *UIColorPalette
}

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

type ThemeError

type ThemeError struct {

	// The error message.
	Message *string

	// The type of error.
	Type ThemeErrorType
}

Theme error.

type ThemeErrorType

type ThemeErrorType string
const (
	ThemeErrorTypeInternal_failure ThemeErrorType = "INTERNAL_FAILURE"
)

Enum values for ThemeErrorType

type ThemeSummary

type ThemeSummary struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The date and time that this theme was created.
	CreatedTime *time.Time

	// The last date and time that this theme was updated.
	LastUpdatedTime *time.Time

	// The latest version number for the theme.
	LatestVersionNumber *int64

	// the display name for the theme.
	Name *string

	// The ID of the theme. This ID is unique per AWS Region for each AWS account.
	ThemeId *string
}

The theme summary.

type ThemeType

type ThemeType string
const (
	ThemeTypeQuicksight ThemeType = "QUICKSIGHT"
	ThemeTypeCustom     ThemeType = "CUSTOM"
	ThemeTypeAll        ThemeType = "ALL"
)

Enum values for ThemeType

type ThemeVersion

type ThemeVersion struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string

	// The Amazon QuickSight-defined ID of the theme that a custom theme inherits from.
	// All themes initially inherit from a default QuickSight theme.
	BaseThemeId *string

	// The theme configuration, which contains all the theme display properties.
	Configuration *ThemeConfiguration

	// The date and time that this theme version was created.
	CreatedTime *time.Time

	// The description of the theme.
	Description *string

	// Errors associated with the theme.
	Errors []*ThemeError

	// The status of the theme version.
	Status ResourceStatus

	// The version number of the theme.
	VersionNumber *int64
}

A version of a theme.

type ThemeVersionSummary

type ThemeVersionSummary struct {

	// The Amazon Resource Name (ARN) of the theme version.
	Arn *string

	// The date and time that this theme version was created.
	CreatedTime *time.Time

	// The description of the theme version.
	Description *string

	// The status of the theme version.
	Status ResourceStatus

	// The version number of the theme version.
	VersionNumber *int64
}

The theme version.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	RequestId *string
}

Access is throttled.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type TileLayoutStyle

type TileLayoutStyle struct {

	// The gutter settings that apply between tiles.
	Gutter *GutterStyle

	// The margin settings that apply around the outside edge of sheets.
	Margin *MarginStyle
}

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

type TileStyle

type TileStyle struct {

	// The border around a tile.
	Border *BorderStyle
}

Display options related to tiles on a sheet.

type TransformOperation

type TransformOperation struct {

	// A transform operation that casts a column to a different type.
	CastColumnTypeOperation *CastColumnTypeOperation

	// An operation that creates calculated columns. Columns created in one such
	// operation form a lexical closure.
	CreateColumnsOperation *CreateColumnsOperation

	// An operation that filters rows based on some condition.
	FilterOperation *FilterOperation

	// An operation that projects columns. Operations that come after a projection can
	// only refer to projected columns.
	ProjectOperation *ProjectOperation

	// An operation that renames a column.
	RenameColumnOperation *RenameColumnOperation

	// An operation that tags a column with additional information.
	TagColumnOperation *TagColumnOperation
}

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.

type TwitterParameters

type TwitterParameters struct {

	// Maximum number of rows to query Twitter.
	//
	// This member is required.
	MaxRows *int32

	// Twitter query string.
	//
	// This member is required.
	Query *string
}

Twitter parameters.

type UIColorPalette

type UIColorPalette struct {

	// This color is that applies to selected states and buttons.
	Accent *string

	// The foreground color that applies to any text or other elements that appear over
	// the accent color.
	AccentForeground *string

	// The color that applies to error messages.
	Danger *string

	// The foreground color that applies to any text or other elements that appear over
	// the error color.
	DangerForeground *string

	// The color that applies to the names of fields that are identified as dimensions.
	Dimension *string

	// The foreground color that applies to any text or other elements that appear over
	// the dimension color.
	DimensionForeground *string

	// The color that applies to the names of fields that are identified as measures.
	Measure *string

	// The foreground color that applies to any text or other elements that appear over
	// the measure color.
	MeasureForeground *string

	// The background color that applies to visuals and other high emphasis UI.
	PrimaryBackground *string

	// The color of text and other foreground elements that appear over the primary
	// background regions, such as grid lines, borders, table banding, icons, and so
	// on.
	PrimaryForeground *string

	// The background color that applies to the sheet background and sheet controls.
	SecondaryBackground *string

	// The foreground color that applies to any sheet title, sheet control text, or UI
	// that appears over the secondary background.
	SecondaryForeground *string

	// The color that applies to success messages, for example the check mark for a
	// successful download.
	Success *string

	// The foreground color that applies to any text or other elements that appear over
	// the success color.
	SuccessForeground *string

	// This color that applies to warning and informational messages.
	Warning *string

	// The foreground color that applies to any text or other elements that appear over
	// the warning color.
	WarningForeground *string
}

The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexidecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the Amazon QuickSight User Guide.

type UnsupportedUserEditionException

type UnsupportedUserEditionException struct {
	Message *string

	RequestId *string
}

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

func (*UnsupportedUserEditionException) Error

func (*UnsupportedUserEditionException) ErrorCode

func (e *UnsupportedUserEditionException) ErrorCode() string

func (*UnsupportedUserEditionException) ErrorFault

func (*UnsupportedUserEditionException) ErrorMessage

func (e *UnsupportedUserEditionException) ErrorMessage() string

type UploadSettings

type UploadSettings struct {

	// Whether the file has a header row, or the files each have a header row.
	ContainsHeader *bool

	// The delimiter between values in the file.
	Delimiter *string

	// File format.
	Format FileFormat

	// A row number to start reading data from.
	StartFromRow *int32

	// Text qualifier.
	TextQualifier TextQualifier
}

Information about the format for a source file or files.

type User

type User struct {

	// The active status of user. When you create an Amazon QuickSight user that’s not
	// an IAM user or an Active Directory user, that user is inactive until they sign
	// in and provide a password.
	Active *bool

	// The Amazon Resource Name (ARN) for the user.
	Arn *string

	// The custom permissions profile associated with this user.
	CustomPermissionsName *string

	// The user's email address.
	Email *string

	// The type of identity authentication used by the user.
	IdentityType IdentityType

	// The principal ID of the user.
	PrincipalId *string

	// The Amazon QuickSight role for the user. The user role can be one of the
	// following:.
	//
	//     * READER: A user who has read-only access to dashboards.
	//
	//     *
	// AUTHOR: A user who can create data sources, datasets, analyses, and
	// dashboards.
	//
	//     * ADMIN: A user who is an author, who can also manage Amazon
	// QuickSight settings.
	//
	//     * RESTRICTED_READER: This role isn't currently
	// available for use.
	//
	//     * RESTRICTED_AUTHOR: This role isn't currently available
	// for use.
	Role UserRole

	// The user's user name.
	UserName *string
}

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

type UserRole

type UserRole string
const (
	UserRoleAdmin             UserRole = "ADMIN"
	UserRoleAuthor            UserRole = "AUTHOR"
	UserRoleReader            UserRole = "READER"
	UserRoleRestricted_author UserRole = "RESTRICTED_AUTHOR"
	UserRoleRestricted_reader UserRole = "RESTRICTED_READER"
)

Enum values for UserRole

type VpcConnectionProperties

type VpcConnectionProperties struct {

	// The Amazon Resource Name (ARN) for the VPC connection.
	//
	// This member is required.
	VpcConnectionArn *string
}

VPC connection properties.

Source Files

enums.go errors.go types.go

Version
v0.28.0
Published
Oct 26, 2020
Platform
js/wasm
Imports
3 packages
Last checked
6 hours ago

Tools for package owners.