types

package
v1.62.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 8

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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

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 email customization template.
	DefaultEmailCustomizationTemplate *string

	// The default theme for this Amazon QuickSight subscription.
	DefaultTheme *string
	// contains filtered or unexported fields
}

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

type AccountInfo added in v1.23.0

type AccountInfo struct {

	// The account name that you provided for the Amazon QuickSight subscription in
	// your Amazon Web Services account. You create this name when you sign up for
	// Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears
	// only when users sign in.
	AccountName *string

	// The status of your account subscription.
	AccountSubscriptionStatus *string

	// The way that your Amazon QuickSight account is authenticated.
	AuthenticationType *string

	// The edition of your Amazon QuickSight account.
	Edition Edition

	// The Amazon Resource Name (ARN) for the IAM Identity Center instance.
	IAMIdentityCenterInstanceArn *string

	// The email address that will be used for Amazon QuickSight to send notifications
	// regarding your Amazon Web Services account or Amazon QuickSight subscription.
	NotificationEmail *string
	// contains filtered or unexported fields
}

A structure that contains the following account information elements:

  • Your Amazon QuickSight account name.
  • The edition of Amazon QuickSight that your account is using.
  • The notification email address that is associated with the Amazon QuickSight account.
  • The authentication type of the Amazon QuickSight account.
  • The status of the Amazon QuickSight account's subscription.

type AccountSettings

type AccountSettings struct {

	// The "account name" you provided for the Amazon QuickSight subscription in your
	// Amazon Web Services account. You create this name when you sign up for Amazon
	// QuickSight. It is unique in all of Amazon Web Services and it appears only when
	// users sign in.
	AccountName *string

	// The default Amazon QuickSight namespace for your Amazon Web Services account.
	DefaultNamespace *string

	// The edition of Amazon QuickSight that you're currently subscribed to:
	// Enterprise edition or Standard edition.
	Edition Edition

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

	// A Boolean value that indicates whether public sharing is turned on for an
	// Amazon QuickSight account. For more information about turning on public sharing,
	// see UpdatePublicSharingSettings (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html)
	// .
	PublicSharingEnabled bool

	// A boolean value that determines whether or not an Amazon QuickSight account can
	// be deleted. A True value doesn't allow the account to be deleted and results in
	// an error message if a user tries to make a DeleteAccountSubsctiption request. A
	// False value will allow the ccount to be deleted.
	TerminationProtectionEnabled bool
	// contains filtered or unexported fields
}

The Amazon QuickSight settings associated with your Amazon Web Services 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
	// contains filtered or unexported fields
}

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

type AdHocFilteringOption

type AdHocFilteringOption struct {

	// Availability status.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

An ad hoc (one-time) filtering option.

type AggregationFunction added in v1.28.0

type AggregationFunction struct {

	// Aggregation for attributes.
	AttributeAggregationFunction *AttributeAggregationFunction

	// Aggregation for categorical values.
	//   - COUNT : Aggregate by the total number of values, including duplicates.
	//   - DISTINCT_COUNT : Aggregate by the total number of distinct values.
	CategoricalAggregationFunction CategoricalAggregationFunction

	// Aggregation for date values.
	//   - COUNT : Aggregate by the total number of values, including duplicates.
	//   - DISTINCT_COUNT : Aggregate by the total number of distinct values.
	//   - MIN : Select the smallest date value.
	//   - MAX : Select the largest date value.
	DateAggregationFunction DateAggregationFunction

	// Aggregation for numerical values.
	NumericalAggregationFunction *NumericalAggregationFunction
	// contains filtered or unexported fields
}

An aggregation function aggregates values from a dimension or measure. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type AggregationSortConfiguration added in v1.28.0

type AggregationSortConfiguration struct {

	// The column that determines the sort order of aggregated values.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The sort direction of values.
	//   - ASC : Sort in ascending order.
	//   - DESC : Sort in descending order.
	//
	// This member is required.
	SortDirection SortDirection

	// The function that aggregates the values in Column .
	AggregationFunction *AggregationFunction
	// contains filtered or unexported fields
}

The configuration options to sort aggregated values.

type AllSheetsFilterScopeConfiguration added in v1.42.0

type AllSheetsFilterScopeConfiguration struct {
	// contains filtered or unexported fields
}

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type AmazonElasticsearchParameters

type AmazonElasticsearchParameters struct {

	// The OpenSearch domain.
	//
	// This member is required.
	Domain *string
	// contains filtered or unexported fields
}

The parameters for OpenSearch.

type AmazonOpenSearchParameters added in v1.11.0

type AmazonOpenSearchParameters struct {

	// The OpenSearch domain.
	//
	// This member is required.
	Domain *string
	// contains filtered or unexported fields
}

The parameters for OpenSearch.

type Analysis added in v0.29.0

type Analysis struct {

	// The ID of the analysis.
	AnalysisId *string

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

	// The time that the analysis was created.
	CreatedTime *time.Time

	// The ARNs of the datasets of the analysis.
	DataSetArns []string

	// Errors associated with the analysis.
	Errors []AnalysisError

	// The time that the analysis was last updated.
	LastUpdatedTime *time.Time

	// The descriptive name of the analysis.
	Name *string

	// A list of the associated sheets with the unique identifier and name of each
	// sheet.
	Sheets []Sheet

	// Status associated with the analysis.
	Status ResourceStatus

	// The ARN of the theme of the analysis.
	ThemeArn *string
	// contains filtered or unexported fields
}

Metadata structure for an analysis in Amazon QuickSight

type AnalysisDefaults added in v1.28.0

type AnalysisDefaults struct {

	// The configuration for default new sheet settings.
	//
	// This member is required.
	DefaultNewSheetConfiguration *DefaultNewSheetConfiguration
	// contains filtered or unexported fields
}

The configuration for default analysis settings.

type AnalysisDefinition added in v1.28.0

type AnalysisDefinition struct {

	// An array of dataset identifier declarations. This mapping allows the usage of
	// dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
	//
	// This member is required.
	DataSetIdentifierDeclarations []DataSetIdentifierDeclaration

	// The configuration for default analysis settings.
	AnalysisDefaults *AnalysisDefaults

	// An array of calculated field definitions for the analysis.
	CalculatedFields []CalculatedField

	// An array of analysis-level column configurations. Column configurations can be
	// used to set default formatting for a column to be used throughout an analysis.
	ColumnConfigurations []ColumnConfiguration

	// Filter definitions for an analysis. For more information, see Filtering Data in
	// Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html)
	// in the Amazon QuickSight User Guide.
	FilterGroups []FilterGroup

	// An array of option definitions for an analysis.
	Options *AssetOptions

	// An array of parameter declarations for an analysis. Parameters are named
	// variables that can transfer a value for use by an action or an object. For more
	// information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
	// in the Amazon QuickSight User Guide.
	ParameterDeclarations []ParameterDeclaration

	// An array of sheet definitions for an analysis. Each SheetDefinition provides
	// detailed information about a sheet within this analysis.
	Sheets []SheetDefinition
	// contains filtered or unexported fields
}

The definition of an analysis.

type AnalysisError added in v0.29.0

type AnalysisError struct {

	// The message associated with the analysis error.
	Message *string

	// The type of the analysis error.
	Type AnalysisErrorType

	// Lists the violated entities that caused the analysis error
	ViolatedEntities []Entity
	// contains filtered or unexported fields
}

Analysis error.

type AnalysisErrorType added in v0.29.0

type AnalysisErrorType string
const (
	AnalysisErrorTypeAccessDenied                 AnalysisErrorType = "ACCESS_DENIED"
	AnalysisErrorTypeSourceNotFound               AnalysisErrorType = "SOURCE_NOT_FOUND"
	AnalysisErrorTypeDataSetNotFound              AnalysisErrorType = "DATA_SET_NOT_FOUND"
	AnalysisErrorTypeInternalFailure              AnalysisErrorType = "INTERNAL_FAILURE"
	AnalysisErrorTypeParameterValueIncompatible   AnalysisErrorType = "PARAMETER_VALUE_INCOMPATIBLE"
	AnalysisErrorTypeParameterTypeInvalid         AnalysisErrorType = "PARAMETER_TYPE_INVALID"
	AnalysisErrorTypeParameterNotFound            AnalysisErrorType = "PARAMETER_NOT_FOUND"
	AnalysisErrorTypeColumnTypeMismatch           AnalysisErrorType = "COLUMN_TYPE_MISMATCH"
	AnalysisErrorTypeColumnGeographicRoleMismatch AnalysisErrorType = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
	AnalysisErrorTypeColumnReplacementMissing     AnalysisErrorType = "COLUMN_REPLACEMENT_MISSING"
)

Enum values for AnalysisErrorType

func (AnalysisErrorType) Values added in v0.29.0

Values returns all known values for AnalysisErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisFilterAttribute added in v0.29.0

type AnalysisFilterAttribute string
const (
	AnalysisFilterAttributeQuicksightUser                AnalysisFilterAttribute = "QUICKSIGHT_USER"
	AnalysisFilterAttributeQuicksightViewerOrOwner       AnalysisFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
	AnalysisFilterAttributeDirectQuicksightViewerOrOwner AnalysisFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
	AnalysisFilterAttributeQuicksightOwner               AnalysisFilterAttribute = "QUICKSIGHT_OWNER"
	AnalysisFilterAttributeDirectQuicksightOwner         AnalysisFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
	AnalysisFilterAttributeDirectQuicksightSoleOwner     AnalysisFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
	AnalysisFilterAttributeAnalysisName                  AnalysisFilterAttribute = "ANALYSIS_NAME"
)

Enum values for AnalysisFilterAttribute

func (AnalysisFilterAttribute) Values added in v0.29.0

Values returns all known values for AnalysisFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisSearchFilter added in v0.29.0

type AnalysisSearchFilter struct {

	// The name of the value that you want to use as a filter, for example "Name":
	// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
	//   - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
	//   analyses with that ARN listed as one of the analysis' owners or viewers are
	//   returned. Implicit permissions from folders or groups are considered.
	//   - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any analyses with
	//   that ARN listed as one of the owners of the analyses are returned. Implicit
	//   permissions from folders or groups are considered.
	//   - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
	//   analyses with that ARN listed as the only owner of the analysis are returned.
	//   Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any
	//   analyses with that ARN listed as one of the owners of the analyses are returned.
	//   Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
	//   any analyses with that ARN listed as one of the owners or viewers of the
	//   analyses are returned. Implicit permissions from folders or groups are not
	//   considered.
	//   - ANALYSIS_NAME : Any analyses whose names have a substring match to this
	//   value will be returned.
	Name AnalysisFilterAttribute

	// The comparison operator that you want to use as a filter, for example
	// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
	// If you set the operator value to "StringEquals" , you need to provide an
	// ownership related filter in the "NAME" field and the arn of the user or group
	// whose folders you want to search in the "Value" field. For example,
	// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
	// to "StringLike" , you need to provide the name of the folders you are searching
	// for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value":
	// "Test" . The "StringLike" operator only supports the NAME value ANALYSIS_NAME .
	Operator FilterOperator

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

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

type AnalysisSourceEntity added in v0.29.0

type AnalysisSourceEntity struct {

	// The source template for the source entity of the analysis.
	SourceTemplate *AnalysisSourceTemplate
	// contains filtered or unexported fields
}

The source entity of an analysis.

type AnalysisSourceTemplate added in v0.29.0

type AnalysisSourceTemplate struct {

	// The Amazon Resource Name (ARN) of the source template of an analysis.
	//
	// This member is required.
	Arn *string

	// The dataset references of the source template of an analysis.
	//
	// This member is required.
	DataSetReferences []DataSetReference
	// contains filtered or unexported fields
}

The source template of an analysis.

type AnalysisSummary added in v0.29.0

type AnalysisSummary struct {

	// The ID of the analysis. This ID displays in the URL.
	AnalysisId *string

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

	// The time that the analysis was created.
	CreatedTime *time.Time

	// The time that the analysis was last updated.
	LastUpdatedTime *time.Time

	// The name of the analysis. This name is displayed in the Amazon QuickSight
	// console.
	Name *string

	// The last known status for the analysis.
	Status ResourceStatus
	// contains filtered or unexported fields
}

The summary metadata that describes an analysis.

type AnchorDateConfiguration added in v1.28.0

type AnchorDateConfiguration struct {

	// The options for the date configuration. Choose one of the options below:
	//   - NOW
	AnchorOption AnchorOption

	// The name of the parameter that is used for the anchor date configuration.
	ParameterName *string
	// contains filtered or unexported fields
}

The date configuration of the filter.

type AnchorOption added in v1.28.0

type AnchorOption string
const (
	AnchorOptionNow AnchorOption = "NOW"
)

Enum values for AnchorOption

func (AnchorOption) Values added in v1.28.0

func (AnchorOption) Values() []AnchorOption

Values returns all known values for AnchorOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnonymousUserDashboardEmbeddingConfiguration added in v1.7.0

type AnonymousUserDashboardEmbeddingConfiguration struct {

	// The dashboard ID for the dashboard that you want the user to see first. This ID
	// is included in the output URL. When the URL in response is accessed, Amazon
	// QuickSight renders this dashboard. The Amazon Resource Name (ARN) of this
	// dashboard must be included in the AuthorizedResourceArns parameter. Otherwise,
	// the request will fail with InvalidParameterValueException .
	//
	// This member is required.
	InitialDashboardId *string
	// contains filtered or unexported fields
}

Information about the dashboard that you want to embed.

type AnonymousUserDashboardVisualEmbeddingConfiguration added in v1.24.0

type AnonymousUserDashboardVisualEmbeddingConfiguration struct {

	// The visual ID for the visual that you want the user to see. This ID is included
	// in the output URL. When the URL in response is accessed, Amazon QuickSight
	// renders this visual. The Amazon Resource Name (ARN) of the dashboard that the
	// visual belongs to must be included in the AuthorizedResourceArns parameter.
	// Otherwise, the request will fail with InvalidParameterValueException .
	//
	// This member is required.
	InitialDashboardVisualId *DashboardVisualId
	// contains filtered or unexported fields
}

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

type AnonymousUserEmbeddingExperienceConfiguration added in v1.7.0

type AnonymousUserEmbeddingExperienceConfiguration struct {

	// The type of embedding experience. In this case, Amazon QuickSight dashboards.
	Dashboard *AnonymousUserDashboardEmbeddingConfiguration

	// The type of embedding experience. In this case, Amazon QuickSight visuals.
	DashboardVisual *AnonymousUserDashboardVisualEmbeddingConfiguration

	// The Q search bar that you want to use for anonymous user embedding.
	QSearchBar *AnonymousUserQSearchBarEmbeddingConfiguration
	// contains filtered or unexported fields
}

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

type AnonymousUserQSearchBarEmbeddingConfiguration added in v1.27.0

type AnonymousUserQSearchBarEmbeddingConfiguration struct {

	// The QuickSight Q topic ID of the topic that you want the anonymous user to see
	// first. This ID is included in the output URL. When the URL in response is
	// accessed, Amazon QuickSight renders the Q search bar with this topic
	// pre-selected. The Amazon Resource Name (ARN) of this Q topic must be included in
	// the AuthorizedResourceArns parameter. Otherwise, the request will fail with
	// InvalidParameterValueException .
	//
	// This member is required.
	InitialTopicId *string
	// contains filtered or unexported fields
}

The settings that you want to use with the Q search bar.

type AnonymousUserSnapshotJobResult added in v1.39.0

type AnonymousUserSnapshotJobResult struct {

	// A list of SnapshotJobResultFileGroup objects that contain information on the
	// files that are requested during a StartDashboardSnapshotJob API call. If the
	// job succeeds, these objects contain the location where the snapshot artifacts
	// are stored. If the job fails, the objects contain information about the error
	// that caused the job to fail.
	FileGroups []SnapshotJobResultFileGroup
	// contains filtered or unexported fields
}

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.

type ArcAxisConfiguration added in v1.28.0

type ArcAxisConfiguration struct {

	// The arc axis range of a GaugeChartVisual .
	Range *ArcAxisDisplayRange

	// The reserved range of the arc axis.
	ReserveRange int32
	// contains filtered or unexported fields
}

The arc axis configuration of a GaugeChartVisual .

type ArcAxisDisplayRange added in v1.28.0

type ArcAxisDisplayRange struct {

	// The maximum value of the arc axis range.
	Max *float64

	// The minimum value of the arc axis range.
	Min *float64
	// contains filtered or unexported fields
}

The arc axis range of a GaugeChartVisual .

type ArcConfiguration added in v1.28.0

type ArcConfiguration struct {

	// The option that determines the arc angle of a GaugeChartVisual .
	ArcAngle *float64

	// The options that determine the arc thickness of a GaugeChartVisual .
	ArcThickness ArcThicknessOptions
	// contains filtered or unexported fields
}

The arc configuration of a GaugeChartVisual .

type ArcOptions added in v1.28.0

type ArcOptions struct {

	// The arc thickness of a GaugeChartVisual .
	ArcThickness ArcThickness
	// contains filtered or unexported fields
}

The options that determine the arc thickness of a GaugeChartVisual .

type ArcThickness added in v1.28.0

type ArcThickness string
const (
	ArcThicknessSmall  ArcThickness = "SMALL"
	ArcThicknessMedium ArcThickness = "MEDIUM"
	ArcThicknessLarge  ArcThickness = "LARGE"
	ArcThicknessWhole  ArcThickness = "WHOLE"
)

Enum values for ArcThickness

func (ArcThickness) Values added in v1.28.0

func (ArcThickness) Values() []ArcThickness

Values returns all known values for ArcThickness. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ArcThicknessOptions added in v1.28.0

type ArcThicknessOptions string
const (
	ArcThicknessOptionsSmall  ArcThicknessOptions = "SMALL"
	ArcThicknessOptionsMedium ArcThicknessOptions = "MEDIUM"
	ArcThicknessOptionsLarge  ArcThicknessOptions = "LARGE"
)

Enum values for ArcThicknessOptions

func (ArcThicknessOptions) Values added in v1.28.0

Values returns all known values for ArcThicknessOptions. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleCloudFormationOverridePropertyConfiguration added in v1.36.0

type AssetBundleCloudFormationOverridePropertyConfiguration struct {

	// An optional list of structures that control how Analysis resources are
	// parameterized in the returned CloudFormation template.
	Analyses []AssetBundleExportJobAnalysisOverrideProperties

	// An optional list of structures that control how Dashboard resources are
	// parameterized in the returned CloudFormation template.
	Dashboards []AssetBundleExportJobDashboardOverrideProperties

	// An optional list of structures that control how DataSet resources are
	// parameterized in the returned CloudFormation template.
	DataSets []AssetBundleExportJobDataSetOverrideProperties

	// An optional list of structures that control how DataSource resources are
	// parameterized in the returned CloudFormation template.
	DataSources []AssetBundleExportJobDataSourceOverrideProperties

	// An optional list of structures that control how RefreshSchedule resources are
	// parameterized in the returned CloudFormation template.
	RefreshSchedules []AssetBundleExportJobRefreshScheduleOverrideProperties

	// An optional list of structures that control how resource IDs are parameterized
	// in the returned CloudFormation template.
	ResourceIdOverrideConfiguration *AssetBundleExportJobResourceIdOverrideConfiguration

	// An optional list of structures that control how Theme resources are
	// parameterized in the returned CloudFormation template.
	Themes []AssetBundleExportJobThemeOverrideProperties

	// An optional list of structures that control how VPCConnection resources are
	// parameterized in the returned CloudFormation template.
	VPCConnections []AssetBundleExportJobVPCConnectionOverrideProperties
	// contains filtered or unexported fields
}

An optional collection of CloudFormation property configurations that control how the export job is generated.

type AssetBundleExportFormat added in v1.36.0

type AssetBundleExportFormat string
const (
	AssetBundleExportFormatCloudformationJson AssetBundleExportFormat = "CLOUDFORMATION_JSON"
	AssetBundleExportFormatQuicksightJson     AssetBundleExportFormat = "QUICKSIGHT_JSON"
)

Enum values for AssetBundleExportFormat

func (AssetBundleExportFormat) Values added in v1.36.0

Values returns all known values for AssetBundleExportFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobAnalysisOverrideProperties added in v1.36.0

type AssetBundleExportJobAnalysisOverrideProperties struct {

	// The ARN of the specific Analysis resource whose override properties are
	// configured in this structure.
	//
	// This member is required.
	Arn *string

	// A list of Analysis resource properties to generate variables for in the
	// returned CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobAnalysisPropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

type AssetBundleExportJobAnalysisPropertyToOverride added in v1.36.0

type AssetBundleExportJobAnalysisPropertyToOverride string
const (
	AssetBundleExportJobAnalysisPropertyToOverrideName AssetBundleExportJobAnalysisPropertyToOverride = "Name"
)

Enum values for AssetBundleExportJobAnalysisPropertyToOverride

func (AssetBundleExportJobAnalysisPropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobAnalysisPropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobDashboardOverrideProperties added in v1.36.0

type AssetBundleExportJobDashboardOverrideProperties struct {

	// The ARN of the specific Dashboard resource whose override properties are
	// configured in this structure.
	//
	// This member is required.
	Arn *string

	// A list of Dashboard resource properties to generate variables for in the
	// returned CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobDashboardPropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

type AssetBundleExportJobDashboardPropertyToOverride added in v1.36.0

type AssetBundleExportJobDashboardPropertyToOverride string
const (
	AssetBundleExportJobDashboardPropertyToOverrideName AssetBundleExportJobDashboardPropertyToOverride = "Name"
)

Enum values for AssetBundleExportJobDashboardPropertyToOverride

func (AssetBundleExportJobDashboardPropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobDashboardPropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobDataSetOverrideProperties added in v1.36.0

type AssetBundleExportJobDataSetOverrideProperties struct {

	// The ARN of the specific DataSet resource whose override properties are
	// configured in this structure.
	//
	// This member is required.
	Arn *string

	// A list of DataSet resource properties to generate variables for in the returned
	// CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobDataSetPropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

type AssetBundleExportJobDataSetPropertyToOverride added in v1.36.0

type AssetBundleExportJobDataSetPropertyToOverride string
const (
	AssetBundleExportJobDataSetPropertyToOverrideName AssetBundleExportJobDataSetPropertyToOverride = "Name"
)

Enum values for AssetBundleExportJobDataSetPropertyToOverride

func (AssetBundleExportJobDataSetPropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobDataSetPropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobDataSourceOverrideProperties added in v1.36.0

type AssetBundleExportJobDataSourceOverrideProperties struct {

	// The ARN of the specific DataSource resource whose override properties are
	// configured in this structure.
	//
	// This member is required.
	Arn *string

	// A list of DataSource resource properties to generate variables for in the
	// returned CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobDataSourcePropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

type AssetBundleExportJobDataSourcePropertyToOverride added in v1.36.0

type AssetBundleExportJobDataSourcePropertyToOverride string
const (
	AssetBundleExportJobDataSourcePropertyToOverrideName                 AssetBundleExportJobDataSourcePropertyToOverride = "Name"
	AssetBundleExportJobDataSourcePropertyToOverrideDisableSsl           AssetBundleExportJobDataSourcePropertyToOverride = "DisableSsl"
	AssetBundleExportJobDataSourcePropertyToOverrideSecretArn            AssetBundleExportJobDataSourcePropertyToOverride = "SecretArn"
	AssetBundleExportJobDataSourcePropertyToOverrideUsername             AssetBundleExportJobDataSourcePropertyToOverride = "Username"
	AssetBundleExportJobDataSourcePropertyToOverridePassword             AssetBundleExportJobDataSourcePropertyToOverride = "Password"
	AssetBundleExportJobDataSourcePropertyToOverrideDomain               AssetBundleExportJobDataSourcePropertyToOverride = "Domain"
	AssetBundleExportJobDataSourcePropertyToOverrideWorkGroup            AssetBundleExportJobDataSourcePropertyToOverride = "WorkGroup"
	AssetBundleExportJobDataSourcePropertyToOverrideHost                 AssetBundleExportJobDataSourcePropertyToOverride = "Host"
	AssetBundleExportJobDataSourcePropertyToOverridePort                 AssetBundleExportJobDataSourcePropertyToOverride = "Port"
	AssetBundleExportJobDataSourcePropertyToOverrideDatabase             AssetBundleExportJobDataSourcePropertyToOverride = "Database"
	AssetBundleExportJobDataSourcePropertyToOverrideDataSetName          AssetBundleExportJobDataSourcePropertyToOverride = "DataSetName"
	AssetBundleExportJobDataSourcePropertyToOverrideCatalog              AssetBundleExportJobDataSourcePropertyToOverride = "Catalog"
	AssetBundleExportJobDataSourcePropertyToOverrideInstanceId           AssetBundleExportJobDataSourcePropertyToOverride = "InstanceId"
	AssetBundleExportJobDataSourcePropertyToOverrideClusterId            AssetBundleExportJobDataSourcePropertyToOverride = "ClusterId"
	AssetBundleExportJobDataSourcePropertyToOverrideManifestFileLocation AssetBundleExportJobDataSourcePropertyToOverride = "ManifestFileLocation"
	AssetBundleExportJobDataSourcePropertyToOverrideWarehouse            AssetBundleExportJobDataSourcePropertyToOverride = "Warehouse"
	AssetBundleExportJobDataSourcePropertyToOverrideRoleArn              AssetBundleExportJobDataSourcePropertyToOverride = "RoleArn"
	AssetBundleExportJobDataSourcePropertyToOverrideProductType          AssetBundleExportJobDataSourcePropertyToOverride = "ProductType"
)

Enum values for AssetBundleExportJobDataSourcePropertyToOverride

func (AssetBundleExportJobDataSourcePropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobDataSourcePropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobError added in v1.36.0

type AssetBundleExportJobError struct {

	// The ARN of the resource whose processing caused an error.
	Arn *string

	// A description of the error.
	Message *string

	// The specific error type of the error that occurred.
	Type *string
	// contains filtered or unexported fields
}

Describes an error that occurred during an Asset Bundle export job.

type AssetBundleExportJobRefreshScheduleOverrideProperties added in v1.36.0

type AssetBundleExportJobRefreshScheduleOverrideProperties struct {

	// The ARN of the specific RefreshSchedule resource whose override properties are
	// configured in this structure.
	//
	// This member is required.
	Arn *string

	// A list of RefreshSchedule resource properties to generate variables for in the
	// returned CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobRefreshSchedulePropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

type AssetBundleExportJobRefreshSchedulePropertyToOverride added in v1.36.0

type AssetBundleExportJobRefreshSchedulePropertyToOverride string
const (
	AssetBundleExportJobRefreshSchedulePropertyToOverrideStartAfterDateTime AssetBundleExportJobRefreshSchedulePropertyToOverride = "StartAfterDateTime"
)

Enum values for AssetBundleExportJobRefreshSchedulePropertyToOverride

func (AssetBundleExportJobRefreshSchedulePropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobRefreshSchedulePropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobResourceIdOverrideConfiguration added in v1.36.0

type AssetBundleExportJobResourceIdOverrideConfiguration struct {

	// An option to request a CloudFormation variable for a prefix to be prepended to
	// each resource's ID before import. The prefix is only added to the asset IDs and
	// does not change the name of the asset.
	PrefixForAllResources bool
	// contains filtered or unexported fields
}

An optional structure that configures resource ID overrides for the export job.

type AssetBundleExportJobStatus added in v1.36.0

type AssetBundleExportJobStatus string
const (
	AssetBundleExportJobStatusQueuedForImmediateExecution AssetBundleExportJobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"
	AssetBundleExportJobStatusInProgress                  AssetBundleExportJobStatus = "IN_PROGRESS"
	AssetBundleExportJobStatusSuccessful                  AssetBundleExportJobStatus = "SUCCESSFUL"
	AssetBundleExportJobStatusFailed                      AssetBundleExportJobStatus = "FAILED"
)

Enum values for AssetBundleExportJobStatus

func (AssetBundleExportJobStatus) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobSummary added in v1.36.0

type AssetBundleExportJobSummary struct {

	// The ARN of the export job.
	Arn *string

	// The ID of the export job.
	AssetBundleExportJobId *string

	// The time that the export job was created.
	CreatedTime *time.Time

	// The format for the export job.
	ExportFormat AssetBundleExportFormat

	// The flag that determines the inclusion of resource dependencies in the returned
	// asset bundle.
	IncludeAllDependencies bool

	// The flag that determines the inclusion of permissions associated with each
	// resource ARN.
	IncludePermissions bool

	// The flag that determines the inclusion of tags associated with each resource
	// ARN.
	IncludeTags bool

	// The current status of the export job.
	JobStatus AssetBundleExportJobStatus
	// contains filtered or unexported fields
}

A summary of the export job that includes details of the job's configuration and its current status.

type AssetBundleExportJobThemeOverrideProperties added in v1.36.0

type AssetBundleExportJobThemeOverrideProperties struct {

	// The ARN of the specific Theme resource whose override properties are configured
	// in this structure.
	//
	// This member is required.
	Arn *string

	// A list of Theme resource properties to generate variables for in the returned
	// CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobThemePropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

type AssetBundleExportJobThemePropertyToOverride added in v1.36.0

type AssetBundleExportJobThemePropertyToOverride string
const (
	AssetBundleExportJobThemePropertyToOverrideName AssetBundleExportJobThemePropertyToOverride = "Name"
)

Enum values for AssetBundleExportJobThemePropertyToOverride

func (AssetBundleExportJobThemePropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobThemePropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobVPCConnectionOverrideProperties added in v1.36.0

type AssetBundleExportJobVPCConnectionOverrideProperties struct {

	// The ARN of the specific VPCConnection resource whose override properties are
	// configured in this structure.
	//
	// This member is required.
	Arn *string

	// A list of VPCConnection resource properties to generate variables for in the
	// returned CloudFormation template.
	//
	// This member is required.
	Properties []AssetBundleExportJobVPCConnectionPropertyToOverride
	// contains filtered or unexported fields
}

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

type AssetBundleExportJobVPCConnectionPropertyToOverride added in v1.36.0

type AssetBundleExportJobVPCConnectionPropertyToOverride string
const (
	AssetBundleExportJobVPCConnectionPropertyToOverrideName         AssetBundleExportJobVPCConnectionPropertyToOverride = "Name"
	AssetBundleExportJobVPCConnectionPropertyToOverrideDnsResolvers AssetBundleExportJobVPCConnectionPropertyToOverride = "DnsResolvers"
	AssetBundleExportJobVPCConnectionPropertyToOverrideRoleArn      AssetBundleExportJobVPCConnectionPropertyToOverride = "RoleArn"
)

Enum values for AssetBundleExportJobVPCConnectionPropertyToOverride

func (AssetBundleExportJobVPCConnectionPropertyToOverride) Values added in v1.36.0

Values returns all known values for AssetBundleExportJobVPCConnectionPropertyToOverride. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleExportJobValidationStrategy added in v1.51.0

type AssetBundleExportJobValidationStrategy struct {

	// A Boolean value that indicates whether to export resources under strict or
	// lenient mode.
	StrictModeForAllResources bool
	// contains filtered or unexported fields
}

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false , validation is skipped for specific UI errors.

type AssetBundleExportJobWarning added in v1.51.0

type AssetBundleExportJobWarning struct {

	// The ARN of the resource whose processing caused a warning.
	Arn *string

	// A description of the warning.
	Message *string
	// contains filtered or unexported fields
}

Describes a warning that occurred during an Asset Bundle export job.

type AssetBundleImportFailureAction added in v1.36.0

type AssetBundleImportFailureAction string
const (
	AssetBundleImportFailureActionDoNothing AssetBundleImportFailureAction = "DO_NOTHING"
	AssetBundleImportFailureActionRollback  AssetBundleImportFailureAction = "ROLLBACK"
)

Enum values for AssetBundleImportFailureAction

func (AssetBundleImportFailureAction) Values added in v1.36.0

Values returns all known values for AssetBundleImportFailureAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleImportJobAnalysisOverrideParameters added in v1.36.0

type AssetBundleImportJobAnalysisOverrideParameters struct {

	// The ID of the analysis that you ant to apply overrides to.
	//
	// This member is required.
	AnalysisId *string

	// A new name for the analysis.
	Name *string
	// contains filtered or unexported fields
}

The override parameters for a single analysis that is being imported.

type AssetBundleImportJobAnalysisOverridePermissions added in v1.51.0

type AssetBundleImportJobAnalysisOverridePermissions struct {

	// A list of analysis IDs that you want to apply overrides to. You can use * to
	// override all analyses in this asset bundle.
	//
	// This member is required.
	AnalysisIds []string

	// A list of permissions for the analyses that you want to apply overrides to.
	//
	// This member is required.
	Permissions *AssetBundleResourcePermissions
	// contains filtered or unexported fields
}

An object that contains a list of permissions to be applied to a list of analysis IDs.

type AssetBundleImportJobAnalysisOverrideTags added in v1.51.0

type AssetBundleImportJobAnalysisOverrideTags struct {

	// A list of analysis IDs that you want to apply overrides to. You can use * to
	// override all analyses in this asset bundle.
	//
	// This member is required.
	AnalysisIds []string

	// A list of tags for the analyses that you want to apply overrides to.
	//
	// This member is required.
	Tags []Tag
	// contains filtered or unexported fields
}

An object that contains a list of tags to be assigned to a list of analysis IDs.

type AssetBundleImportJobDashboardOverrideParameters added in v1.36.0

type AssetBundleImportJobDashboardOverrideParameters struct {

	// The ID of the dashboard that you want to apply overrides to.
	//
	// This member is required.
	DashboardId *string

	// A new name for the dashboard.
	Name *string
	// contains filtered or unexported fields
}

The override parameters for a single dashboard that is being imported.

type AssetBundleImportJobDashboardOverridePermissions added in v1.51.0

type AssetBundleImportJobDashboardOverridePermissions struct {

	// A list of dashboard IDs that you want to apply overrides to. You can use * to
	// override all dashboards in this asset bundle.
	//
	// This member is required.
	DashboardIds []string

	// A structure that contains the link sharing configurations that you want to
	// apply overrides to.
	LinkSharingConfiguration *AssetBundleResourceLinkSharingConfiguration

	// A list of permissions for the dashboards that you want to apply overrides to.
	Permissions *AssetBundleResourcePermissions
	// contains filtered or unexported fields
}

An object that contains a list of permissions to be applied to a list of dashboard IDs.

type AssetBundleImportJobDashboardOverrideTags added in v1.51.0

type AssetBundleImportJobDashboardOverrideTags struct {

	// A list of dashboard IDs that you want to apply overrides to. You can use * to
	// override all dashboards in this asset bundle.
	//
	// This member is required.
	DashboardIds []string

	// A list of tags for the dashboards that you want to apply overrides to.
	//
	// This member is required.
	Tags []Tag
	// contains filtered or unexported fields
}

An object that contains a list of tags to be assigned to a list of dashboard IDs.

type AssetBundleImportJobDataSetOverrideParameters added in v1.36.0

type AssetBundleImportJobDataSetOverrideParameters struct {

	// The ID of the dataset to apply overrides to.
	//
	// This member is required.
	DataSetId *string

	// A new name for the dataset.
	Name *string
	// contains filtered or unexported fields
}

The override parameters for a single dataset that is being imported.

type AssetBundleImportJobDataSetOverridePermissions added in v1.51.0

type AssetBundleImportJobDataSetOverridePermissions struct {

	// A list of dataset IDs that you want to apply overrides to. You can use * to
	// override all datasets in this asset bundle.
	//
	// This member is required.
	DataSetIds []string

	// A list of permissions for the datasets that you want to apply overrides to.
	//
	// This member is required.
	Permissions *AssetBundleResourcePermissions
	// contains filtered or unexported fields
}

An object that contains a list of permissions to be applied to a list of dataset IDs.

type AssetBundleImportJobDataSetOverrideTags added in v1.51.0

type AssetBundleImportJobDataSetOverrideTags struct {

	// A list of dataset IDs that you want to apply overrides to. You can use * to
	// override all datasets in this asset bundle.
	//
	// This member is required.
	DataSetIds []string

	// A list of tags for the datasets that you want to apply overrides to.
	//
	// This member is required.
	Tags []Tag
	// contains filtered or unexported fields
}

An object that contains a list of tags to be assigned to a list of dataset IDs.

type AssetBundleImportJobDataSourceCredentialPair added in v1.36.0

type AssetBundleImportJobDataSourceCredentialPair struct {

	// The password for the data source connection.
	//
	// This member is required.
	Password *string

	// The username for the data source connection.
	//
	// This member is required.
	Username *string
	// contains filtered or unexported fields
}

A username and password credential pair to use to import a data source resource.

type AssetBundleImportJobDataSourceCredentials added in v1.36.0

type AssetBundleImportJobDataSourceCredentials struct {

	// A username and password credential pair to be used to create the imported data
	// source. Keep this field blank if you are using a Secrets Manager secret to
	// provide credentials.
	CredentialPair *AssetBundleImportJobDataSourceCredentialPair

	// The ARN of the Secrets Manager secret that's used to create the imported data
	// source. Keep this field blank, unless you are using a secret in place of a
	// credential pair.
	SecretArn *string
	// contains filtered or unexported fields
}

The login credentials to use to import a data source resource.

type AssetBundleImportJobDataSourceOverrideParameters added in v1.36.0

type AssetBundleImportJobDataSourceOverrideParameters struct {

	// The ID of the data source to apply overrides to.
	//
	// This member is required.
	DataSourceId *string

	// An optional structure that provides the credentials to be used to create the
	// imported data source.
	Credentials *AssetBundleImportJobDataSourceCredentials

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

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

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

	// VPC connection properties.
	VpcConnectionProperties *VpcConnectionProperties
	// contains filtered or unexported fields
}

The override parameters for a single data source that is being imported.

type AssetBundleImportJobDataSourceOverridePermissions added in v1.51.0

type AssetBundleImportJobDataSourceOverridePermissions struct {

	// A list of data source IDs that you want to apply overrides to. You can use * to
	// override all data sources in this asset bundle.
	//
	// This member is required.
	DataSourceIds []string

	// A list of permissions for the data source that you want to apply overrides to.
	//
	// This member is required.
	Permissions *AssetBundleResourcePermissions
	// contains filtered or unexported fields
}

An object that contains a list of permissions to be applied to a list of data source IDs.

type AssetBundleImportJobDataSourceOverrideTags added in v1.51.0

type AssetBundleImportJobDataSourceOverrideTags struct {

	// A list of data source IDs that you want to apply overrides to. You can use * to
	// override all data sources in this asset bundle.
	//
	// This member is required.
	DataSourceIds []string

	// A list of tags for the data source that you want to apply overrides to.
	//
	// This member is required.
	Tags []Tag
	// contains filtered or unexported fields
}

An object that contains a list of tags to be assigned to a list of data source IDs.

type AssetBundleImportJobError added in v1.36.0

type AssetBundleImportJobError struct {

	// The ARN of the resource whose processing caused an error.
	Arn *string

	// A description of the error.
	Message *string

	// The specific error type or the error that occurred.
	Type *string
	// contains filtered or unexported fields
}

Describes an error that occurred within an Asset Bundle import execution.

type AssetBundleImportJobOverrideParameters added in v1.36.0

type AssetBundleImportJobOverrideParameters struct {

	// A list of overrides for any Analysis resources that are present in the asset
	// bundle that is imported.
	Analyses []AssetBundleImportJobAnalysisOverrideParameters

	// A list of overrides for any Dashboard resources that are present in the asset
	// bundle that is imported.
	Dashboards []AssetBundleImportJobDashboardOverrideParameters

	// A list of overrides for any DataSet resources that are present in the asset
	// bundle that is imported.
	DataSets []AssetBundleImportJobDataSetOverrideParameters

	// A list of overrides for any DataSource resources that are present in the asset
	// bundle that is imported.
	DataSources []AssetBundleImportJobDataSourceOverrideParameters

	// A list of overrides for any RefreshSchedule resources that are present in the
	// asset bundle that is imported.
	RefreshSchedules []AssetBundleImportJobRefreshScheduleOverrideParameters

	// An optional structure that configures resource ID overrides to be applied
	// within the import job.
	ResourceIdOverrideConfiguration *AssetBundleImportJobResourceIdOverrideConfiguration

	// A list of overrides for any Theme resources that are present in the asset
	// bundle that is imported.
	Themes []AssetBundleImportJobThemeOverrideParameters

	// A list of overrides for any VPCConnection resources that are present in the
	// asset bundle that is imported.
	VPCConnections []AssetBundleImportJobVPCConnectionOverrideParameters
	// contains filtered or unexported fields
}

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

type AssetBundleImportJobOverridePermissions added in v1.51.0

type AssetBundleImportJobOverridePermissions struct {

	// A list of permissions overrides for any Analysis resources that are present in
	// the asset bundle that is imported.
	Analyses []AssetBundleImportJobAnalysisOverridePermissions

	// A list of permissions overrides for any Dashboard resources that are present in
	// the asset bundle that is imported.
	Dashboards []AssetBundleImportJobDashboardOverridePermissions

	// A list of permissions overrides for any DataSet resources that are present in
	// the asset bundle that is imported.
	DataSets []AssetBundleImportJobDataSetOverridePermissions

	// A list of permissions overrides for any DataSource resources that are present
	// in the asset bundle that is imported.
	DataSources []AssetBundleImportJobDataSourceOverridePermissions

	// A list of permissions overrides for any Theme resources that are present in the
	// asset bundle that is imported.
	Themes []AssetBundleImportJobThemeOverridePermissions
	// contains filtered or unexported fields
}

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

type AssetBundleImportJobOverrideTags added in v1.51.0

type AssetBundleImportJobOverrideTags struct {

	// A list of tag overrides for any Analysis resources that are present in the
	// asset bundle that is imported.
	Analyses []AssetBundleImportJobAnalysisOverrideTags

	// A list of tag overrides for any Dashboard resources that are present in the
	// asset bundle that is imported.
	Dashboards []AssetBundleImportJobDashboardOverrideTags

	// A list of tag overrides for any DataSet resources that are present in the asset
	// bundle that is imported.
	DataSets []AssetBundleImportJobDataSetOverrideTags

	// A list of tag overrides for any DataSource resources that are present in the
	// asset bundle that is imported.
	DataSources []AssetBundleImportJobDataSourceOverrideTags

	// A list of tag overrides for any Theme resources that are present in the asset
	// bundle that is imported.
	Themes []AssetBundleImportJobThemeOverrideTags

	// A list of tag overrides for any VPCConnection resources that are present in the
	// asset bundle that is imported.
	VPCConnections []AssetBundleImportJobVPCConnectionOverrideTags
	// contains filtered or unexported fields
}

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

type AssetBundleImportJobOverrideValidationStrategy added in v1.51.0

type AssetBundleImportJobOverrideValidationStrategy struct {

	// A Boolean value that indicates whether to import all analyses and dashboards
	// under strict or lenient mode.
	StrictModeForAllResources bool
	// contains filtered or unexported fields
}

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

type AssetBundleImportJobRefreshScheduleOverrideParameters added in v1.36.0

type AssetBundleImportJobRefreshScheduleOverrideParameters struct {

	// A partial identifier for the specific RefreshSchedule resource that is being
	// overridden. This structure is used together with the ScheduleID structure.
	//
	// This member is required.
	DataSetId *string

	// A partial identifier for the specific RefreshSchedule resource being
	// overridden. This structure is used together with the DataSetId structure.
	//
	// This member is required.
	ScheduleId *string

	// An override for the StartAfterDateTime of a RefreshSchedule . Make sure that the
	// StartAfterDateTime is set to a time that takes place in the future.
	StartAfterDateTime *time.Time
	// contains filtered or unexported fields
}

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

type AssetBundleImportJobResourceIdOverrideConfiguration added in v1.36.0

type AssetBundleImportJobResourceIdOverrideConfiguration struct {

	// An option to request a CloudFormation variable for a prefix to be prepended to
	// each resource's ID before import. The prefix is only added to the asset IDs and
	// does not change the name of the asset.
	PrefixForAllResources *string
	// contains filtered or unexported fields
}

An optional structure that configures resource ID overrides for the import job.

type AssetBundleImportJobStatus added in v1.36.0

type AssetBundleImportJobStatus string
const (
	AssetBundleImportJobStatusQueuedForImmediateExecution AssetBundleImportJobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"
	AssetBundleImportJobStatusInProgress                  AssetBundleImportJobStatus = "IN_PROGRESS"
	AssetBundleImportJobStatusSuccessful                  AssetBundleImportJobStatus = "SUCCESSFUL"
	AssetBundleImportJobStatusFailed                      AssetBundleImportJobStatus = "FAILED"
	AssetBundleImportJobStatusFailedRollbackInProgress    AssetBundleImportJobStatus = "FAILED_ROLLBACK_IN_PROGRESS"
	AssetBundleImportJobStatusFailedRollbackCompleted     AssetBundleImportJobStatus = "FAILED_ROLLBACK_COMPLETED"
	AssetBundleImportJobStatusFailedRollbackError         AssetBundleImportJobStatus = "FAILED_ROLLBACK_ERROR"
)

Enum values for AssetBundleImportJobStatus

func (AssetBundleImportJobStatus) Values added in v1.36.0

Values returns all known values for AssetBundleImportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssetBundleImportJobSummary added in v1.36.0

type AssetBundleImportJobSummary struct {

	// The ARN of the import job.
	Arn *string

	// The ID of the job. This ID is unique while the job is running. After the job is
	// completed, you can reuse this ID for another job.
	AssetBundleImportJobId *string

	// The time that the import job was created.
	CreatedTime *time.Time

	// The failure action for the import job.
	FailureAction AssetBundleImportFailureAction

	// The current status of the import job.
	JobStatus AssetBundleImportJobStatus
	// contains filtered or unexported fields
}

A summary of the import job that includes details of the requested job's configuration and its current status.

type AssetBundleImportJobThemeOverrideParameters added in v1.36.0

type AssetBundleImportJobThemeOverrideParameters struct {

	// The ID of the theme to apply overrides to.
	//
	// This member is required.
	ThemeId *string

	// A new name for the theme.
	Name *string
	// contains filtered or unexported fields
}

The override parameters for a single theme that is imported.

type AssetBundleImportJobThemeOverridePermissions added in v1.51.0

type AssetBundleImportJobThemeOverridePermissions struct {

	// A list of permissions for the themes that you want to apply overrides to.
	//
	// This member is required.
	Permissions *AssetBundleResourcePermissions

	// A list of theme IDs that you want to apply overrides to. You can use * to
	// override all themes in this asset bundle.
	//
	// This member is required.
	ThemeIds []string
	// contains filtered or unexported fields
}

An object that contains a list of permissions to be applied to a list of theme IDs.

type AssetBundleImportJobThemeOverrideTags added in v1.51.0

type AssetBundleImportJobThemeOverrideTags struct {

	// A list of tags for the themes that you want to apply overrides to.
	//
	// This member is required.
	Tags []Tag

	// A list of theme IDs that you want to apply overrides to. You can use * to
	// override all themes in this asset bundle.
	//
	// This member is required.
	ThemeIds []string
	// contains filtered or unexported fields
}

An object that contains a list of tags to be assigned to a list of theme IDs.

type AssetBundleImportJobVPCConnectionOverrideParameters added in v1.36.0

type AssetBundleImportJobVPCConnectionOverrideParameters struct {

	// The ID of the VPC Connection to apply overrides to.
	//
	// This member is required.
	VPCConnectionId *string

	// An optional override of DNS resolvers to be used by the VPC connection.
	DnsResolvers []string

	// A new name for the VPC connection.
	Name *string

	// An optional override of the role ARN to be used by the VPC connection.
	RoleArn *string

	// A new security group ID for the VPC connection you are importing. This field is
	// required if you are importing the VPC connection from another Amazon Web
	// Services account or Region.
	SecurityGroupIds []string

	// A list of new subnet IDs for the VPC connection you are importing. This field
	// is required if you are importing the VPC connection from another Amazon Web
	// Services account or Region.
	SubnetIds []string
	// contains filtered or unexported fields
}

The override parameters for a single VPC connection that is imported.

type AssetBundleImportJobVPCConnectionOverrideTags added in v1.51.0

type AssetBundleImportJobVPCConnectionOverrideTags struct {

	// A list of tags for the VPC connections that you want to apply overrides to.
	//
	// This member is required.
	Tags []Tag

	// A list of VPC connection IDs that you want to apply overrides to. You can use *
	// to override all VPC connections in this asset bundle.
	//
	// This member is required.
	VPCConnectionIds []string
	// contains filtered or unexported fields
}

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

type AssetBundleImportJobWarning added in v1.62.0

type AssetBundleImportJobWarning struct {

	// The ARN of the resource that the warning occurred for.
	Arn *string

	// A description of the warning that occurred during an Asset Bundle import job.
	Message *string
	// contains filtered or unexported fields
}

Describes a warning that occurred during an Asset Bundle import job.

type AssetBundleImportSource added in v1.36.0

type AssetBundleImportSource struct {

	// The bytes of the base64 encoded asset bundle import zip file. This file can't
	// exceed 20 MB. If you are calling the API operations from the Amazon Web Services
	// SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically
	// to allow the direct setting of the zip file's bytes. If you are using an SDK for
	// a different language or receiving related errors, try to base64 encode your
	// data.
	Body []byte

	// The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3
	// bucket that the caller has read access to. The file must be a zip format file
	// and can't exceed 20 MB.
	S3Uri *string
	// contains filtered or unexported fields
}

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

type AssetBundleImportSourceDescription added in v1.36.0

type AssetBundleImportSourceDescription struct {

	// An HTTPS download URL for the provided asset bundle that you optionally
	// provided at the start of the import job. This URL is valid for five minutes
	// after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if
	// needed. The downloaded asset bundle is a .qs zip file.
	Body *string

	// The Amazon S3 URI that you provided at the start of the import job.
	S3Uri *string
	// contains filtered or unexported fields
}

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri , depending on how the StartAssetBundleImportJobRequest is configured.

type AssetBundleResourceLinkSharingConfiguration added in v1.51.0

type AssetBundleResourceLinkSharingConfiguration struct {

	// A list of link sharing permissions for the dashboards that you want to apply
	// overrides to.
	Permissions *AssetBundleResourcePermissions
	// contains filtered or unexported fields
}

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

type AssetBundleResourcePermissions added in v1.51.0

type AssetBundleResourcePermissions struct {

	// A list of IAM actions to grant permissions on.
	//
	// This member is required.
	Actions []string

	// A list of principals to grant permissions on.
	//
	// This member is required.
	Principals []string
	// contains filtered or unexported fields
}

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

type AssetOptions added in v1.50.0

type AssetOptions struct {

	// Determines the timezone for the analysis.
	Timezone *string

	// Determines the week start day for an analysis.
	WeekStart DayOfTheWeek
	// contains filtered or unexported fields
}

An array of analysis level configurations.

type AssignmentStatus

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

Enum values for AssignmentStatus

func (AssignmentStatus) Values added in v0.29.0

Values returns all known values for AssignmentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AthenaParameters

type AthenaParameters struct {

	// Use the RoleArn structure to override an account-wide role for a specific
	// Athena data source. For example, say an account administrator has turned off all
	// Athena access with an account-wide role. The administrator can then use RoleArn
	// to bypass the account-wide role and allow Athena access for the single Athena
	// data source that is specified in the structure, even if the account-wide role
	// forbidding Athena access is still active.
	RoleArn *string

	// The workgroup that Amazon Athena uses.
	WorkGroup *string
	// contains filtered or unexported fields
}

Parameters for Amazon Athena.

type AttributeAggregationFunction added in v1.39.0

type AttributeAggregationFunction struct {

	// The built-in aggregation functions for attributes.
	//   - UNIQUE_VALUE : Returns the unique value for a field, aggregated by the
	//   dimension fields.
	SimpleAttributeAggregation SimpleAttributeAggregationFunction

	// Used by the UNIQUE_VALUE aggregation function. If there are multiple values for
	// the field used by the aggregation, the value for this property will be returned
	// instead. Defaults to '*'.
	ValueForMultipleValues *string
	// contains filtered or unexported fields
}

Aggregation for attributes.

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
	// contains filtered or unexported fields
}

Parameters for Amazon Aurora.

type AuroraPostgreSqlParameters

type AuroraPostgreSqlParameters struct {

	// The Amazon Aurora PostgreSQL database to connect to.
	//
	// This member is required.
	Database *string

	// The Amazon Aurora PostgreSQL-Compatible host to connect to.
	//
	// This member is required.
	Host *string

	// The port that Amazon Aurora PostgreSQL is listening on.
	//
	// This member is required.
	Port *int32
	// contains filtered or unexported fields
}

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

type AuthenticationMethodOption added in v1.23.0

type AuthenticationMethodOption string
const (
	AuthenticationMethodOptionIamAndQuicksight  AuthenticationMethodOption = "IAM_AND_QUICKSIGHT"
	AuthenticationMethodOptionIamOnly           AuthenticationMethodOption = "IAM_ONLY"
	AuthenticationMethodOptionActiveDirectory   AuthenticationMethodOption = "ACTIVE_DIRECTORY"
	AuthenticationMethodOptionIamIdentityCenter AuthenticationMethodOption = "IAM_IDENTITY_CENTER"
)

Enum values for AuthenticationMethodOption

func (AuthenticationMethodOption) Values added in v1.23.0

Values returns all known values for AuthenticationMethodOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AuthorSpecifiedAggregation added in v1.35.0

type AuthorSpecifiedAggregation string
const (
	AuthorSpecifiedAggregationCount         AuthorSpecifiedAggregation = "COUNT"
	AuthorSpecifiedAggregationDistinctCount AuthorSpecifiedAggregation = "DISTINCT_COUNT"
	AuthorSpecifiedAggregationMin           AuthorSpecifiedAggregation = "MIN"
	AuthorSpecifiedAggregationMax           AuthorSpecifiedAggregation = "MAX"
	AuthorSpecifiedAggregationMedian        AuthorSpecifiedAggregation = "MEDIAN"
	AuthorSpecifiedAggregationSum           AuthorSpecifiedAggregation = "SUM"
	AuthorSpecifiedAggregationAverage       AuthorSpecifiedAggregation = "AVERAGE"
	AuthorSpecifiedAggregationStdev         AuthorSpecifiedAggregation = "STDEV"
	AuthorSpecifiedAggregationStdevp        AuthorSpecifiedAggregation = "STDEVP"
	AuthorSpecifiedAggregationVar           AuthorSpecifiedAggregation = "VAR"
	AuthorSpecifiedAggregationVarp          AuthorSpecifiedAggregation = "VARP"
	AuthorSpecifiedAggregationPercentile    AuthorSpecifiedAggregation = "PERCENTILE"
)

Enum values for AuthorSpecifiedAggregation

func (AuthorSpecifiedAggregation) Values added in v1.35.0

Values returns all known values for AuthorSpecifiedAggregation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AuthorizedTargetsByService added in v1.52.0

type AuthorizedTargetsByService struct {

	// Aist of authorized targets that are represented by IAM Identity Center
	// application ARNs.
	AuthorizedTargets []string

	// The name of the Amazon Web Services service.
	Service ServiceType
	// contains filtered or unexported fields
}

The authorized targets that are associated with a service.

type AwsIotAnalyticsParameters

type AwsIotAnalyticsParameters struct {

	// Dataset name.
	//
	// This member is required.
	DataSetName *string
	// contains filtered or unexported fields
}

The parameters for IoT Analytics.

type AxisBinding added in v1.28.0

type AxisBinding string
const (
	AxisBindingPrimaryYaxis   AxisBinding = "PRIMARY_YAXIS"
	AxisBindingSecondaryYaxis AxisBinding = "SECONDARY_YAXIS"
)

Enum values for AxisBinding

func (AxisBinding) Values added in v1.28.0

func (AxisBinding) Values() []AxisBinding

Values returns all known values for AxisBinding. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AxisDataOptions added in v1.28.0

type AxisDataOptions struct {

	// The options for an axis with a date field.
	DateAxisOptions *DateAxisOptions

	// The options for an axis with a numeric field.
	NumericAxisOptions *NumericAxisOptions
	// contains filtered or unexported fields
}

The data options for an axis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type AxisDisplayDataDrivenRange added in v1.28.0

type AxisDisplayDataDrivenRange struct {
	// contains filtered or unexported fields
}

The options that are saved for future extension.

type AxisDisplayMinMaxRange added in v1.28.0

type AxisDisplayMinMaxRange struct {

	// The maximum setup for an axis display range.
	Maximum *float64

	// The minimum setup for an axis display range.
	Minimum *float64
	// contains filtered or unexported fields
}

The minimum and maximum setup for an axis display range.

type AxisDisplayOptions added in v1.28.0

type AxisDisplayOptions struct {

	// Determines whether or not the axis line is visible.
	AxisLineVisibility Visibility

	// The offset value that determines the starting placement of the axis within a
	// visual's bounds.
	AxisOffset *string

	// The data options for an axis.
	DataOptions *AxisDataOptions

	// Determines whether or not the grid line is visible.
	GridLineVisibility Visibility

	// The scroll bar options for an axis.
	ScrollbarOptions *ScrollBarOptions

	// The tick label options of an axis.
	TickLabelOptions *AxisTickLabelOptions
	// contains filtered or unexported fields
}

The display options for the axis label.

type AxisDisplayRange added in v1.28.0

type AxisDisplayRange struct {

	// The data-driven setup of an axis display range.
	DataDriven *AxisDisplayDataDrivenRange

	// The minimum and maximum setup of an axis display range.
	MinMax *AxisDisplayMinMaxRange
	// contains filtered or unexported fields
}

The range setup of a numeric axis display range. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type AxisLabelOptions added in v1.28.0

type AxisLabelOptions struct {

	// The options that indicate which field the label belongs to.
	ApplyTo *AxisLabelReferenceOptions

	// The text for the axis label.
	CustomLabel *string

	// The font configuration of the axis label.
	FontConfiguration *FontConfiguration
	// contains filtered or unexported fields
}

The label options for a chart axis. You must specify the field that the label is targeted to.

type AxisLabelReferenceOptions added in v1.28.0

type AxisLabelReferenceOptions struct {

	// The column that the axis label is targeted to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The field that the axis label is targeted to.
	//
	// This member is required.
	FieldId *string
	// contains filtered or unexported fields
}

The reference that specifies where the axis label is applied to.

type AxisLinearScale added in v1.28.0

type AxisLinearScale struct {

	// The step count setup of a linear axis.
	StepCount *int32

	// The step size setup of a linear axis.
	StepSize *float64
	// contains filtered or unexported fields
}

The liner axis scale setup. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type AxisLogarithmicScale added in v1.28.0

type AxisLogarithmicScale struct {

	// The base setup of a logarithmic axis scale.
	Base *float64
	// contains filtered or unexported fields
}

The logarithmic axis scale setup.

type AxisScale added in v1.28.0

type AxisScale struct {

	// The linear axis scale setup.
	Linear *AxisLinearScale

	// The logarithmic axis scale setup.
	Logarithmic *AxisLogarithmicScale
	// contains filtered or unexported fields
}

The scale setup options for a numeric axis display. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type AxisTickLabelOptions added in v1.28.0

type AxisTickLabelOptions struct {

	// Determines whether or not the axis ticks are visible.
	LabelOptions *LabelOptions

	// The rotation angle of the axis tick labels.
	RotationAngle *float64
	// contains filtered or unexported fields
}

The tick label options of an axis.

type BarChartAggregatedFieldWells added in v1.28.0

type BarChartAggregatedFieldWells struct {

	// The category (y-axis) field well of a bar chart.
	Category []DimensionField

	// The color (group/color) field well of a bar chart.
	Colors []DimensionField

	// The small multiples field well of a bar chart.
	SmallMultiples []DimensionField

	// The value field wells of a bar chart. Values are aggregated by category.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field wells of a bar chart.

type BarChartConfiguration added in v1.28.0

type BarChartConfiguration struct {

	// Determines the arrangement of the bars. The orientation and arrangement of bars
	// determine the type of bar that is used in the visual.
	BarsArrangement BarsArrangement

	// The label display options (grid line, range, scale, axis step) for bar chart
	// category.
	CategoryAxis *AxisDisplayOptions

	// The label options (label text, label visibility and sort icon visibility) for a
	// bar chart.
	CategoryLabelOptions *ChartAxisLabelOptions

	// The label options (label text, label visibility and sort icon visibility) for a
	// color that is used in a bar chart.
	ColorLabelOptions *ChartAxisLabelOptions

	// The contribution analysis (anomaly configuration) setup of the visual.
	ContributionAnalysisDefaults []ContributionAnalysisDefault

	// The options that determine if visual data labels are displayed.
	DataLabels *DataLabelOptions

	// The field wells of the visual.
	FieldWells *BarChartFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The orientation of the bars in a bar chart visual. There are two valid values
	// in this structure:
	//   - HORIZONTAL : Used for charts that have horizontal bars. Visuals that use
	//   this value are horizontal bar charts, horizontal stacked bar charts, and
	//   horizontal stacked 100% bar charts.
	//   - VERTICAL : Used for charts that have vertical bars. Visuals that use this
	//   value are vertical bar charts, vertical stacked bar charts, and vertical stacked
	//   100% bar charts.
	Orientation BarChartOrientation

	// The reference line setup of the visual.
	ReferenceLines []ReferenceLine

	// The small multiples setup for the visual.
	SmallMultiplesOptions *SmallMultiplesOptions

	// The sort configuration of a BarChartVisual .
	SortConfiguration *BarChartSortConfiguration

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions

	// The label display options (grid line, range, scale, axis step) for a bar chart
	// value.
	ValueAxis *AxisDisplayOptions

	// The label options (label text, label visibility and sort icon visibility) for a
	// bar chart value.
	ValueLabelOptions *ChartAxisLabelOptions

	// The palette (chart color) display setup of the visual.
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a BarChartVisual .

type BarChartFieldWells added in v1.28.0

type BarChartFieldWells struct {

	// The aggregated field wells of a bar chart.
	BarChartAggregatedFieldWells *BarChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a BarChartVisual . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type BarChartOrientation added in v1.28.0

type BarChartOrientation string
const (
	BarChartOrientationHorizontal BarChartOrientation = "HORIZONTAL"
	BarChartOrientationVertical   BarChartOrientation = "VERTICAL"
)

Enum values for BarChartOrientation

func (BarChartOrientation) Values added in v1.28.0

Values returns all known values for BarChartOrientation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BarChartSortConfiguration added in v1.28.0

type BarChartSortConfiguration struct {

	// The limit on the number of categories displayed in a bar chart.
	CategoryItemsLimit *ItemsLimitConfiguration

	// The sort configuration of category fields.
	CategorySort []FieldSortOptions

	// The limit on the number of values displayed in a bar chart.
	ColorItemsLimit *ItemsLimitConfiguration

	// The sort configuration of color fields in a bar chart.
	ColorSort []FieldSortOptions

	// The limit on the number of small multiples panels that are displayed.
	SmallMultiplesLimitConfiguration *ItemsLimitConfiguration

	// The sort configuration of the small multiples field.
	SmallMultiplesSort []FieldSortOptions
	// contains filtered or unexported fields
}

sort-configuration-description

type BarChartVisual added in v1.28.0

type BarChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *BarChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A bar chart. The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

  • Horizontal bar chart
  • Vertical bar chart
  • Horizontal stacked bar chart
  • Vertical stacked bar chart
  • Horizontal stacked 100% bar chart
  • Vertical stacked 100% bar chart

For more information, see Using bar charts (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the Amazon QuickSight User Guide.

type BarsArrangement added in v1.28.0

type BarsArrangement string
const (
	BarsArrangementClustered      BarsArrangement = "CLUSTERED"
	BarsArrangementStacked        BarsArrangement = "STACKED"
	BarsArrangementStackedPercent BarsArrangement = "STACKED_PERCENT"
)

Enum values for BarsArrangement

func (BarsArrangement) Values added in v1.28.0

func (BarsArrangement) Values() []BarsArrangement

Values returns all known values for BarsArrangement. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BaseMapStyleType added in v1.28.0

type BaseMapStyleType string
const (
	BaseMapStyleTypeLightGray BaseMapStyleType = "LIGHT_GRAY"
	BaseMapStyleTypeDarkGray  BaseMapStyleType = "DARK_GRAY"
	BaseMapStyleTypeStreet    BaseMapStyleType = "STREET"
	BaseMapStyleTypeImagery   BaseMapStyleType = "IMAGERY"
)

Enum values for BaseMapStyleType

func (BaseMapStyleType) Values added in v1.28.0

Values returns all known values for BaseMapStyleType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BigQueryParameters added in v1.51.0

type BigQueryParameters struct {

	// The Google Cloud Platform project ID where your datasource was created.
	//
	// This member is required.
	ProjectId *string

	// The storage location where you create a Google BigQuery data source.
	DataSetRegion *string
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Google BigQuery data source.

type BinCountOptions added in v1.28.0

type BinCountOptions struct {

	// The options that determine the bin count value.
	Value *int32
	// contains filtered or unexported fields
}

The options that determine the bin count of a histogram.

type BinWidthOptions added in v1.28.0

type BinWidthOptions struct {

	// The options that determine the bin count limit.
	BinCountLimit *int64

	// The options that determine the bin width value.
	Value *float64
	// contains filtered or unexported fields
}

The options that determine the bin width of a histogram.

type BodySectionConfiguration added in v1.28.0

type BodySectionConfiguration struct {

	// The configuration of content in a body section.
	//
	// This member is required.
	Content *BodySectionContent

	// The unique identifier of a body section.
	//
	// This member is required.
	SectionId *string

	// The configuration of a page break for a section.
	PageBreakConfiguration *SectionPageBreakConfiguration

	// The style options of a body section.
	Style *SectionStyle
	// contains filtered or unexported fields
}

The configuration of a body section.

type BodySectionContent added in v1.28.0

type BodySectionContent struct {

	// The layout configuration of a body section.
	Layout *SectionLayoutConfiguration
	// contains filtered or unexported fields
}

The configuration of content in a body section.

type BookmarksConfigurations added in v1.35.0

type BookmarksConfigurations struct {

	// A Boolean value that determines whether a user can bookmark an embedded
	// dashboard.
	//
	// This member is required.
	Enabled bool
	// contains filtered or unexported fields
}

The bookmarks configuration of an embedded dashboard.

type BorderStyle

type BorderStyle struct {

	// The option to enable display of borders for visuals.
	Show *bool
	// contains filtered or unexported fields
}

The display options for tile borders for visuals.

type BoxPlotAggregatedFieldWells added in v1.28.0

type BoxPlotAggregatedFieldWells struct {

	// The group by field well of a box plot chart. Values are grouped based on group
	// by fields.
	GroupBy []DimensionField

	// The value field well of a box plot chart. Values are aggregated based on group
	// by fields.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field well for a box plot.

type BoxPlotChartConfiguration added in v1.28.0

type BoxPlotChartConfiguration struct {

	// The box plot chart options for a box plot visual
	BoxPlotOptions *BoxPlotOptions

	// The label display options (grid line, range, scale, axis step) of a box plot
	// category.
	CategoryAxis *AxisDisplayOptions

	// The label options (label text, label visibility and sort Icon visibility) of a
	// box plot category.
	CategoryLabelOptions *ChartAxisLabelOptions

	// The field wells of the visual.
	FieldWells *BoxPlotFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The options for the legend setup of a visual.
	Legend *LegendOptions

	// The label display options (grid line, range, scale, axis step) of a box plot
	// category.
	PrimaryYAxisDisplayOptions *AxisDisplayOptions

	// The label options (label text, label visibility and sort icon visibility) of a
	// box plot value.
	PrimaryYAxisLabelOptions *ChartAxisLabelOptions

	// The reference line setup of the visual.
	ReferenceLines []ReferenceLine

	// The sort configuration of a BoxPlotVisual .
	SortConfiguration *BoxPlotSortConfiguration

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions

	// The palette (chart color) display setup of the visual.
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a BoxPlotVisual .

type BoxPlotFieldWells added in v1.28.0

type BoxPlotFieldWells struct {

	// The aggregated field wells of a box plot.
	BoxPlotAggregatedFieldWells *BoxPlotAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a BoxPlotVisual . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type BoxPlotFillStyle added in v1.28.0

type BoxPlotFillStyle string
const (
	BoxPlotFillStyleSolid       BoxPlotFillStyle = "SOLID"
	BoxPlotFillStyleTransparent BoxPlotFillStyle = "TRANSPARENT"
)

Enum values for BoxPlotFillStyle

func (BoxPlotFillStyle) Values added in v1.28.0

Values returns all known values for BoxPlotFillStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BoxPlotOptions added in v1.28.0

type BoxPlotOptions struct {

	// Determines the visibility of all data points of the box plot.
	AllDataPointsVisibility Visibility

	// Determines the visibility of the outlier in a box plot.
	OutlierVisibility Visibility

	// The style options of the box plot.
	StyleOptions *BoxPlotStyleOptions
	// contains filtered or unexported fields
}

The options of a box plot visual.

type BoxPlotSortConfiguration added in v1.28.0

type BoxPlotSortConfiguration struct {

	// The sort configuration of a group by fields.
	CategorySort []FieldSortOptions

	// The pagination configuration of a table visual or box plot.
	PaginationConfiguration *PaginationConfiguration
	// contains filtered or unexported fields
}

The sort configuration of a BoxPlotVisual .

type BoxPlotStyleOptions added in v1.28.0

type BoxPlotStyleOptions struct {

	// The fill styles (solid, transparent) of the box plot.
	FillStyle BoxPlotFillStyle
	// contains filtered or unexported fields
}

The style options of the box plot.

type BoxPlotVisual added in v1.28.0

type BoxPlotVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *BoxPlotChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A box plot. For more information, see Using box plots (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the Amazon QuickSight User Guide.

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
	// contains filtered or unexported fields
}

A calculated column for a dataset.

type CalculatedField added in v1.28.0

type CalculatedField struct {

	// The data set that is used in this calculated field.
	//
	// This member is required.
	DataSetIdentifier *string

	// The expression of the calculated field.
	//
	// This member is required.
	Expression *string

	// The name of the calculated field.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The calculated field of an analysis.

type CalculatedMeasureField added in v1.28.0

type CalculatedMeasureField struct {

	// The expression in the table calculation.
	//
	// This member is required.
	Expression *string

	// The custom field ID.
	//
	// This member is required.
	FieldId *string
	// contains filtered or unexported fields
}

The table calculation measure field for pivot tables.

type CascadingControlConfiguration added in v1.28.0

type CascadingControlConfiguration struct {

	// A list of source controls that determine the values that are used in the
	// current control.
	SourceControls []CascadingControlSource
	// contains filtered or unexported fields
}

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

type CascadingControlSource added in v1.28.0

type CascadingControlSource struct {

	// The column identifier that determines which column to look up for the source
	// sheet control.
	ColumnToMatch *ColumnIdentifier

	// The source sheet control ID of a CascadingControlSource .
	SourceSheetControlId *string
	// contains filtered or unexported fields
}

The source controls that are used in a CascadingControlConfiguration .

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

	// The sub data type of the new column. Sub types are only available for decimal
	// columns that are part of a SPICE dataset.
	SubType ColumnDataSubType
	// contains filtered or unexported fields
}

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

type CategoricalAggregationFunction added in v1.28.0

type CategoricalAggregationFunction string
const (
	CategoricalAggregationFunctionCount         CategoricalAggregationFunction = "COUNT"
	CategoricalAggregationFunctionDistinctCount CategoricalAggregationFunction = "DISTINCT_COUNT"
)

Enum values for CategoricalAggregationFunction

func (CategoricalAggregationFunction) Values added in v1.28.0

Values returns all known values for CategoricalAggregationFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CategoricalDimensionField added in v1.28.0

type CategoricalDimensionField struct {

	// The column that is used in the CategoricalDimensionField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The format configuration of the field.
	FormatConfiguration *StringFormatConfiguration

	// The custom hierarchy ID.
	HierarchyId *string
	// contains filtered or unexported fields
}

The dimension type field with categorical type columns..

type CategoricalMeasureField added in v1.28.0

type CategoricalMeasureField struct {

	// The column that is used in the CategoricalMeasureField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The aggregation function of the measure field.
	AggregationFunction CategoricalAggregationFunction

	// The format configuration of the field.
	FormatConfiguration *StringFormatConfiguration
	// contains filtered or unexported fields
}

The measure type field with categorical type columns.

type CategoryDrillDownFilter added in v1.28.0

type CategoryDrillDownFilter struct {

	// A list of the string inputs that are the values of the category drill down
	// filter.
	//
	// This member is required.
	CategoryValues []string

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier
	// contains filtered or unexported fields
}

The category drill down filter.

type CategoryFilter added in v1.28.0

type CategoryFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The configuration for a CategoryFilter .
	//
	// This member is required.
	Configuration *CategoryFilterConfiguration

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration
	// contains filtered or unexported fields
}

A CategoryFilter filters text values. For more information, see Adding text filters (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the Amazon QuickSight User Guide.

type CategoryFilterConfiguration added in v1.28.0

type CategoryFilterConfiguration struct {

	// A custom filter that filters based on a single value. This filter can be
	// partially matched.
	CustomFilterConfiguration *CustomFilterConfiguration

	// A list of custom filter values. In the Amazon QuickSight console, this filter
	// type is called a custom filter list.
	CustomFilterListConfiguration *CustomFilterListConfiguration

	// A list of filter configurations. In the Amazon QuickSight console, this filter
	// type is called a filter list.
	FilterListConfiguration *FilterListConfiguration
	// contains filtered or unexported fields
}

The configuration for a CategoryFilter . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type CategoryFilterFunction added in v1.35.0

type CategoryFilterFunction string
const (
	CategoryFilterFunctionExact    CategoryFilterFunction = "EXACT"
	CategoryFilterFunctionContains CategoryFilterFunction = "CONTAINS"
)

Enum values for CategoryFilterFunction

func (CategoryFilterFunction) Values added in v1.35.0

Values returns all known values for CategoryFilterFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CategoryFilterMatchOperator added in v1.28.0

type CategoryFilterMatchOperator string
const (
	CategoryFilterMatchOperatorEquals         CategoryFilterMatchOperator = "EQUALS"
	CategoryFilterMatchOperatorDoesNotEqual   CategoryFilterMatchOperator = "DOES_NOT_EQUAL"
	CategoryFilterMatchOperatorContains       CategoryFilterMatchOperator = "CONTAINS"
	CategoryFilterMatchOperatorDoesNotContain CategoryFilterMatchOperator = "DOES_NOT_CONTAIN"
	CategoryFilterMatchOperatorStartsWith     CategoryFilterMatchOperator = "STARTS_WITH"
	CategoryFilterMatchOperatorEndsWith       CategoryFilterMatchOperator = "ENDS_WITH"
)

Enum values for CategoryFilterMatchOperator

func (CategoryFilterMatchOperator) Values added in v1.28.0

Values returns all known values for CategoryFilterMatchOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CategoryFilterSelectAllOptions added in v1.28.0

type CategoryFilterSelectAllOptions string
const (
	CategoryFilterSelectAllOptionsFilterAllValues CategoryFilterSelectAllOptions = "FILTER_ALL_VALUES"
)

Enum values for CategoryFilterSelectAllOptions

func (CategoryFilterSelectAllOptions) Values added in v1.28.0

Values returns all known values for CategoryFilterSelectAllOptions. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CategoryFilterType added in v1.35.0

type CategoryFilterType string
const (
	CategoryFilterTypeCustomFilter     CategoryFilterType = "CUSTOM_FILTER"
	CategoryFilterTypeCustomFilterList CategoryFilterType = "CUSTOM_FILTER_LIST"
	CategoryFilterTypeFilterList       CategoryFilterType = "FILTER_LIST"
)

Enum values for CategoryFilterType

func (CategoryFilterType) Values added in v1.35.0

Values returns all known values for CategoryFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CellValueSynonym added in v1.35.0

type CellValueSynonym struct {

	// The cell value.
	CellValue *string

	// Other names or aliases for the cell value.
	Synonyms []string
	// contains filtered or unexported fields
}

A structure that represents the cell value synonym.

type ChartAxisLabelOptions added in v1.28.0

type ChartAxisLabelOptions struct {

	// The label options for a chart axis.
	AxisLabelOptions []AxisLabelOptions

	// The visibility configuration of the sort icon on a chart's axis label.
	SortIconVisibility Visibility

	// The visibility of an axis label on a chart. Choose one of the following
	// options:
	//   - VISIBLE : Shows the axis.
	//   - HIDDEN : Hides the axis.
	Visibility Visibility
	// contains filtered or unexported fields
}

The label options for an axis on a chart.

type ClusterMarker added in v1.28.0

type ClusterMarker struct {

	// The simple cluster marker of the cluster marker.
	SimpleClusterMarker *SimpleClusterMarker
	// contains filtered or unexported fields
}

The cluster marker that is a part of the cluster marker configuration.

type ClusterMarkerConfiguration added in v1.28.0

type ClusterMarkerConfiguration struct {

	// The cluster marker that is a part of the cluster marker configuration.
	ClusterMarker *ClusterMarker
	// contains filtered or unexported fields
}

The cluster marker configuration of the geospatial map selected point style.

type CollectiveConstant added in v1.35.0

type CollectiveConstant struct {

	// A list of values for the collective constant.
	ValueList []string
	// contains filtered or unexported fields
}

A structure that represents a collective constant.

type ColorFillType added in v1.28.0

type ColorFillType string
const (
	ColorFillTypeDiscrete ColorFillType = "DISCRETE"
	ColorFillTypeGradient ColorFillType = "GRADIENT"
)

Enum values for ColorFillType

func (ColorFillType) Values added in v1.28.0

func (ColorFillType) Values() []ColorFillType

Values returns all known values for ColorFillType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ColorScale added in v1.28.0

type ColorScale struct {

	// Determines the color fill type.
	//
	// This member is required.
	ColorFillType ColorFillType

	// Determines the list of colors that are applied to the visual.
	//
	// This member is required.
	Colors []DataColor

	// Determines the color that is applied to null values.
	NullValueColor *DataColor
	// contains filtered or unexported fields
}

Determines the color scale that is applied to the visual.

type ColorsConfiguration added in v1.38.0

type ColorsConfiguration struct {

	// A list of up to 50 custom colors.
	CustomColors []CustomColor
	// contains filtered or unexported fields
}

The color configurations for a column.

type ColumnConfiguration added in v1.28.0

type ColumnConfiguration struct {

	// The column.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The color configurations of the column.
	ColorsConfiguration *ColorsConfiguration

	// The format configuration of a column.
	FormatConfiguration *FormatConfiguration

	// The role of the column.
	Role ColumnRole
	// contains filtered or unexported fields
}

The general configuration of a column.

type ColumnDataRole added in v1.35.0

type ColumnDataRole string
const (
	ColumnDataRoleDimension ColumnDataRole = "DIMENSION"
	ColumnDataRoleMeasure   ColumnDataRole = "MEASURE"
)

Enum values for ColumnDataRole

func (ColumnDataRole) Values added in v1.35.0

func (ColumnDataRole) Values() []ColumnDataRole

Values returns all known values for ColumnDataRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ColumnDataSubType added in v1.50.0

type ColumnDataSubType string
const (
	ColumnDataSubTypeFloat ColumnDataSubType = "FLOAT"
	ColumnDataSubTypeFixed ColumnDataSubType = "FIXED"
)

Enum values for ColumnDataSubType

func (ColumnDataSubType) Values added in v1.50.0

Values returns all known values for ColumnDataSubType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ColumnDataType

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

Enum values for ColumnDataType

func (ColumnDataType) Values added in v0.29.0

func (ColumnDataType) Values() []ColumnDataType

Values returns all known values for ColumnDataType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ColumnDescription added in v0.29.0

type ColumnDescription struct {

	// The text of a description for a column.
	Text *string
	// contains filtered or unexported fields
}

Metadata that contains a description for a column.

type ColumnGroup

type ColumnGroup struct {

	// Geospatial column group that denotes a hierarchy.
	GeoSpatialColumnGroup *GeoSpatialColumnGroup
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The column group schema.

type ColumnHierarchy added in v1.28.0

type ColumnHierarchy struct {

	// The option that determines the hierarchy of any DateTime fields.
	DateTimeHierarchy *DateTimeHierarchy

	// The option that determines the hierarchy of the fields that are built within a
	// visual's field wells. These fields can't be duplicated to other visuals.
	ExplicitHierarchy *ExplicitHierarchy

	// The option that determines the hierarchy of the fields that are defined during
	// data preparation. These fields are available to use in any analysis that uses
	// the data source.
	PredefinedHierarchy *PredefinedHierarchy
	// contains filtered or unexported fields
}

The option that determines the hierarchy of the fields for a visual element.

type ColumnIdentifier added in v1.28.0

type ColumnIdentifier struct {

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

	// The data set that the column belongs to.
	//
	// This member is required.
	DataSetIdentifier *string
	// contains filtered or unexported fields
}

A column of a data set.

type ColumnLevelPermissionRule added in v0.30.0

type ColumnLevelPermissionRule struct {

	// An array of column names.
	ColumnNames []string

	// An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
	Principals []string
	// contains filtered or unexported fields
}

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.

type ColumnOrderingType added in v1.35.0

type ColumnOrderingType string
const (
	ColumnOrderingTypeGreaterIsBetter ColumnOrderingType = "GREATER_IS_BETTER"
	ColumnOrderingTypeLesserIsBetter  ColumnOrderingType = "LESSER_IS_BETTER"
	ColumnOrderingTypeSpecified       ColumnOrderingType = "SPECIFIED"
)

Enum values for ColumnOrderingType

func (ColumnOrderingType) Values added in v1.35.0

Values returns all known values for ColumnOrderingType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ColumnRole added in v1.28.0

type ColumnRole string
const (
	ColumnRoleDimension ColumnRole = "DIMENSION"
	ColumnRoleMeasure   ColumnRole = "MEASURE"
)

Enum values for ColumnRole

func (ColumnRole) Values added in v1.28.0

func (ColumnRole) Values() []ColumnRole

Values returns all known values for ColumnRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

The column schema.

type ColumnSort added in v1.28.0

type ColumnSort struct {

	// The sort direction.
	//
	// This member is required.
	Direction SortDirection

	// A column of a data set.
	//
	// This member is required.
	SortBy *ColumnIdentifier

	// The aggregation function that is defined in the column sort.
	AggregationFunction *AggregationFunction
	// contains filtered or unexported fields
}

The sort configuration for a column that is not used in a field well.

type ColumnTag

type ColumnTag struct {

	// A description for a column.
	ColumnDescription *ColumnDescription

	// A geospatial role for a column.
	ColumnGeographicRole GeoSpatialDataRole
	// contains filtered or unexported fields
}

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.

type ColumnTagName added in v1.10.0

type ColumnTagName string
const (
	ColumnTagNameColumnGeographicRole ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE"
	ColumnTagNameColumnDescription    ColumnTagName = "COLUMN_DESCRIPTION"
)

Enum values for ColumnTagName

func (ColumnTagName) Values added in v1.10.0

func (ColumnTagName) Values() []ColumnTagName

Values returns all known values for ColumnTagName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ColumnTooltipItem added in v1.28.0

type ColumnTooltipItem struct {

	// The target column of the tooltip item.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The aggregation function of the column tooltip item.
	Aggregation *AggregationFunction

	// The label of the tooltip item.
	Label *string

	// Determines the target of the column tooltip item in a combo chart visual.
	TooltipTarget TooltipTarget

	// The visibility of the tooltip item.
	Visibility Visibility
	// contains filtered or unexported fields
}

The tooltip item for the columns that are not part of a field well.

type ComboChartAggregatedFieldWells added in v1.28.0

type ComboChartAggregatedFieldWells struct {

	// The aggregated BarValues field well of a combo chart.
	BarValues []MeasureField

	// The aggregated category field wells of a combo chart.
	Category []DimensionField

	// The aggregated colors field well of a combo chart.
	Colors []DimensionField

	// The aggregated LineValues field well of a combo chart.
	LineValues []MeasureField
	// contains filtered or unexported fields
}

The aggregated field wells of a combo chart.

type ComboChartConfiguration added in v1.28.0

type ComboChartConfiguration struct {

	// The options that determine if visual data labels are displayed. The data label
	// options for a bar in a combo chart.
	BarDataLabels *DataLabelOptions

	// Determines the bar arrangement in a combo chart. The following are valid values
	// in this structure:
	//   - CLUSTERED : For clustered bar combo charts.
	//   - STACKED : For stacked bar combo charts.
	//   - STACKED_PERCENT : Do not use. If you use this value, the operation returns a
	//   validation error.
	BarsArrangement BarsArrangement

	// The category axis of a combo chart.
	CategoryAxis *AxisDisplayOptions

	// The label options (label text, label visibility, and sort icon visibility) of a
	// combo chart category (group/color) field well.
	CategoryLabelOptions *ChartAxisLabelOptions

	// The label options (label text, label visibility, and sort icon visibility) of a
	// combo chart's color field well.
	ColorLabelOptions *ChartAxisLabelOptions

	// The field wells of the visual.
	FieldWells *ComboChartFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The options that determine if visual data labels are displayed. The data label
	// options for a line in a combo chart.
	LineDataLabels *DataLabelOptions

	// The label display options (grid line, range, scale, and axis step) of a combo
	// chart's primary y-axis (bar) field well.
	PrimaryYAxisDisplayOptions *AxisDisplayOptions

	// The label options (label text, label visibility, and sort icon visibility) of a
	// combo chart's primary y-axis (bar) field well.
	PrimaryYAxisLabelOptions *ChartAxisLabelOptions

	// The reference line setup of the visual.
	ReferenceLines []ReferenceLine

	// The label display options (grid line, range, scale, axis step) of a combo
	// chart's secondary y-axis (line) field well.
	SecondaryYAxisDisplayOptions *AxisDisplayOptions

	// The label options (label text, label visibility, and sort icon visibility) of a
	// combo chart's secondary y-axis(line) field well.
	SecondaryYAxisLabelOptions *ChartAxisLabelOptions

	// The settings of a chart's single axis configuration.
	SingleAxisOptions *SingleAxisOptions

	// The sort configuration of a ComboChartVisual .
	SortConfiguration *ComboChartSortConfiguration

	// The legend display setup of the visual.
	Tooltip *TooltipOptions

	// The palette (chart color) display setup of the visual.
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a ComboChartVisual .

type ComboChartFieldWells added in v1.28.0

type ComboChartFieldWells struct {

	// The aggregated field wells of a combo chart. Combo charts only have aggregated
	// field wells. Columns in a combo chart are aggregated by category.
	ComboChartAggregatedFieldWells *ComboChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of the visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ComboChartSortConfiguration added in v1.28.0

type ComboChartSortConfiguration struct {

	// The item limit configuration for the category field well of a combo chart.
	CategoryItemsLimit *ItemsLimitConfiguration

	// The sort configuration of the category field well in a combo chart.
	CategorySort []FieldSortOptions

	// The item limit configuration of the color field well in a combo chart.
	ColorItemsLimit *ItemsLimitConfiguration

	// The sort configuration of the color field well in a combo chart.
	ColorSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a ComboChartVisual .

type ComboChartVisual added in v1.28.0

type ComboChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *ComboChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A combo chart. The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts For more information, see Using combo charts (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the Amazon QuickSight User Guide.

type ComparativeOrder added in v1.35.0

type ComparativeOrder struct {

	// The list of columns to be used in the ordering.
	SpecifedOrder []string

	// The treat of undefined specified values. Valid values for this structure are
	// LEAST and MOST .
	TreatUndefinedSpecifiedValues UndefinedSpecifiedValueType

	// The ordering type for a column. Valid values for this structure are
	// GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
	UseOrdering ColumnOrderingType
	// contains filtered or unexported fields
}

A structure that represents a comparative order.

type ComparisonConfiguration added in v1.28.0

type ComparisonConfiguration struct {

	// The format of the comparison.
	ComparisonFormat *ComparisonFormatConfiguration

	// The method of the comparison. Choose from the following options:
	//   - DIFFERENCE
	//   - PERCENT_DIFFERENCE
	//   - PERCENT
	ComparisonMethod ComparisonMethod
	// contains filtered or unexported fields
}

The comparison display configuration of a KPI or gauge chart.

type ComparisonFormatConfiguration added in v1.28.0

type ComparisonFormatConfiguration struct {

	// The number display format.
	NumberDisplayFormatConfiguration *NumberDisplayFormatConfiguration

	// The percentage display format.
	PercentageDisplayFormatConfiguration *PercentageDisplayFormatConfiguration
	// contains filtered or unexported fields
}

The format of the comparison. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ComparisonMethod added in v1.28.0

type ComparisonMethod string
const (
	ComparisonMethodDifference        ComparisonMethod = "DIFFERENCE"
	ComparisonMethodPercentDifference ComparisonMethod = "PERCENT_DIFFERENCE"
	ComparisonMethodPercent           ComparisonMethod = "PERCENT"
)

Enum values for ComparisonMethod

func (ComparisonMethod) Values added in v1.28.0

Values returns all known values for ComparisonMethod. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Computation added in v1.28.0

type Computation struct {

	// The forecast computation configuration.
	Forecast *ForecastComputation

	// The growth rate computation configuration.
	GrowthRate *GrowthRateComputation

	// The maximum and minimum computation configuration.
	MaximumMinimum *MaximumMinimumComputation

	// The metric comparison computation configuration.
	MetricComparison *MetricComparisonComputation

	// The period over period computation configuration.
	PeriodOverPeriod *PeriodOverPeriodComputation

	// The period to DataSetIdentifier computation configuration.
	PeriodToDate *PeriodToDateComputation

	// The top movers and bottom movers computation configuration.
	TopBottomMovers *TopBottomMoversComputation

	// The top ranked and bottom ranked computation configuration.
	TopBottomRanked *TopBottomRankedComputation

	// The total aggregation computation configuration.
	TotalAggregation *TotalAggregationComputation

	// The unique values computation configuration.
	UniqueValues *UniqueValuesComputation
	// contains filtered or unexported fields
}

The computation union that is used in an insight visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ConcurrentUpdatingException

type ConcurrentUpdatingException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

A resource is already in a state that indicates an operation 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 ConditionalFormattingColor added in v1.28.0

type ConditionalFormattingColor struct {

	// Formatting configuration for gradient color.
	Gradient *ConditionalFormattingGradientColor

	// Formatting configuration for solid color.
	Solid *ConditionalFormattingSolidColor
	// contains filtered or unexported fields
}

The formatting configuration for the color.

type ConditionalFormattingCustomIconCondition added in v1.28.0

type ConditionalFormattingCustomIconCondition struct {

	// The expression that determines the condition of the icon set.
	//
	// This member is required.
	Expression *string

	// Custom icon options for an icon set.
	//
	// This member is required.
	IconOptions *ConditionalFormattingCustomIconOptions

	// Determines the color of the icon.
	Color *string

	// Determines the icon display configuration.
	DisplayConfiguration *ConditionalFormattingIconDisplayConfiguration
	// contains filtered or unexported fields
}

Determines the custom condition for an icon set.

type ConditionalFormattingCustomIconOptions added in v1.28.0

type ConditionalFormattingCustomIconOptions struct {

	// Determines the type of icon.
	Icon Icon

	// Determines the Unicode icon type.
	UnicodeIcon *string
	// contains filtered or unexported fields
}

Custom icon options for an icon set.

type ConditionalFormattingGradientColor added in v1.28.0

type ConditionalFormattingGradientColor struct {

	// Determines the color.
	//
	// This member is required.
	Color *GradientColor

	// The expression that determines the formatting configuration for gradient color.
	//
	// This member is required.
	Expression *string
	// contains filtered or unexported fields
}

Formatting configuration for gradient color.

type ConditionalFormattingIcon added in v1.28.0

type ConditionalFormattingIcon struct {

	// Determines the custom condition for an icon set.
	CustomCondition *ConditionalFormattingCustomIconCondition

	// Formatting configuration for icon set.
	IconSet *ConditionalFormattingIconSet
	// contains filtered or unexported fields
}

The formatting configuration for the icon.

type ConditionalFormattingIconDisplayConfiguration added in v1.28.0

type ConditionalFormattingIconDisplayConfiguration struct {

	// Determines the icon display configuration.
	IconDisplayOption ConditionalFormattingIconDisplayOption
	// contains filtered or unexported fields
}

Determines the icon display configuration.

type ConditionalFormattingIconDisplayOption added in v1.28.0

type ConditionalFormattingIconDisplayOption string
const (
	ConditionalFormattingIconDisplayOptionIconOnly ConditionalFormattingIconDisplayOption = "ICON_ONLY"
)

Enum values for ConditionalFormattingIconDisplayOption

func (ConditionalFormattingIconDisplayOption) Values added in v1.28.0

Values returns all known values for ConditionalFormattingIconDisplayOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConditionalFormattingIconSet added in v1.28.0

type ConditionalFormattingIconSet struct {

	// The expression that determines the formatting configuration for the icon set.
	//
	// This member is required.
	Expression *string

	// Determines the icon set type.
	IconSetType ConditionalFormattingIconSetType
	// contains filtered or unexported fields
}

Formatting configuration for icon set.

type ConditionalFormattingIconSetType added in v1.28.0

type ConditionalFormattingIconSetType string
const (
	ConditionalFormattingIconSetTypePlusMinus        ConditionalFormattingIconSetType = "PLUS_MINUS"
	ConditionalFormattingIconSetTypeCheckX           ConditionalFormattingIconSetType = "CHECK_X"
	ConditionalFormattingIconSetTypeThreeColorArrow  ConditionalFormattingIconSetType = "THREE_COLOR_ARROW"
	ConditionalFormattingIconSetTypeThreeGrayArrow   ConditionalFormattingIconSetType = "THREE_GRAY_ARROW"
	ConditionalFormattingIconSetTypeCaretUpMinusDown ConditionalFormattingIconSetType = "CARET_UP_MINUS_DOWN"
	ConditionalFormattingIconSetTypeThreeShape       ConditionalFormattingIconSetType = "THREE_SHAPE"
	ConditionalFormattingIconSetTypeThreeCircle      ConditionalFormattingIconSetType = "THREE_CIRCLE"
	ConditionalFormattingIconSetTypeFlags            ConditionalFormattingIconSetType = "FLAGS"
	ConditionalFormattingIconSetTypeBars             ConditionalFormattingIconSetType = "BARS"
	ConditionalFormattingIconSetTypeFourColorArrow   ConditionalFormattingIconSetType = "FOUR_COLOR_ARROW"
	ConditionalFormattingIconSetTypeFourGrayArrow    ConditionalFormattingIconSetType = "FOUR_GRAY_ARROW"
)

Enum values for ConditionalFormattingIconSetType

func (ConditionalFormattingIconSetType) Values added in v1.28.0

Values returns all known values for ConditionalFormattingIconSetType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConditionalFormattingSolidColor added in v1.28.0

type ConditionalFormattingSolidColor struct {

	// The expression that determines the formatting configuration for solid color.
	//
	// This member is required.
	Expression *string

	// Determines the color.
	Color *string
	// contains filtered or unexported fields
}

Formatting configuration for solid color.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 ConstantType added in v1.35.0

type ConstantType string
const (
	ConstantTypeSingular   ConstantType = "SINGULAR"
	ConstantTypeRange      ConstantType = "RANGE"
	ConstantTypeCollective ConstantType = "COLLECTIVE"
)

Enum values for ConstantType

func (ConstantType) Values added in v1.35.0

func (ConstantType) Values() []ConstantType

Values returns all known values for ConstantType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ContextMenuOption added in v1.56.0

type ContextMenuOption struct {

	// The availability status of the context menu options. If the value of this
	// property is set to ENABLED , dashboard readers can interact with the context
	// menu.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The context menu options for a visual's interactions.

type ContributionAnalysisDefault added in v1.28.0

type ContributionAnalysisDefault struct {

	// The dimensions columns that are used in the contribution analysis, usually a
	// list of ColumnIdentifiers .
	//
	// This member is required.
	ContributorDimensions []ColumnIdentifier

	// The measure field that is used in the contribution analysis.
	//
	// This member is required.
	MeasureFieldId *string
	// contains filtered or unexported fields
}

The contribution analysis visual display for a line, pie, or bar chart.

type CreateColumnsOperation

type CreateColumnsOperation struct {

	// Calculated columns to create.
	//
	// This member is required.
	Columns []CalculatedColumn
	// contains filtered or unexported fields
}

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 operation compares the DataSourceParameters structure that's in the request
	// with the structures in the AlternateDataSourceParameters allow list. If the
	// structures are an exact match, the request is allowed to use the 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
	// contains filtered or unexported fields
}

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

type CrossDatasetTypes added in v1.28.0

type CrossDatasetTypes string
const (
	CrossDatasetTypesAllDatasets   CrossDatasetTypes = "ALL_DATASETS"
	CrossDatasetTypesSingleDataset CrossDatasetTypes = "SINGLE_DATASET"
)

Enum values for CrossDatasetTypes

func (CrossDatasetTypes) Values added in v1.28.0

Values returns all known values for CrossDatasetTypes. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CurrencyDisplayFormatConfiguration added in v1.28.0

type CurrencyDisplayFormatConfiguration struct {

	// The option that determines the decimal places configuration.
	DecimalPlacesConfiguration *DecimalPlacesConfiguration

	// The options that determine the negative value configuration.
	NegativeValueConfiguration *NegativeValueConfiguration

	// The options that determine the null value format configuration.
	NullValueFormatConfiguration *NullValueFormatConfiguration

	// Determines the number scale value for the currency format.
	NumberScale NumberScale

	// Determines the prefix value of the currency format.
	Prefix *string

	// The options that determine the numeric separator configuration.
	SeparatorConfiguration *NumericSeparatorConfiguration

	// Determines the suffix value of the currency format.
	Suffix *string

	// Determines the symbol for the currency format.
	Symbol *string
	// contains filtered or unexported fields
}

The options that determine the currency display format configuration.

type CustomActionFilterOperation added in v1.28.0

type CustomActionFilterOperation struct {

	// The configuration that chooses the fields to be filtered.
	//
	// This member is required.
	SelectedFieldsConfiguration *FilterOperationSelectedFieldsConfiguration

	// The configuration that chooses the target visuals to be filtered.
	//
	// This member is required.
	TargetVisualsConfiguration *FilterOperationTargetVisualsConfiguration
	// contains filtered or unexported fields
}

The filter operation that filters data included in a visual or in an entire sheet.

type CustomActionNavigationOperation added in v1.28.0

type CustomActionNavigationOperation struct {

	// The configuration that chooses the navigation target.
	LocalNavigationConfiguration *LocalNavigationConfiguration
	// contains filtered or unexported fields
}

The navigation operation that navigates between different sheets in the same analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type CustomActionSetParametersOperation added in v1.28.0

type CustomActionSetParametersOperation struct {

	// The parameter that determines the value configuration.
	//
	// This member is required.
	ParameterValueConfigurations []SetParameterValueConfiguration
	// contains filtered or unexported fields
}

The set parameter operation that sets parameters in custom action.

type CustomActionURLOperation added in v1.28.0

type CustomActionURLOperation struct {

	// The target of the CustomActionURLOperation . Valid values are defined as
	// follows:
	//   - NEW_TAB : Opens the target URL in a new browser tab.
	//   - NEW_WINDOW : Opens the target URL in a new browser window.
	//   - SAME_TAB : Opens the target URL in the same browser tab.
	//
	// This member is required.
	URLTarget URLTargetConfiguration

	// THe URL link of the CustomActionURLOperation .
	//
	// This member is required.
	URLTemplate *string
	// contains filtered or unexported fields
}

The URL operation that opens a link to another webpage.

type CustomColor added in v1.38.0

type CustomColor struct {

	// The color that is applied to the data value.
	//
	// This member is required.
	Color *string

	// The data value that the color is applied to.
	FieldValue *string

	// The value of a special data value.
	SpecialValue SpecialValue
	// contains filtered or unexported fields
}

Determines the color that's applied to a particular data value in a column.

type CustomContentConfiguration added in v1.28.0

type CustomContentConfiguration struct {

	// The content type of the custom content visual. You can use this to have the
	// visual render as an image.
	ContentType CustomContentType

	// The input URL that links to the custom content that you want in the custom
	// visual.
	ContentUrl *string

	// The sizing options for the size of the custom content visual. This structure is
	// required when the ContentType of the visual is 'IMAGE' .
	ImageScaling CustomContentImageScalingConfiguration

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions
	// contains filtered or unexported fields
}

The configuration of a CustomContentVisual .

type CustomContentImageScalingConfiguration added in v1.28.0

type CustomContentImageScalingConfiguration string
const (
	CustomContentImageScalingConfigurationFitToHeight   CustomContentImageScalingConfiguration = "FIT_TO_HEIGHT"
	CustomContentImageScalingConfigurationFitToWidth    CustomContentImageScalingConfiguration = "FIT_TO_WIDTH"
	CustomContentImageScalingConfigurationDoNotScale    CustomContentImageScalingConfiguration = "DO_NOT_SCALE"
	CustomContentImageScalingConfigurationScaleToVisual CustomContentImageScalingConfiguration = "SCALE_TO_VISUAL"
)

Enum values for CustomContentImageScalingConfiguration

func (CustomContentImageScalingConfiguration) Values added in v1.28.0

Values returns all known values for CustomContentImageScalingConfiguration. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CustomContentType added in v1.28.0

type CustomContentType string
const (
	CustomContentTypeImage                CustomContentType = "IMAGE"
	CustomContentTypeOtherEmbeddedContent CustomContentType = "OTHER_EMBEDDED_CONTENT"
)

Enum values for CustomContentType

func (CustomContentType) Values added in v1.28.0

Values returns all known values for CustomContentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CustomContentVisual added in v1.28.0

type CustomContentVisual struct {

	// The dataset that is used to create the custom content visual. You can't create
	// a visual without a dataset.
	//
	// This member is required.
	DataSetIdentifier *string

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a CustomContentVisual .
	ChartConfiguration *CustomContentConfiguration

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A visual that contains custom content. For more information, see Using custom visual content (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the Amazon QuickSight User Guide.

type CustomFilterConfiguration added in v1.28.0

type CustomFilterConfiguration struct {

	// The match operator that is used to determine if a filter should be applied.
	//
	// This member is required.
	MatchOperator CategoryFilterMatchOperator

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	//
	// This member is required.
	NullOption FilterNullOption

	// The category value for the filter. This field is mutually exclusive to
	// ParameterName .
	CategoryValue *string

	// The parameter whose value should be used for the filter value. This field is
	// mutually exclusive to CategoryValue .
	ParameterName *string

	// Select all of the values. Null is not the assigned value of select all.
	//   - FILTER_ALL_VALUES
	SelectAllOptions CategoryFilterSelectAllOptions
	// contains filtered or unexported fields
}

A custom filter that filters based on a single value. This filter can be partially matched.

type CustomFilterListConfiguration added in v1.28.0

type CustomFilterListConfiguration struct {

	// The match operator that is used to determine if a filter should be applied.
	//
	// This member is required.
	MatchOperator CategoryFilterMatchOperator

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	//
	// This member is required.
	NullOption FilterNullOption

	// The list of category values for the filter.
	CategoryValues []string

	// Select all of the values. Null is not the assigned value of select all.
	//   - FILTER_ALL_VALUES
	SelectAllOptions CategoryFilterSelectAllOptions
	// contains filtered or unexported fields
}

A list of custom filter values.

type CustomNarrativeOptions added in v1.28.0

type CustomNarrativeOptions struct {

	// The string input of custom narrative.
	//
	// This member is required.
	Narrative *string
	// contains filtered or unexported fields
}

The custom narrative options.

type CustomParameterValues added in v1.28.0

type CustomParameterValues struct {

	// A list of datetime-type parameter values.
	DateTimeValues []time.Time

	// A list of decimal-type parameter values.
	DecimalValues []float64

	// A list of integer-type parameter values.
	IntegerValues []int64

	// A list of string-type parameter values.
	StringValues []string
	// contains filtered or unexported fields
}

The customized parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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
	// contains filtered or unexported fields
}

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

type CustomValuesConfiguration added in v1.28.0

type CustomValuesConfiguration struct {

	// The customized parameter values. This is a union type structure. For this
	// structure to be valid, only one of the attributes can be defined.
	//
	// This member is required.
	CustomValues *CustomParameterValues

	// Includes the null value in custom action parameter values.
	IncludeNullValue *bool
	// contains filtered or unexported fields
}

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration .

type Dashboard

type Dashboard 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 list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
	LinkEntities []string

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

	// Version.
	Version *DashboardVersion
	// contains filtered or unexported fields
}

Dashboard.

type DashboardBehavior

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

Enum values for DashboardBehavior

func (DashboardBehavior) Values added in v0.29.0

Values returns all known values for DashboardBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DashboardError

type DashboardError struct {

	// Message.
	Message *string

	// Type.
	Type DashboardErrorType

	// Lists the violated entities that caused the dashboard error.
	ViolatedEntities []Entity
	// contains filtered or unexported fields
}

Dashboard error.

type DashboardErrorType

type DashboardErrorType string
const (
	DashboardErrorTypeAccessDenied                 DashboardErrorType = "ACCESS_DENIED"
	DashboardErrorTypeSourceNotFound               DashboardErrorType = "SOURCE_NOT_FOUND"
	DashboardErrorTypeDataSetNotFound              DashboardErrorType = "DATA_SET_NOT_FOUND"
	DashboardErrorTypeInternalFailure              DashboardErrorType = "INTERNAL_FAILURE"
	DashboardErrorTypeParameterValueIncompatible   DashboardErrorType = "PARAMETER_VALUE_INCOMPATIBLE"
	DashboardErrorTypeParameterTypeInvalid         DashboardErrorType = "PARAMETER_TYPE_INVALID"
	DashboardErrorTypeParameterNotFound            DashboardErrorType = "PARAMETER_NOT_FOUND"
	DashboardErrorTypeColumnTypeMismatch           DashboardErrorType = "COLUMN_TYPE_MISMATCH"
	DashboardErrorTypeColumnGeographicRoleMismatch DashboardErrorType = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
	DashboardErrorTypeColumnReplacementMissing     DashboardErrorType = "COLUMN_REPLACEMENT_MISSING"
)

Enum values for DashboardErrorType

func (DashboardErrorType) Values added in v0.29.0

Values returns all known values for DashboardErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DashboardFilterAttribute

type DashboardFilterAttribute string
const (
	DashboardFilterAttributeQuicksightUser                DashboardFilterAttribute = "QUICKSIGHT_USER"
	DashboardFilterAttributeQuicksightViewerOrOwner       DashboardFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
	DashboardFilterAttributeDirectQuicksightViewerOrOwner DashboardFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
	DashboardFilterAttributeQuicksightOwner               DashboardFilterAttribute = "QUICKSIGHT_OWNER"
	DashboardFilterAttributeDirectQuicksightOwner         DashboardFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
	DashboardFilterAttributeDirectQuicksightSoleOwner     DashboardFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
	DashboardFilterAttributeDashboardName                 DashboardFilterAttribute = "DASHBOARD_NAME"
)

Enum values for DashboardFilterAttribute

func (DashboardFilterAttribute) Values added in v0.29.0

Values returns all known values for DashboardFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DashboardPublishOptions

type DashboardPublishOptions struct {

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

	// The drill-down options of data points in a dashboard.
	DataPointDrillUpDownOption *DataPointDrillUpDownOption

	// The data point menu label options of a dashboard.
	DataPointMenuLabelOption *DataPointMenuLabelOption

	// The data point tool tip options of a dashboard.
	DataPointTooltipOption *DataPointTooltipOption

	// Export to .csv option.
	ExportToCSVOption *ExportToCSVOption

	// Determines if hidden fields are exported with a dashboard.
	ExportWithHiddenFieldsOption *ExportWithHiddenFieldsOption

	// Sheet controls option.
	SheetControlsOption *SheetControlsOption

	// The sheet layout maximization options of a dashbaord.
	SheetLayoutElementMaximizationOption *SheetLayoutElementMaximizationOption

	// The axis sort options of a dashboard.
	VisualAxisSortOption *VisualAxisSortOption

	// The menu options of a visual in a dashboard.
	VisualMenuOption *VisualMenuOption

	// The visual publish options of a visual in a dashboard.
	//
	// Deprecated: VisualPublishOptions property will reach its end of standard
	// support in a future release. To perform this action, use ExportWithHiddenFields.
	VisualPublishOptions *DashboardVisualPublishOptions
	// contains filtered or unexported fields
}

Dashboard publish options.

type DashboardSearchFilter

type DashboardSearchFilter struct {

	// The comparison operator that you want to use as a filter, for example
	// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
	// If you set the operator value to "StringEquals" , you need to provide an
	// ownership related filter in the "NAME" field and the arn of the user or group
	// whose folders you want to search in the "Value" field. For example,
	// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
	// to "StringLike" , you need to provide the name of the folders you are searching
	// for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value":
	// "Test" . The "StringLike" operator only supports the NAME value DASHBOARD_NAME .
	//
	// This member is required.
	Operator FilterOperator

	// The name of the value that you want to use as a filter, for example, "Name":
	// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
	//   - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
	//   dashboards with that ARN listed as one of the dashboards's owners or viewers are
	//   returned. Implicit permissions from folders or groups are considered.
	//   - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any dashboards
	//   with that ARN listed as one of the owners of the dashboards are returned.
	//   Implicit permissions from folders or groups are considered.
	//   - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
	//   dashboards with that ARN listed as the only owner of the dashboard are returned.
	//   Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any
	//   dashboards with that ARN listed as one of the owners of the dashboards are
	//   returned. Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
	//   any dashboards with that ARN listed as one of the owners or viewers of the
	//   dashboards are returned. Implicit permissions from folders or groups are not
	//   considered.
	//   - DASHBOARD_NAME : Any dashboards whose names have a substring match to this
	//   value will be returned.
	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
	// contains filtered or unexported fields
}

A filter that you apply when searching for dashboards.

type DashboardSourceEntity

type DashboardSourceEntity struct {

	// Source template.
	SourceTemplate *DashboardSourceTemplate
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Dashboard summary.

type DashboardUIState

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

Enum values for DashboardUIState

func (DashboardUIState) Values added in v0.29.0

Values returns all known values for DashboardUIState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// this version of the dashboard.
	DataSetArns []string

	// Description.
	Description *string

	// Errors associated with this dashboard version.
	Errors []DashboardError

	// A list of the associated sheets with the unique identifier and name of each
	// sheet.
	Sheets []Sheet

	// Source entity ARN.
	SourceEntityArn *string

	// The HTTP status of the request.
	Status ResourceStatus

	// The ARN of the theme associated with a version of the dashboard.
	ThemeArn *string

	// Version number for this version of the dashboard.
	VersionNumber *int64
	// contains filtered or unexported fields
}

Dashboard version.

type DashboardVersionDefinition added in v1.28.0

type DashboardVersionDefinition struct {

	// An array of dataset identifier declarations. With this mapping,you can use
	// dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout
	// the dashboard's sub-structures.
	//
	// This member is required.
	DataSetIdentifierDeclarations []DataSetIdentifierDeclaration

	// The configuration for default analysis settings.
	AnalysisDefaults *AnalysisDefaults

	// An array of calculated field definitions for the dashboard.
	CalculatedFields []CalculatedField

	// An array of dashboard-level column configurations. Column configurations are
	// used to set the default formatting for a column that is used throughout a
	// dashboard.
	ColumnConfigurations []ColumnConfiguration

	// The filter definitions for a dashboard. For more information, see Filtering
	// Data in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html)
	// in the Amazon QuickSight User Guide.
	FilterGroups []FilterGroup

	// An array of option definitions for a dashboard.
	Options *AssetOptions

	// The parameter declarations for a dashboard. Parameters are named variables that
	// can transfer a value for use by an action or an object. For more information,
	// see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
	// in the Amazon QuickSight User Guide.
	ParameterDeclarations []ParameterDeclaration

	// An array of sheet definitions for a dashboard.
	Sheets []SheetDefinition
	// contains filtered or unexported fields
}

The contents of a dashboard.

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
	// contains filtered or unexported fields
}

Dashboard version summary.

type DashboardVisualId added in v1.24.0

type DashboardVisualId struct {

	// The ID of the dashboard that has the visual that you want to embed. The
	// DashboardId can be found in the IDs for developers section of the Embed visual
	// pane of the visual's on-visual menu of the Amazon QuickSight console. You can
	// also get the DashboardId with a ListDashboards API operation.
	//
	// This member is required.
	DashboardId *string

	// The ID of the sheet that the has visual that you want to embed. The SheetId can
	// be found in the IDs for developers section of the Embed visual pane of the
	// visual's on-visual menu of the Amazon QuickSight console.
	//
	// This member is required.
	SheetId *string

	// The ID of the visual that you want to embed. The VisualID can be found in the
	// IDs for developers section of the Embed visual pane of the visual's on-visual
	// menu of the Amazon QuickSight console.
	//
	// This member is required.
	VisualId *string
	// contains filtered or unexported fields
}

A structure that contains the following elements:

  • The DashboardId of the dashboard that has the visual that you want to embed.
  • The SheetId of the sheet that has the visual that you want to embed.
  • The VisualId of the visual that you want to embed.

The DashboardId , SheetId , and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

type DashboardVisualPublishOptions added in v1.28.0

type DashboardVisualPublishOptions struct {

	// Determines if hidden fields are included in an exported dashboard.
	ExportHiddenFieldsOption *ExportHiddenFieldsOption
	// contains filtered or unexported fields
}

The visual publish options of a visual in a dashboard

type DataAggregation added in v1.35.0

type DataAggregation struct {

	// The level of time precision that is used to aggregate DateTime values.
	DatasetRowDateGranularity TopicTimeGranularity

	// The column name for the default date.
	DefaultDateColumnName *string
	// contains filtered or unexported fields
}

A structure that represents a data aggregation.

type DataBarsOptions added in v1.30.0

type DataBarsOptions struct {

	// The field ID for the data bars options.
	//
	// This member is required.
	FieldId *string

	// The color of the negative data bar.
	NegativeColor *string

	// The color of the positive data bar.
	PositiveColor *string
	// contains filtered or unexported fields
}

The options for data bars.

type DataColor added in v1.28.0

type DataColor struct {

	// The color that is applied to the data value.
	Color *string

	// The data value that the color is applied to.
	DataValue *float64
	// contains filtered or unexported fields
}

Determines the color that is applied to a particular data value.

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
	// contains filtered or unexported fields
}

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.

type DataFieldSeriesItem added in v1.28.0

type DataFieldSeriesItem struct {

	// The axis that you are binding the field to.
	//
	// This member is required.
	AxisBinding AxisBinding

	// The field ID of the field that you are setting the axis binding to.
	//
	// This member is required.
	FieldId *string

	// The field value of the field that you are setting the axis binding to.
	FieldValue *string

	// The options that determine the presentation of line series associated to the
	// field.
	Settings *LineChartSeriesSettings
	// contains filtered or unexported fields
}

The data field series item configuration of a line chart.

type DataLabelContent added in v1.28.0

type DataLabelContent string
const (
	DataLabelContentValue           DataLabelContent = "VALUE"
	DataLabelContentPercent         DataLabelContent = "PERCENT"
	DataLabelContentValueAndPercent DataLabelContent = "VALUE_AND_PERCENT"
)

Enum values for DataLabelContent

func (DataLabelContent) Values added in v1.28.0

Values returns all known values for DataLabelContent. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataLabelOptions added in v1.28.0

type DataLabelOptions struct {

	// Determines the visibility of the category field labels.
	CategoryLabelVisibility Visibility

	// The option that determines the data label type.
	DataLabelTypes []DataLabelType

	// Determines the color of the data labels.
	LabelColor *string

	// Determines the content of the data labels.
	LabelContent DataLabelContent

	// Determines the font configuration of the data labels.
	LabelFontConfiguration *FontConfiguration

	// Determines the visibility of the measure field labels.
	MeasureLabelVisibility Visibility

	// Determines whether overlap is enabled or disabled for the data labels.
	Overlap DataLabelOverlap

	// Determines the position of the data labels.
	Position DataLabelPosition

	// Determines the visibility of the total.
	TotalsVisibility Visibility

	// Determines the visibility of the data labels.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the presentation of the data labels.

type DataLabelOverlap added in v1.28.0

type DataLabelOverlap string
const (
	DataLabelOverlapDisableOverlap DataLabelOverlap = "DISABLE_OVERLAP"
	DataLabelOverlapEnableOverlap  DataLabelOverlap = "ENABLE_OVERLAP"
)

Enum values for DataLabelOverlap

func (DataLabelOverlap) Values added in v1.28.0

Values returns all known values for DataLabelOverlap. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataLabelPosition added in v1.28.0

type DataLabelPosition string
const (
	DataLabelPositionInside  DataLabelPosition = "INSIDE"
	DataLabelPositionOutside DataLabelPosition = "OUTSIDE"
	DataLabelPositionLeft    DataLabelPosition = "LEFT"
	DataLabelPositionTop     DataLabelPosition = "TOP"
	DataLabelPositionBottom  DataLabelPosition = "BOTTOM"
	DataLabelPositionRight   DataLabelPosition = "RIGHT"
)

Enum values for DataLabelPosition

func (DataLabelPosition) Values added in v1.28.0

Values returns all known values for DataLabelPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataLabelType added in v1.28.0

type DataLabelType struct {

	// The option that specifies individual data values for labels.
	DataPathLabelType *DataPathLabelType

	// Determines the label configuration for the entire field.
	FieldLabelType *FieldLabelType

	// Determines the label configuration for the maximum value in a visual.
	MaximumLabelType *MaximumLabelType

	// Determines the label configuration for the minimum value in a visual.
	MinimumLabelType *MinimumLabelType

	// Determines the label configuration for range end value in a visual.
	RangeEndsLabelType *RangeEndsLabelType
	// contains filtered or unexported fields
}

The option that determines the data label type. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type DataPathColor added in v1.28.0

type DataPathColor struct {

	// The color that needs to be applied to the element.
	//
	// This member is required.
	Color *string

	// The element that the color needs to be applied to.
	//
	// This member is required.
	Element *DataPathValue

	// The time granularity of the field that the color needs to be applied to.
	TimeGranularity TimeGranularity
	// contains filtered or unexported fields
}

The color map that determines the color options for a particular element.

type DataPathLabelType added in v1.28.0

type DataPathLabelType struct {

	// The field ID of the field that the data label needs to be applied to.
	FieldId *string

	// The actual value of the field that is labeled.
	FieldValue *string

	// The visibility of the data label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The option that specifies individual data values for labels.

type DataPathSort added in v1.28.0

type DataPathSort struct {

	// Determines the sort direction.
	//
	// This member is required.
	Direction SortDirection

	// The list of data paths that need to be sorted.
	//
	// This member is required.
	SortPaths []DataPathValue
	// contains filtered or unexported fields
}

Allows data paths to be sorted by a specific data value.

type DataPathType added in v1.46.0

type DataPathType struct {

	// The type of data path value utilized in a pivot table. Choose one of the
	// following options:
	//   - HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout
	//   column, when RowsLayout is set to HIERARCHY .
	//   - MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column
	//   when the row is set to Metric Placement.
	//   - EMPTY_COLUMN_HEADER - The type of data path for the column with empty column
	//   header, when there is no field in ColumnsFieldWell and the row is set to
	//   Metric Placement.
	//   - COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the
	//   metric, when there is no field in the ValuesFieldWell .
	PivotTableDataPathType PivotTableDataPathType
	// contains filtered or unexported fields
}

The type of the data path value.

type DataPathValue added in v1.28.0

type DataPathValue struct {

	// The type configuration of the field.
	DataPathType *DataPathType

	// The field ID of the field that needs to be sorted.
	FieldId *string

	// The actual value of the field that needs to be sorted.
	FieldValue *string
	// contains filtered or unexported fields
}

The data path that needs to be sorted.

type DataPointDrillUpDownOption added in v1.31.0

type DataPointDrillUpDownOption struct {

	// The status of the drill down options of data points.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The drill down options for data points in a dashbaord.

type DataPointMenuLabelOption added in v1.31.0

type DataPointMenuLabelOption struct {

	// The status of the data point menu options.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The data point menu options of a dashboard.

type DataPointTooltipOption added in v1.31.0

type DataPointTooltipOption struct {

	// The status of the data point tool tip options.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The data point tooltip options.

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

	// A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html)
	// .
	ColumnLevelPermissionRules []ColumnLevelPermissionRule

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

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

	// The parameters that are declared in a dataset.
	DatasetParameters []DatasetParameter

	// The folder that contains fields and nested subfolders for your dataset.
	FieldFolders map[string]FieldFolder

	// A value that 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

	// The element you can use to define tags for row-level security.
	RowLevelPermissionTagConfiguration *RowLevelPermissionTagConfiguration
	// contains filtered or unexported fields
}

Dataset.

type DataSetConfiguration

type DataSetConfiguration struct {

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

	// Dataset schema.
	DataSetSchema *DataSetSchema

	// Placeholder.
	Placeholder *string
	// contains filtered or unexported fields
}

Dataset configuration.

type DataSetFilterAttribute added in v1.27.0

type DataSetFilterAttribute string
const (
	DataSetFilterAttributeQuicksightViewerOrOwner       DataSetFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
	DataSetFilterAttributeQuicksightOwner               DataSetFilterAttribute = "QUICKSIGHT_OWNER"
	DataSetFilterAttributeDirectQuicksightViewerOrOwner DataSetFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
	DataSetFilterAttributeDirectQuicksightOwner         DataSetFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
	DataSetFilterAttributeDirectQuicksightSoleOwner     DataSetFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
	DataSetFilterAttributeDatasetName                   DataSetFilterAttribute = "DATASET_NAME"
)

Enum values for DataSetFilterAttribute

func (DataSetFilterAttribute) Values added in v1.27.0

Values returns all known values for DataSetFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataSetIdentifierDeclaration added in v1.28.0

type DataSetIdentifierDeclaration struct {

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

	// The identifier of the data set, typically the data set's name.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

A data set.

type DataSetImportMode

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

Enum values for DataSetImportMode

func (DataSetImportMode) Values added in v0.29.0

Values returns all known values for DataSetImportMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataSetReference

type DataSetReference struct {

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

	// Dataset placeholder.
	//
	// This member is required.
	DataSetPlaceholder *string
	// contains filtered or unexported fields
}

Dataset reference.

type DataSetRefreshProperties added in v1.34.0

type DataSetRefreshProperties struct {

	// The refresh configuration for a dataset.
	//
	// This member is required.
	RefreshConfiguration *RefreshConfiguration
	// contains filtered or unexported fields
}

The refresh properties of a dataset.

type DataSetSchema

type DataSetSchema struct {

	// A structure containing the list of column schemas.
	ColumnSchemaList []ColumnSchema
	// contains filtered or unexported fields
}

Dataset schema.

type DataSetSearchFilter added in v1.27.0

type DataSetSearchFilter struct {

	// The name of the value that you want to use as a filter, for example, "Name":
	// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
	//   - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
	//   datasets with that ARN listed as one of the dataset owners or viewers are
	//   returned. Implicit permissions from folders or groups are considered.
	//   - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with
	//   that ARN listed as one of the owners of the dataset are returned. Implicit
	//   permissions from folders or groups are considered.
	//   - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
	//   datasets with that ARN listed as the only owner of the dataset are returned.
	//   Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any
	//   datasets with that ARN listed as one of the owners if the dataset are returned.
	//   Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
	//   any datasets with that ARN listed as one of the owners or viewers of the dataset
	//   are returned. Implicit permissions from folders or groups are not considered.
	//   - DATASET_NAME : Any datasets whose names have a substring match to this value
	//   will be returned.
	//
	// This member is required.
	Name DataSetFilterAttribute

	// The comparison operator that you want to use as a filter, for example
	// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
	// If you set the operator value to "StringEquals" , you need to provide an
	// ownership related filter in the "NAME" field and the arn of the user or group
	// whose datasets you want to search in the "Value" field. For example,
	// "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
	// "arn:aws:quicksight:us-east- 1:1:user/default/UserName1" . If you set the value
	// to "StringLike" , you need to provide the name of the datasets you are searching
	// for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value":
	// "Test" . The "StringLike" operator only supports the NAME value DATASET_NAME .
	//
	// This member is required.
	Operator FilterOperator

	// The value of the named item, in this case QUICKSIGHT_OWNER , that you want to
	// use as a filter, for example, "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A filter that you apply when searching for datasets.

type DataSetSummary

type DataSetSummary struct {

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

	// A value that indicates if the dataset has column level permission configured.
	ColumnLevelPermissionRulesApplied bool

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

	// The ID of the dataset.
	DataSetId *string

	// A value that 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

	// Whether or not the row level permission tags are applied.
	RowLevelPermissionTagConfigurationApplied bool
	// contains filtered or unexported fields
}

Dataset summary.

type DataSetUsageConfiguration added in v1.10.0

type DataSetUsageConfiguration struct {

	// An option that controls whether a child dataset of a direct query can use this
	// dataset as a source.
	DisableUseAsDirectQuerySource bool

	// An option that controls whether a child dataset that's stored in QuickSight can
	// use this dataset as a source.
	DisableUseAsImportedSource bool
	// contains filtered or unexported fields
}

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

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 operation compares the DataSourceParameters structure
	// that's in the request with the structures in the AlternateDataSourceParameters
	// allow list. If the structures are an exact match, the request is allowed to use
	// the credentials from this existing data source. If the
	// AlternateDataSourceParameters list is null, the Credentials originally used
	// with this DataSourceParameters are automatically allowed.
	AlternateDataSourceParameters []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 Amazon Web Services Region for
	// each Amazon Web Services 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

	// The Amazon Resource Name (ARN) of the secret associated with the data source in
	// Amazon Secrets Manager.
	SecretArn *string

	// Secure Socket Layer (SSL) properties that apply when Amazon 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 Amazon QuickSight to use a VPC connection when connecting to your
	// underlying source.
	VpcConnectionProperties *VpcConnectionProperties
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html)
	// .
	CredentialPair *CredentialPair

	// The Amazon Resource Name (ARN) of the secret associated with the data source in
	// Amazon Secrets Manager.
	SecretArn *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Error information for the data source creation or update.

type DataSourceErrorInfoType

type DataSourceErrorInfoType string
const (
	DataSourceErrorInfoTypeAccessDenied              DataSourceErrorInfoType = "ACCESS_DENIED"
	DataSourceErrorInfoTypeCopySourceNotFound        DataSourceErrorInfoType = "COPY_SOURCE_NOT_FOUND"
	DataSourceErrorInfoTypeTimeout                   DataSourceErrorInfoType = "TIMEOUT"
	DataSourceErrorInfoTypeEngineVersionNotSupported DataSourceErrorInfoType = "ENGINE_VERSION_NOT_SUPPORTED"
	DataSourceErrorInfoTypeUnknownHost               DataSourceErrorInfoType = "UNKNOWN_HOST"
	DataSourceErrorInfoTypeGenericSqlFailure         DataSourceErrorInfoType = "GENERIC_SQL_FAILURE"
	DataSourceErrorInfoTypeConflict                  DataSourceErrorInfoType = "CONFLICT"
	DataSourceErrorInfoTypeUnknown                   DataSourceErrorInfoType = "UNKNOWN"
)

Enum values for DataSourceErrorInfoType

func (DataSourceErrorInfoType) Values added in v0.29.0

Values returns all known values for DataSourceErrorInfoType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataSourceFilterAttribute added in v1.27.0

type DataSourceFilterAttribute string
const (
	DataSourceFilterAttributeDirectQuicksightViewerOrOwner DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
	DataSourceFilterAttributeDirectQuicksightOwner         DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
	DataSourceFilterAttributeDirectQuicksightSoleOwner     DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
	DataSourceFilterAttributeDatasourceName                DataSourceFilterAttribute = "DATASOURCE_NAME"
)

Enum values for DataSourceFilterAttribute

func (DataSourceFilterAttribute) Values added in v1.27.0

Values returns all known values for DataSourceFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataSourceParameters

type DataSourceParameters interface {
	// contains filtered or unexported methods
}

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.

The following types satisfy this interface:

DataSourceParametersMemberAmazonElasticsearchParameters
DataSourceParametersMemberAmazonOpenSearchParameters
DataSourceParametersMemberAthenaParameters
DataSourceParametersMemberAuroraParameters
DataSourceParametersMemberAuroraPostgreSqlParameters
DataSourceParametersMemberAwsIotAnalyticsParameters
DataSourceParametersMemberBigQueryParameters
DataSourceParametersMemberDatabricksParameters
DataSourceParametersMemberExasolParameters
DataSourceParametersMemberJiraParameters
DataSourceParametersMemberMariaDbParameters
DataSourceParametersMemberMySqlParameters
DataSourceParametersMemberOracleParameters
DataSourceParametersMemberPostgreSqlParameters
DataSourceParametersMemberPrestoParameters
DataSourceParametersMemberRdsParameters
DataSourceParametersMemberRedshiftParameters
DataSourceParametersMemberS3Parameters
DataSourceParametersMemberServiceNowParameters
DataSourceParametersMemberSnowflakeParameters
DataSourceParametersMemberSparkParameters
DataSourceParametersMemberSqlServerParameters
DataSourceParametersMemberStarburstParameters
DataSourceParametersMemberTeradataParameters
DataSourceParametersMemberTrinoParameters
DataSourceParametersMemberTwitterParameters
Example (OutputUsage)
package main

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

func main() {
	var union types.DataSourceParameters
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DataSourceParametersMemberAmazonElasticsearchParameters:
		_ = v.Value // Value is types.AmazonElasticsearchParameters

	case *types.DataSourceParametersMemberAmazonOpenSearchParameters:
		_ = v.Value // Value is types.AmazonOpenSearchParameters

	case *types.DataSourceParametersMemberAthenaParameters:
		_ = v.Value // Value is types.AthenaParameters

	case *types.DataSourceParametersMemberAuroraParameters:
		_ = v.Value // Value is types.AuroraParameters

	case *types.DataSourceParametersMemberAuroraPostgreSqlParameters:
		_ = v.Value // Value is types.AuroraPostgreSqlParameters

	case *types.DataSourceParametersMemberAwsIotAnalyticsParameters:
		_ = v.Value // Value is types.AwsIotAnalyticsParameters

	case *types.DataSourceParametersMemberBigQueryParameters:
		_ = v.Value // Value is types.BigQueryParameters

	case *types.DataSourceParametersMemberDatabricksParameters:
		_ = v.Value // Value is types.DatabricksParameters

	case *types.DataSourceParametersMemberExasolParameters:
		_ = v.Value // Value is types.ExasolParameters

	case *types.DataSourceParametersMemberJiraParameters:
		_ = v.Value // Value is types.JiraParameters

	case *types.DataSourceParametersMemberMariaDbParameters:
		_ = v.Value // Value is types.MariaDbParameters

	case *types.DataSourceParametersMemberMySqlParameters:
		_ = v.Value // Value is types.MySqlParameters

	case *types.DataSourceParametersMemberOracleParameters:
		_ = v.Value // Value is types.OracleParameters

	case *types.DataSourceParametersMemberPostgreSqlParameters:
		_ = v.Value // Value is types.PostgreSqlParameters

	case *types.DataSourceParametersMemberPrestoParameters:
		_ = v.Value // Value is types.PrestoParameters

	case *types.DataSourceParametersMemberRdsParameters:
		_ = v.Value // Value is types.RdsParameters

	case *types.DataSourceParametersMemberRedshiftParameters:
		_ = v.Value // Value is types.RedshiftParameters

	case *types.DataSourceParametersMemberS3Parameters:
		_ = v.Value // Value is types.S3Parameters

	case *types.DataSourceParametersMemberServiceNowParameters:
		_ = v.Value // Value is types.ServiceNowParameters

	case *types.DataSourceParametersMemberSnowflakeParameters:
		_ = v.Value // Value is types.SnowflakeParameters

	case *types.DataSourceParametersMemberSparkParameters:
		_ = v.Value // Value is types.SparkParameters

	case *types.DataSourceParametersMemberSqlServerParameters:
		_ = v.Value // Value is types.SqlServerParameters

	case *types.DataSourceParametersMemberStarburstParameters:
		_ = v.Value // Value is types.StarburstParameters

	case *types.DataSourceParametersMemberTeradataParameters:
		_ = v.Value // Value is types.TeradataParameters

	case *types.DataSourceParametersMemberTrinoParameters:
		_ = v.Value // Value is types.TrinoParameters

	case *types.DataSourceParametersMemberTwitterParameters:
		_ = v.Value // Value is types.TwitterParameters

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type DataSourceParametersMemberAmazonElasticsearchParameters added in v0.31.0

type DataSourceParametersMemberAmazonElasticsearchParameters struct {
	Value AmazonElasticsearchParameters
	// contains filtered or unexported fields
}

The parameters for OpenSearch.

type DataSourceParametersMemberAmazonOpenSearchParameters added in v1.11.0

type DataSourceParametersMemberAmazonOpenSearchParameters struct {
	Value AmazonOpenSearchParameters
	// contains filtered or unexported fields
}

The parameters for OpenSearch.

type DataSourceParametersMemberAthenaParameters added in v0.31.0

type DataSourceParametersMemberAthenaParameters struct {
	Value AthenaParameters
	// contains filtered or unexported fields
}

The parameters for Amazon Athena.

type DataSourceParametersMemberAuroraParameters added in v0.31.0

type DataSourceParametersMemberAuroraParameters struct {
	Value AuroraParameters
	// contains filtered or unexported fields
}

The parameters for Amazon Aurora MySQL.

type DataSourceParametersMemberAuroraPostgreSqlParameters added in v0.31.0

type DataSourceParametersMemberAuroraPostgreSqlParameters struct {
	Value AuroraPostgreSqlParameters
	// contains filtered or unexported fields
}

The parameters for Amazon Aurora.

type DataSourceParametersMemberAwsIotAnalyticsParameters added in v0.31.0

type DataSourceParametersMemberAwsIotAnalyticsParameters struct {
	Value AwsIotAnalyticsParameters
	// contains filtered or unexported fields
}

The parameters for IoT Analytics.

type DataSourceParametersMemberBigQueryParameters added in v1.51.0

type DataSourceParametersMemberBigQueryParameters struct {
	Value BigQueryParameters
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Google BigQuery data source.

type DataSourceParametersMemberDatabricksParameters added in v1.27.0

type DataSourceParametersMemberDatabricksParameters struct {
	Value DatabricksParameters
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Databricks data source.

type DataSourceParametersMemberExasolParameters added in v1.15.0

type DataSourceParametersMemberExasolParameters struct {
	Value ExasolParameters
	// contains filtered or unexported fields
}

The parameters for Exasol.

type DataSourceParametersMemberJiraParameters added in v0.31.0

type DataSourceParametersMemberJiraParameters struct {
	Value JiraParameters
	// contains filtered or unexported fields
}

The parameters for Jira.

type DataSourceParametersMemberMariaDbParameters added in v0.31.0

type DataSourceParametersMemberMariaDbParameters struct {
	Value MariaDbParameters
	// contains filtered or unexported fields
}

The parameters for MariaDB.

type DataSourceParametersMemberMySqlParameters added in v0.31.0

type DataSourceParametersMemberMySqlParameters struct {
	Value MySqlParameters
	// contains filtered or unexported fields
}

The parameters for MySQL.

type DataSourceParametersMemberOracleParameters added in v0.31.0

type DataSourceParametersMemberOracleParameters struct {
	Value OracleParameters
	// contains filtered or unexported fields
}

The parameters for Oracle.

type DataSourceParametersMemberPostgreSqlParameters added in v0.31.0

type DataSourceParametersMemberPostgreSqlParameters struct {
	Value PostgreSqlParameters
	// contains filtered or unexported fields
}

The parameters for PostgreSQL.

type DataSourceParametersMemberPrestoParameters added in v0.31.0

type DataSourceParametersMemberPrestoParameters struct {
	Value PrestoParameters
	// contains filtered or unexported fields
}

The parameters for Presto.

type DataSourceParametersMemberRdsParameters added in v0.31.0

type DataSourceParametersMemberRdsParameters struct {
	Value RdsParameters
	// contains filtered or unexported fields
}

The parameters for Amazon RDS.

type DataSourceParametersMemberRedshiftParameters added in v0.31.0

type DataSourceParametersMemberRedshiftParameters struct {
	Value RedshiftParameters
	// contains filtered or unexported fields
}

The parameters for Amazon Redshift.

type DataSourceParametersMemberS3Parameters added in v0.31.0

type DataSourceParametersMemberS3Parameters struct {
	Value S3Parameters
	// contains filtered or unexported fields
}

The parameters for S3.

type DataSourceParametersMemberServiceNowParameters added in v0.31.0

type DataSourceParametersMemberServiceNowParameters struct {
	Value ServiceNowParameters
	// contains filtered or unexported fields
}

The parameters for ServiceNow.

type DataSourceParametersMemberSnowflakeParameters added in v0.31.0

type DataSourceParametersMemberSnowflakeParameters struct {
	Value SnowflakeParameters
	// contains filtered or unexported fields
}

The parameters for Snowflake.

type DataSourceParametersMemberSparkParameters added in v0.31.0

type DataSourceParametersMemberSparkParameters struct {
	Value SparkParameters
	// contains filtered or unexported fields
}

The parameters for Spark.

type DataSourceParametersMemberSqlServerParameters added in v0.31.0

type DataSourceParametersMemberSqlServerParameters struct {
	Value SqlServerParameters
	// contains filtered or unexported fields
}

The parameters for SQL Server.

type DataSourceParametersMemberStarburstParameters added in v1.46.0

type DataSourceParametersMemberStarburstParameters struct {
	Value StarburstParameters
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Starburst data source.

type DataSourceParametersMemberTeradataParameters added in v0.31.0

type DataSourceParametersMemberTeradataParameters struct {
	Value TeradataParameters
	// contains filtered or unexported fields
}

The parameters for Teradata.

type DataSourceParametersMemberTrinoParameters added in v1.46.0

type DataSourceParametersMemberTrinoParameters struct {
	Value TrinoParameters
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Trino data source.

type DataSourceParametersMemberTwitterParameters added in v0.31.0

type DataSourceParametersMemberTwitterParameters struct {
	Value TwitterParameters
	// contains filtered or unexported fields
}

The parameters for Twitter.

type DataSourceSearchFilter added in v1.27.0

type DataSourceSearchFilter struct {

	// The name of the value that you want to use as a filter, for example, "Name":
	// "DIRECT_QUICKSIGHT_OWNER" . Valid values are defined as follows:
	//   - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
	//   any data sources with that ARN listed as one of the owners or viewers of the
	//   data sources are returned. Implicit permissions from folders or groups are not
	//   considered.
	//   - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any data
	//   sources with that ARN listed as one of the owners if the data source are
	//   returned. Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
	//   data sources with that ARN listed as the only owner of the data source are
	//   returned. Implicit permissions from folders or groups are not considered.
	//   - DATASOURCE_NAME : Any data sources whose names have a substring match to the
	//   provided value are returned.
	//
	// This member is required.
	Name DataSourceFilterAttribute

	// The comparison operator that you want to use as a filter, for example
	// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
	// If you set the operator value to "StringEquals" , you need to provide an
	// ownership related filter in the "NAME" field and the arn of the user or group
	// whose data sources you want to search in the "Value" field. For example,
	// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
	// to "StringLike" , you need to provide the name of the data sources you are
	// searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike",
	// "Value": "Test" . The "StringLike" operator only supports the NAME value
	// DATASOURCE_NAME .
	//
	// This member is required.
	Operator FilterOperator

	// The value of the named item, for example DIRECT_QUICKSIGHT_OWNER , that you want
	// to use as a filter, for example, "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A filter that you apply when searching for data sources.

type DataSourceSummary added in v1.27.0

type DataSourceSummary struct {

	// The arn of the datasource.
	Arn *string

	// The date and time that the data source was created. This value is expressed in
	// MM-DD-YYYY HH:MM:SS format.
	CreatedTime *time.Time

	// The unique ID of the data source.
	DataSourceId *string

	// The date and time the data source was last updated. This value is expressed in
	// MM-DD-YYYY HH:MM:SS format.
	LastUpdatedTime *time.Time

	// The name of the data source.
	Name *string

	// The type of the data source.
	Type DataSourceType
	// contains filtered or unexported fields
}

A DataSourceSummary object that returns a summary of a data source.

type DataSourceType

type DataSourceType string
const (
	DataSourceTypeAdobeAnalytics      DataSourceType = "ADOBE_ANALYTICS"
	DataSourceTypeAmazonElasticsearch DataSourceType = "AMAZON_ELASTICSEARCH"
	DataSourceTypeAthena              DataSourceType = "ATHENA"
	DataSourceTypeAurora              DataSourceType = "AURORA"
	DataSourceTypeAuroraPostgresql    DataSourceType = "AURORA_POSTGRESQL"
	DataSourceTypeAwsIotAnalytics     DataSourceType = "AWS_IOT_ANALYTICS"
	DataSourceTypeGithub              DataSourceType = "GITHUB"
	DataSourceTypeJira                DataSourceType = "JIRA"
	DataSourceTypeMariadb             DataSourceType = "MARIADB"
	DataSourceTypeMysql               DataSourceType = "MYSQL"
	DataSourceTypeOracle              DataSourceType = "ORACLE"
	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"
	DataSourceTypeTimestream          DataSourceType = "TIMESTREAM"
	DataSourceTypeAmazonOpensearch    DataSourceType = "AMAZON_OPENSEARCH"
	DataSourceTypeExasol              DataSourceType = "EXASOL"
	DataSourceTypeDatabricks          DataSourceType = "DATABRICKS"
	DataSourceTypeStarburst           DataSourceType = "STARBURST"
	DataSourceTypeTrino               DataSourceType = "TRINO"
	DataSourceTypeBigquery            DataSourceType = "BIGQUERY"
)

Enum values for DataSourceType

func (DataSourceType) Values added in v0.29.0

func (DataSourceType) Values() []DataSourceType

Values returns all known values for DataSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DatabricksParameters added in v1.27.0

type DatabricksParameters struct {

	// The host name of the Databricks data source.
	//
	// This member is required.
	Host *string

	// The port for the Databricks data source.
	//
	// This member is required.
	Port *int32

	// The HTTP path of the Databricks data source.
	//
	// This member is required.
	SqlEndpointPath *string
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Databricks data source.

type DatasetMetadata added in v1.35.0

type DatasetMetadata struct {

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

	// The list of calculated field definitions.
	CalculatedFields []TopicCalculatedField

	// The list of column definitions.
	Columns []TopicColumn

	// The definition of a data aggregation.
	DataAggregation *DataAggregation

	// The description of the dataset.
	DatasetDescription *string

	// The name of the dataset.
	DatasetName *string

	// The list of filter definitions.
	Filters []TopicFilter

	// The list of named entities definitions.
	NamedEntities []TopicNamedEntity
	// contains filtered or unexported fields
}

A structure that represents a dataset.

type DatasetParameter added in v1.35.0

type DatasetParameter struct {

	// A date time parameter that is created in the dataset.
	DateTimeDatasetParameter *DateTimeDatasetParameter

	// A decimal parameter that is created in the dataset.
	DecimalDatasetParameter *DecimalDatasetParameter

	// An integer parameter that is created in the dataset.
	IntegerDatasetParameter *IntegerDatasetParameter

	// A string parameter that is created in the dataset.
	StringDatasetParameter *StringDatasetParameter
	// contains filtered or unexported fields
}

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

type DatasetParameterValueType added in v1.35.0

type DatasetParameterValueType string
const (
	DatasetParameterValueTypeMultiValued  DatasetParameterValueType = "MULTI_VALUED"
	DatasetParameterValueTypeSingleValued DatasetParameterValueType = "SINGLE_VALUED"
)

Enum values for DatasetParameterValueType

func (DatasetParameterValueType) Values added in v1.35.0

Values returns all known values for DatasetParameterValueType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DateAggregationFunction added in v1.28.0

type DateAggregationFunction string
const (
	DateAggregationFunctionCount         DateAggregationFunction = "COUNT"
	DateAggregationFunctionDistinctCount DateAggregationFunction = "DISTINCT_COUNT"
	DateAggregationFunctionMin           DateAggregationFunction = "MIN"
	DateAggregationFunctionMax           DateAggregationFunction = "MAX"
)

Enum values for DateAggregationFunction

func (DateAggregationFunction) Values added in v1.28.0

Values returns all known values for DateAggregationFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DateAxisOptions added in v1.28.0

type DateAxisOptions struct {

	// Determines whether or not missing dates are displayed.
	MissingDateVisibility Visibility
	// contains filtered or unexported fields
}

The options that determine how a date axis is displayed.

type DateDimensionField added in v1.28.0

type DateDimensionField struct {

	// The column that is used in the DateDimensionField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The date granularity of the DateDimensionField . Choose one of the following
	// options:
	//   - YEAR
	//   - QUARTER
	//   - MONTH
	//   - WEEK
	//   - DAY
	//   - HOUR
	//   - MINUTE
	//   - SECOND
	//   - MILLISECOND
	DateGranularity TimeGranularity

	// The format configuration of the field.
	FormatConfiguration *DateTimeFormatConfiguration

	// The custom hierarchy ID.
	HierarchyId *string
	// contains filtered or unexported fields
}

The dimension type field with date type columns.

type DateMeasureField added in v1.28.0

type DateMeasureField struct {

	// The column that is used in the DateMeasureField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The aggregation function of the measure field.
	AggregationFunction DateAggregationFunction

	// The format configuration of the field.
	FormatConfiguration *DateTimeFormatConfiguration
	// contains filtered or unexported fields
}

The measure type field with date type columns.

type DateTimeDatasetParameter added in v1.35.0

type DateTimeDatasetParameter struct {

	// An identifier for the parameter that is created in the dataset.
	//
	// This member is required.
	Id *string

	// The name of the date time parameter that is created in the dataset.
	//
	// This member is required.
	Name *string

	// The value type of the dataset parameter. Valid values are single value or multi
	// value .
	//
	// This member is required.
	ValueType DatasetParameterValueType

	// A list of default values for a given date time parameter. This structure only
	// accepts static values.
	DefaultValues *DateTimeDatasetParameterDefaultValues

	// The time granularity of the date time parameter.
	TimeGranularity TimeGranularity
	// contains filtered or unexported fields
}

A date time parameter for a dataset.

type DateTimeDatasetParameterDefaultValues added in v1.35.0

type DateTimeDatasetParameterDefaultValues struct {

	// A list of static default values for a given date time parameter.
	StaticValues []time.Time
	// contains filtered or unexported fields
}

The default values of a date time parameter.

type DateTimeDefaultValues added in v1.28.0

type DateTimeDefaultValues struct {

	// The dynamic value of the DataTimeDefaultValues . Different defaults are
	// displayed according to users, groups, and values mapping.
	DynamicValue *DynamicDefaultValue

	// The rolling date of the DataTimeDefaultValues . The date is determined from the
	// dataset based on input expression.
	RollingDate *RollingDateConfiguration

	// The static values of the DataTimeDefaultValues .
	StaticValues []time.Time
	// contains filtered or unexported fields
}

The default values of the DateTimeParameterDeclaration .

type DateTimeFormatConfiguration added in v1.28.0

type DateTimeFormatConfiguration struct {

	// Determines the DateTime format.
	DateTimeFormat *string

	// The options that determine the null value format configuration.
	NullValueFormatConfiguration *NullValueFormatConfiguration

	// The formatting configuration for numeric DateTime fields.
	NumericFormatConfiguration *NumericFormatConfiguration
	// contains filtered or unexported fields
}

Formatting configuration for DateTime fields.

type DateTimeHierarchy added in v1.28.0

type DateTimeHierarchy struct {

	// The hierarchy ID of the DateTime hierarchy.
	//
	// This member is required.
	HierarchyId *string

	// The option that determines the drill down filters for the DateTime hierarchy.
	DrillDownFilters []DrillDownFilter
	// contains filtered or unexported fields
}

The option that determines the hierarchy of any DateTime fields.

type DateTimeParameter

type DateTimeParameter struct {

	// A display name for the date-time parameter.
	//
	// This member is required.
	Name *string

	// The values for the date-time parameter.
	//
	// This member is required.
	Values []time.Time
	// contains filtered or unexported fields
}

A date-time parameter.

type DateTimeParameterDeclaration added in v1.28.0

type DateTimeParameterDeclaration struct {

	// The name of the parameter that is being declared.
	//
	// This member is required.
	Name *string

	// The default values of a parameter. If the parameter is a single-value
	// parameter, a maximum of one default value can be provided.
	DefaultValues *DateTimeDefaultValues

	// A list of dataset parameters that are mapped to an analysis parameter.
	MappedDataSetParameters []MappedDataSetParameter

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TimeGranularity

	// The configuration that defines the default value of a DateTime parameter when a
	// value has not been set.
	ValueWhenUnset *DateTimeValueWhenUnsetConfiguration
	// contains filtered or unexported fields
}

A parameter declaration for the DateTime data type.

type DateTimePickerControlDisplayOptions added in v1.28.0

type DateTimePickerControlDisplayOptions struct {

	// Customize how dates are formatted in controls.
	DateTimeFormat *string

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type DateTimeValueWhenUnsetConfiguration added in v1.28.0

type DateTimeValueWhenUnsetConfiguration struct {

	// A custom value that's used when the value of a parameter isn't set.
	CustomValue *time.Time

	// The built-in options for default values. The value can be one of the following:
	//   - RECOMMENDED : The recommended value.
	//   - NULL : The NULL value.
	ValueWhenUnsetOption ValueWhenUnsetOption
	// contains filtered or unexported fields
}

The configuration that defines the default value of a DateTime parameter when a value has not been set.

type DayOfTheWeek added in v1.50.0

type DayOfTheWeek string
const (
	DayOfTheWeekSunday    DayOfTheWeek = "SUNDAY"
	DayOfTheWeekMonday    DayOfTheWeek = "MONDAY"
	DayOfTheWeekTuesday   DayOfTheWeek = "TUESDAY"
	DayOfTheWeekWednesday DayOfTheWeek = "WEDNESDAY"
	DayOfTheWeekThursday  DayOfTheWeek = "THURSDAY"
	DayOfTheWeekFriday    DayOfTheWeek = "FRIDAY"
	DayOfTheWeekSaturday  DayOfTheWeek = "SATURDAY"
)

Enum values for DayOfTheWeek

func (DayOfTheWeek) Values added in v1.50.0

func (DayOfTheWeek) Values() []DayOfTheWeek

Values returns all known values for DayOfTheWeek. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DayOfWeek added in v1.34.0

type DayOfWeek string
const (
	DayOfWeekSunday    DayOfWeek = "SUNDAY"
	DayOfWeekMonday    DayOfWeek = "MONDAY"
	DayOfWeekTuesday   DayOfWeek = "TUESDAY"
	DayOfWeekWednesday DayOfWeek = "WEDNESDAY"
	DayOfWeekThursday  DayOfWeek = "THURSDAY"
	DayOfWeekFriday    DayOfWeek = "FRIDAY"
	DayOfWeekSaturday  DayOfWeek = "SATURDAY"
)

Enum values for DayOfWeek

func (DayOfWeek) Values added in v1.34.0

func (DayOfWeek) Values() []DayOfWeek

Values returns all known values for DayOfWeek. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DecimalDatasetParameter added in v1.35.0

type DecimalDatasetParameter struct {

	// An identifier for the decimal parameter created in the dataset.
	//
	// This member is required.
	Id *string

	// The name of the decimal parameter that is created in the dataset.
	//
	// This member is required.
	Name *string

	// The value type of the dataset parameter. Valid values are single value or multi
	// value .
	//
	// This member is required.
	ValueType DatasetParameterValueType

	// A list of default values for a given decimal parameter. This structure only
	// accepts static values.
	DefaultValues *DecimalDatasetParameterDefaultValues
	// contains filtered or unexported fields
}

A decimal parameter for a dataset.

type DecimalDatasetParameterDefaultValues added in v1.35.0

type DecimalDatasetParameterDefaultValues struct {

	// A list of static default values for a given decimal parameter.
	StaticValues []float64
	// contains filtered or unexported fields
}

The default values of a decimal parameter.

type DecimalDefaultValues added in v1.28.0

type DecimalDefaultValues struct {

	// The dynamic value of the DecimalDefaultValues . Different defaults are displayed
	// according to users, groups, and values mapping.
	DynamicValue *DynamicDefaultValue

	// The static values of the DecimalDefaultValues .
	StaticValues []float64
	// contains filtered or unexported fields
}

The default values of the DecimalParameterDeclaration .

type DecimalParameter

type DecimalParameter struct {

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

	// The values for the decimal parameter.
	//
	// This member is required.
	Values []float64
	// contains filtered or unexported fields
}

A decimal parameter.

type DecimalParameterDeclaration added in v1.28.0

type DecimalParameterDeclaration struct {

	// The name of the parameter that is being declared.
	//
	// This member is required.
	Name *string

	// The value type determines whether the parameter is a single-value or
	// multi-value parameter.
	//
	// This member is required.
	ParameterValueType ParameterValueType

	// The default values of a parameter. If the parameter is a single-value
	// parameter, a maximum of one default value can be provided.
	DefaultValues *DecimalDefaultValues

	// A list of dataset parameters that are mapped to an analysis parameter.
	MappedDataSetParameters []MappedDataSetParameter

	// The configuration that defines the default value of a Decimal parameter when a
	// value has not been set.
	ValueWhenUnset *DecimalValueWhenUnsetConfiguration
	// contains filtered or unexported fields
}

A parameter declaration for the Decimal data type.

type DecimalPlacesConfiguration added in v1.28.0

type DecimalPlacesConfiguration struct {

	// The values of the decimal places.
	//
	// This member is required.
	DecimalPlaces *int64
	// contains filtered or unexported fields
}

The option that determines the decimal places configuration.

type DecimalValueWhenUnsetConfiguration added in v1.28.0

type DecimalValueWhenUnsetConfiguration struct {

	// A custom value that's used when the value of a parameter isn't set.
	CustomValue *float64

	// The built-in options for default values. The value can be one of the following:
	//   - RECOMMENDED : The recommended value.
	//   - NULL : The NULL value.
	ValueWhenUnsetOption ValueWhenUnsetOption
	// contains filtered or unexported fields
}

The configuration that defines the default value of a Decimal parameter when a value has not been set.

type DefaultAggregation added in v1.35.0

type DefaultAggregation string
const (
	DefaultAggregationSum           DefaultAggregation = "SUM"
	DefaultAggregationMax           DefaultAggregation = "MAX"
	DefaultAggregationMin           DefaultAggregation = "MIN"
	DefaultAggregationCount         DefaultAggregation = "COUNT"
	DefaultAggregationDistinctCount DefaultAggregation = "DISTINCT_COUNT"
	DefaultAggregationAverage       DefaultAggregation = "AVERAGE"
	DefaultAggregationMedian        DefaultAggregation = "MEDIAN"
	DefaultAggregationStdev         DefaultAggregation = "STDEV"
	DefaultAggregationStdevp        DefaultAggregation = "STDEVP"
	DefaultAggregationVar           DefaultAggregation = "VAR"
	DefaultAggregationVarp          DefaultAggregation = "VARP"
)

Enum values for DefaultAggregation

func (DefaultAggregation) Values added in v1.35.0

Values returns all known values for DefaultAggregation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DefaultDateTimePickerControlOptions added in v1.62.0

type DefaultDateTimePickerControlOptions struct {

	// The display options of a control.
	DisplayOptions *DateTimePickerControlDisplayOptions

	// The date time picker type of the DefaultDateTimePickerControlOptions . Choose
	// one of the following options:
	//   - SINGLE_VALUED : The filter condition is a fixed date.
	//   - DATE_RANGE : The filter condition is a date time range.
	Type SheetControlDateTimePickerType
	// contains filtered or unexported fields
}

The default options that correspond to the filter control type of a DateTimePicker .

type DefaultFilterControlConfiguration added in v1.62.0

type DefaultFilterControlConfiguration struct {

	// The control option for the DefaultFilterControlConfiguration .
	//
	// This member is required.
	ControlOptions *DefaultFilterControlOptions

	// The title of the DefaultFilterControlConfiguration . This title is shared by all
	// controls that are tied to this filter.
	//
	// This member is required.
	Title *string
	// contains filtered or unexported fields
}

The default configuration for all dependent controls of the filter.

type DefaultFilterControlOptions added in v1.62.0

type DefaultFilterControlOptions struct {

	// The default options that correspond to the filter control type of a
	// DateTimePicker .
	DefaultDateTimePickerOptions *DefaultDateTimePickerControlOptions

	// The default options that correspond to the Dropdown filter control type.
	DefaultDropdownOptions *DefaultFilterDropDownControlOptions

	// The default options that correspond to the List filter control type.
	DefaultListOptions *DefaultFilterListControlOptions

	// The default options that correspond to the RelativeDateTime filter control type.
	DefaultRelativeDateTimeOptions *DefaultRelativeDateTimeControlOptions

	// The default options that correspond to the Slider filter control type.
	DefaultSliderOptions *DefaultSliderControlOptions

	// The default options that correspond to the TextArea filter control type.
	DefaultTextAreaOptions *DefaultTextAreaControlOptions

	// The default options that correspond to the TextField filter control type.
	DefaultTextFieldOptions *DefaultTextFieldControlOptions
	// contains filtered or unexported fields
}

The option that corresponds to the control type of the filter.

type DefaultFilterDropDownControlOptions added in v1.62.0

type DefaultFilterDropDownControlOptions struct {

	// The display options of a control.
	DisplayOptions *DropDownControlDisplayOptions

	// A list of selectable values that are used in a control.
	SelectableValues *FilterSelectableValues

	// The type of the FilterDropDownControl . Choose one of the following options:
	//   - MULTI_SELECT : The user can select multiple entries from a dropdown menu.
	//   - SINGLE_SELECT : The user can select a single entry from a dropdown menu.
	Type SheetControlListType
	// contains filtered or unexported fields
}

The default options that correspond to the Dropdown filter control type.

type DefaultFilterListControlOptions added in v1.62.0

type DefaultFilterListControlOptions struct {

	// The display options of a control.
	DisplayOptions *ListControlDisplayOptions

	// A list of selectable values that are used in a control.
	SelectableValues *FilterSelectableValues

	// The type of the DefaultFilterListControlOptions . Choose one of the following
	// options:
	//   - MULTI_SELECT : The user can select multiple entries from the list.
	//   - SINGLE_SELECT : The user can select a single entry from the list.
	Type SheetControlListType
	// contains filtered or unexported fields
}

The default options that correspond to the List filter control type.

type DefaultFormatting added in v1.35.0

type DefaultFormatting struct {

	// The display format. Valid values for this structure are AUTO , PERCENT ,
	// CURRENCY , NUMBER , DATE , and STRING .
	DisplayFormat DisplayFormat

	// The additional options for display formatting.
	DisplayFormatOptions *DisplayFormatOptions
	// contains filtered or unexported fields
}

A structure that represents a default formatting definition.

type DefaultFreeFormLayoutConfiguration added in v1.28.0

type DefaultFreeFormLayoutConfiguration struct {

	// Determines the screen canvas size options for a free-form layout.
	//
	// This member is required.
	CanvasSizeOptions *FreeFormLayoutCanvasSizeOptions
	// contains filtered or unexported fields
}

The options that determine the default settings of a free-form layout configuration.

type DefaultGridLayoutConfiguration added in v1.28.0

type DefaultGridLayoutConfiguration struct {

	// Determines the screen canvas size options for a grid layout.
	//
	// This member is required.
	CanvasSizeOptions *GridLayoutCanvasSizeOptions
	// contains filtered or unexported fields
}

The options that determine the default settings for a grid layout configuration.

type DefaultInteractiveLayoutConfiguration added in v1.28.0

type DefaultInteractiveLayoutConfiguration struct {

	// The options that determine the default settings of a free-form layout
	// configuration.
	FreeForm *DefaultFreeFormLayoutConfiguration

	// The options that determine the default settings for a grid layout configuration.
	Grid *DefaultGridLayoutConfiguration
	// contains filtered or unexported fields
}

The options that determine the default settings for interactive layout configuration.

type DefaultNewSheetConfiguration added in v1.28.0

type DefaultNewSheetConfiguration struct {

	// The options that determine the default settings for interactive layout
	// configuration.
	InteractiveLayoutConfiguration *DefaultInteractiveLayoutConfiguration

	// The options that determine the default settings for a paginated layout
	// configuration.
	PaginatedLayoutConfiguration *DefaultPaginatedLayoutConfiguration

	// The option that determines the sheet content type.
	SheetContentType SheetContentType
	// contains filtered or unexported fields
}

The configuration for default new sheet settings.

type DefaultPaginatedLayoutConfiguration added in v1.28.0

type DefaultPaginatedLayoutConfiguration struct {

	// The options that determine the default settings for a section-based layout
	// configuration.
	SectionBased *DefaultSectionBasedLayoutConfiguration
	// contains filtered or unexported fields
}

The options that determine the default settings for a paginated layout configuration.

type DefaultRelativeDateTimeControlOptions added in v1.62.0

type DefaultRelativeDateTimeControlOptions struct {

	// The display options of a control.
	DisplayOptions *RelativeDateTimeControlDisplayOptions
	// contains filtered or unexported fields
}

The default options that correspond to the RelativeDateTime filter control type.

type DefaultSectionBasedLayoutConfiguration added in v1.28.0

type DefaultSectionBasedLayoutConfiguration struct {

	// Determines the screen canvas size options for a section-based layout.
	//
	// This member is required.
	CanvasSizeOptions *SectionBasedLayoutCanvasSizeOptions
	// contains filtered or unexported fields
}

The options that determine the default settings for a section-based layout configuration.

type DefaultSliderControlOptions added in v1.62.0

type DefaultSliderControlOptions struct {

	// The larger value that is displayed at the right of the slider.
	//
	// This member is required.
	MaximumValue float64

	// The smaller value that is displayed at the left of the slider.
	//
	// This member is required.
	MinimumValue float64

	// The number of increments that the slider bar is divided into.
	//
	// This member is required.
	StepSize float64

	// The display options of a control.
	DisplayOptions *SliderControlDisplayOptions

	// The type of the DefaultSliderControlOptions . Choose one of the following
	// options:
	//   - SINGLE_POINT : Filter against(equals) a single data point.
	//   - RANGE : Filter data that is in a specified range.
	Type SheetControlSliderType
	// contains filtered or unexported fields
}

The default options that correspond to the Slider filter control type.

type DefaultTextAreaControlOptions added in v1.62.0

type DefaultTextAreaControlOptions struct {

	// The delimiter that is used to separate the lines in text.
	Delimiter *string

	// The display options of a control.
	DisplayOptions *TextAreaControlDisplayOptions
	// contains filtered or unexported fields
}

The default options that correspond to the TextArea filter control type.

type DefaultTextFieldControlOptions added in v1.62.0

type DefaultTextFieldControlOptions struct {

	// The display options of a control.
	DisplayOptions *TextFieldControlDisplayOptions
	// contains filtered or unexported fields
}

The default options that correspond to the TextField filter control type.

type DestinationParameterValueConfiguration added in v1.28.0

type DestinationParameterValueConfiguration struct {

	// The configuration of custom values for destination parameter in
	// DestinationParameterValueConfiguration .
	CustomValuesConfiguration *CustomValuesConfiguration

	// The configuration that selects all options.
	SelectAllValueOptions SelectAllValueOptions

	// A column of a data set.
	SourceColumn *ColumnIdentifier

	// The source field ID of the destination parameter.
	SourceField *string

	// The source parameter name of the destination parameter.
	SourceParameterName *string
	// contains filtered or unexported fields
}

The configuration of destination parameter values. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type DimensionField added in v1.28.0

type DimensionField struct {

	// The dimension type field with categorical type columns.
	CategoricalDimensionField *CategoricalDimensionField

	// The dimension type field with date type columns.
	DateDimensionField *DateDimensionField

	// The dimension type field with numerical type columns.
	NumericalDimensionField *NumericalDimensionField
	// contains filtered or unexported fields
}

The dimension type field.

type DisplayFormat added in v1.35.0

type DisplayFormat string
const (
	DisplayFormatAuto     DisplayFormat = "AUTO"
	DisplayFormatPercent  DisplayFormat = "PERCENT"
	DisplayFormatCurrency DisplayFormat = "CURRENCY"
	DisplayFormatNumber   DisplayFormat = "NUMBER"
	DisplayFormatDate     DisplayFormat = "DATE"
	DisplayFormatString   DisplayFormat = "STRING"
)

Enum values for DisplayFormat

func (DisplayFormat) Values added in v1.35.0

func (DisplayFormat) Values() []DisplayFormat

Values returns all known values for DisplayFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DisplayFormatOptions added in v1.35.0

type DisplayFormatOptions struct {

	// Determines the blank cell format.
	BlankCellFormat *string

	// The currency symbol, such as USD .
	CurrencySymbol *string

	// Determines the DateTime format.
	DateFormat *string

	// Determines the decimal separator.
	DecimalSeparator TopicNumericSeparatorSymbol

	// Determines the number of fraction digits.
	FractionDigits int32

	// Determines the grouping separator.
	GroupingSeparator *string

	// The negative format.
	NegativeFormat *NegativeFormat

	// The prefix value for a display format.
	Prefix *string

	// The suffix value for a display format.
	Suffix *string

	// The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS ,
	// MILLIONS , BILLIONS , and TRILLIONS .
	UnitScaler NumberScale

	// A Boolean value that indicates whether to use blank cell format.
	UseBlankCellFormat bool

	// A Boolean value that indicates whether to use grouping.
	UseGrouping bool
	// contains filtered or unexported fields
}

A structure that represents additional options for display formatting.

type DomainNotWhitelistedException

type DomainNotWhitelistedException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 DonutCenterOptions added in v1.28.0

type DonutCenterOptions struct {

	// Determines the visibility of the label in a donut chart. In the Amazon
	// QuickSight console, this option is called 'Show total' .
	LabelVisibility Visibility
	// contains filtered or unexported fields
}

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

type DonutOptions added in v1.28.0

type DonutOptions struct {

	// The option for define the arc of the chart shape. Valid values are as follows:
	//   - WHOLE - A pie chart
	//   - SMALL - A small-sized donut chart
	//   - MEDIUM - A medium-sized donut chart
	//   - LARGE - A large-sized donut chart
	ArcOptions *ArcOptions

	// The label options of the label that is displayed in the center of a donut
	// chart. This option isn't available for pie charts.
	DonutCenterOptions *DonutCenterOptions
	// contains filtered or unexported fields
}

The options for configuring a donut chart or pie chart.

type DrillDownFilter added in v1.28.0

type DrillDownFilter struct {

	// The category type drill down filter. This filter is used for string type
	// columns.
	CategoryFilter *CategoryDrillDownFilter

	// The numeric equality type drill down filter. This filter is used for number
	// type columns.
	NumericEqualityFilter *NumericEqualityDrillDownFilter

	// The time range drill down filter. This filter is used for date time columns.
	TimeRangeFilter *TimeRangeDrillDownFilter
	// contains filtered or unexported fields
}

The drill down filter for the column hierarchies. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type DropDownControlDisplayOptions struct {

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The configuration of the Select all options in a dropdown control.
	SelectAllOptions *ListControlSelectAllOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type DynamicDefaultValue added in v1.28.0

type DynamicDefaultValue struct {

	// The column that contains the default value of each user or group.
	//
	// This member is required.
	DefaultValueColumn *ColumnIdentifier

	// The column that contains the group name.
	GroupNameColumn *ColumnIdentifier

	// The column that contains the username.
	UserNameColumn *ColumnIdentifier
	// contains filtered or unexported fields
}

Defines different defaults to the users or groups based on mapping.

type Edition

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

Enum values for Edition

func (Edition) Values added in v0.29.0

func (Edition) Values() []Edition

Values returns all known values for Edition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EmbeddingIdentityType added in v0.31.0

type EmbeddingIdentityType string
const (
	EmbeddingIdentityTypeIam        EmbeddingIdentityType = "IAM"
	EmbeddingIdentityTypeQuicksight EmbeddingIdentityType = "QUICKSIGHT"
	EmbeddingIdentityTypeAnonymous  EmbeddingIdentityType = "ANONYMOUS"
)

Enum values for EmbeddingIdentityType

func (EmbeddingIdentityType) Values added in v0.31.0

Values returns all known values for EmbeddingIdentityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EmptyVisual added in v1.28.0

type EmptyVisual struct {

	// The data set that is used in the empty visual. Every visual requires a dataset
	// to render.
	//
	// This member is required.
	DataSetIdentifier *string

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction
	// contains filtered or unexported fields
}

An empty visual. Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

type Entity added in v1.28.0

type Entity struct {

	// The hierarchical path of the entity within the analysis, template, or dashboard
	// definition tree.
	Path *string
	// contains filtered or unexported fields
}

An object, structure, or sub-structure of an analysis, template, or dashboard.

type ErrorInfo

type ErrorInfo struct {

	// Error message.
	Message *string

	// Error type.
	Type IngestionErrorType
	// contains filtered or unexported fields
}

Error information for the SPICE ingestion of a dataset.

type ExasolParameters added in v1.15.0

type ExasolParameters struct {

	// The hostname or IP address of the Exasol data source.
	//
	// This member is required.
	Host *string

	// The port for the Exasol data source.
	//
	// This member is required.
	Port *int32
	// contains filtered or unexported fields
}

The required parameters for connecting to an Exasol data source.

type ExceptionResourceType

type ExceptionResourceType string
const (
	ExceptionResourceTypeUser                ExceptionResourceType = "USER"
	ExceptionResourceTypeGroup               ExceptionResourceType = "GROUP"
	ExceptionResourceTypeNamespace           ExceptionResourceType = "NAMESPACE"
	ExceptionResourceTypeAccountSettings     ExceptionResourceType = "ACCOUNT_SETTINGS"
	ExceptionResourceTypeIampolicyAssignment ExceptionResourceType = "IAMPOLICY_ASSIGNMENT"
	ExceptionResourceTypeDataSource          ExceptionResourceType = "DATA_SOURCE"
	ExceptionResourceTypeDataSet             ExceptionResourceType = "DATA_SET"
	ExceptionResourceTypeVpcConnection       ExceptionResourceType = "VPC_CONNECTION"
	ExceptionResourceTypeIngestion           ExceptionResourceType = "INGESTION"
)

Enum values for ExceptionResourceType

func (ExceptionResourceType) Values added in v0.29.0

Values returns all known values for ExceptionResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExcludePeriodConfiguration added in v1.28.0

type ExcludePeriodConfiguration struct {

	// The amount or number of the exclude period.
	//
	// This member is required.
	Amount *int32

	// The granularity or unit (day, month, year) of the exclude period.
	//
	// This member is required.
	Granularity TimeGranularity

	// The status of the exclude period. Choose from the following options:
	//   - ENABLED
	//   - DISABLED
	Status WidgetStatus
	// contains filtered or unexported fields
}

The exclude period of TimeRangeFilter or RelativeDatesFilter .

type ExplicitHierarchy added in v1.28.0

type ExplicitHierarchy struct {

	// The list of columns that define the explicit hierarchy.
	//
	// This member is required.
	Columns []ColumnIdentifier

	// The hierarchy ID of the explicit hierarchy.
	//
	// This member is required.
	HierarchyId *string

	// The option that determines the drill down filters for the explicit hierarchy.
	DrillDownFilters []DrillDownFilter
	// contains filtered or unexported fields
}

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

type ExportHiddenFieldsOption added in v1.28.0

type ExportHiddenFieldsOption struct {

	// The status of the export hidden fields options of a dashbaord.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

Determines if hidden fields are included in an exported dashboard.

type ExportToCSVOption

type ExportToCSVOption struct {

	// Availability status.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

Export to .csv option.

type ExportWithHiddenFieldsOption added in v1.31.0

type ExportWithHiddenFieldsOption struct {

	// The status of the export with hidden fields options.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

Determines whether or not hidden fields are visible on exported dashbaords.

type FieldBasedTooltip added in v1.28.0

type FieldBasedTooltip struct {

	// The visibility of Show aggregations .
	AggregationVisibility Visibility

	// The fields configuration in the tooltip.
	TooltipFields []TooltipItem

	// The type for the >tooltip title. Choose one of the following options:
	//   - NONE : Doesn't use the primary value as the title.
	//   - PRIMARY_VALUE : Uses primary value as the title.
	TooltipTitleType TooltipTitleType
	// contains filtered or unexported fields
}

The setup for the detailed tooltip.

type FieldFolder added in v1.2.0

type FieldFolder struct {

	// A folder has a list of columns. A column can only be in one folder.
	Columns []string

	// The description for a field folder.
	Description *string
	// contains filtered or unexported fields
}

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

type FieldLabelType added in v1.28.0

type FieldLabelType struct {

	// Indicates the field that is targeted by the field label.
	FieldId *string

	// The visibility of the field label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The field label type.

type FieldSeriesItem added in v1.28.0

type FieldSeriesItem struct {

	// The axis that you are binding the field to.
	//
	// This member is required.
	AxisBinding AxisBinding

	// The field ID of the field for which you are setting the axis binding.
	//
	// This member is required.
	FieldId *string

	// The options that determine the presentation of line series associated to the
	// field.
	Settings *LineChartSeriesSettings
	// contains filtered or unexported fields
}

The field series item configuration of a line chart.

type FieldSort added in v1.28.0

type FieldSort struct {

	// The sort direction. Choose one of the following options:
	//   - ASC : Ascending
	//   - DESC : Descending
	//
	// This member is required.
	Direction SortDirection

	// The sort configuration target field.
	//
	// This member is required.
	FieldId *string
	// contains filtered or unexported fields
}

The sort configuration for a field in a field well.

type FieldSortOptions added in v1.28.0

type FieldSortOptions struct {

	// The sort configuration for a column that is not used in a field well.
	ColumnSort *ColumnSort

	// The sort configuration for a field in a field well.
	FieldSort *FieldSort
	// contains filtered or unexported fields
}

The field sort options in a chart configuration.

type FieldTooltipItem added in v1.28.0

type FieldTooltipItem struct {

	// The unique ID of the field that is targeted by the tooltip.
	//
	// This member is required.
	FieldId *string

	// The label of the tooltip item.
	Label *string

	// Determines the target of the field tooltip item in a combo chart visual.
	TooltipTarget TooltipTarget

	// The visibility of the tooltip item.
	Visibility Visibility
	// contains filtered or unexported fields
}

The tooltip item for the fields.

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

func (FileFormat) Values added in v0.29.0

func (FileFormat) Values() []FileFormat

Values returns all known values for FileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FilledMapAggregatedFieldWells added in v1.28.0

type FilledMapAggregatedFieldWells struct {

	// The aggregated location field well of the filled map. Values are grouped by
	// location fields.
	Geospatial []DimensionField

	// The aggregated color field well of a filled map. Values are aggregated based on
	// location fields.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field well of the filled map.

type FilledMapConditionalFormatting added in v1.28.0

type FilledMapConditionalFormatting struct {

	// Conditional formatting options of a FilledMapVisual .
	//
	// This member is required.
	ConditionalFormattingOptions []FilledMapConditionalFormattingOption
	// contains filtered or unexported fields
}

The conditional formatting of a FilledMapVisual .

type FilledMapConditionalFormattingOption added in v1.28.0

type FilledMapConditionalFormattingOption struct {

	// The conditional formatting that determines the shape of the filled map.
	//
	// This member is required.
	Shape *FilledMapShapeConditionalFormatting
	// contains filtered or unexported fields
}

Conditional formatting options of a FilledMapVisual .

type FilledMapConfiguration added in v1.28.0

type FilledMapConfiguration struct {

	// The field wells of the visual.
	FieldWells *FilledMapFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The map style options of the filled map visual.
	MapStyleOptions *GeospatialMapStyleOptions

	// The sort configuration of a FilledMapVisual .
	SortConfiguration *FilledMapSortConfiguration

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions

	// The window options of the filled map visual.
	WindowOptions *GeospatialWindowOptions
	// contains filtered or unexported fields
}

The configuration for a FilledMapVisual .

type FilledMapFieldWells added in v1.28.0

type FilledMapFieldWells struct {

	// The aggregated field well of the filled map.
	FilledMapAggregatedFieldWells *FilledMapAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a FilledMapVisual . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FilledMapShapeConditionalFormatting added in v1.28.0

type FilledMapShapeConditionalFormatting struct {

	// The field ID of the filled map shape.
	//
	// This member is required.
	FieldId *string

	// The conditional formatting that determines the background color of a filled
	// map's shape.
	Format *ShapeConditionalFormat
	// contains filtered or unexported fields
}

The conditional formatting that determines the shape of the filled map.

type FilledMapSortConfiguration added in v1.28.0

type FilledMapSortConfiguration struct {

	// The sort configuration of the location fields.
	CategorySort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a FilledMapVisual .

type FilledMapVisual added in v1.28.0

type FilledMapVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *FilledMapConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The conditional formatting of a FilledMapVisual .
	ConditionalFormatting *FilledMapConditionalFormatting

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A filled map. For more information, see Creating filled maps (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the Amazon QuickSight User Guide.

type Filter added in v1.28.0

type Filter struct {

	// A CategoryFilter filters text values. For more information, see Adding text
	// filters (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html)
	// in the Amazon QuickSight User Guide.
	CategoryFilter *CategoryFilter

	// A NumericEqualityFilter filters numeric values that equal or do not equal a
	// given numeric value.
	NumericEqualityFilter *NumericEqualityFilter

	// A NumericRangeFilter filters numeric values that are either inside or outside a
	// given numeric range.
	NumericRangeFilter *NumericRangeFilter

	// A RelativeDatesFilter filters date values that are relative to a given date.
	RelativeDatesFilter *RelativeDatesFilter

	// A TimeEqualityFilter filters date-time values that equal or do not equal a
	// given date/time value.
	TimeEqualityFilter *TimeEqualityFilter

	// A TimeRangeFilter filters date-time values that are either inside or outside a
	// given date/time range.
	TimeRangeFilter *TimeRangeFilter

	// A TopBottomFilter filters data to the top or bottom values for a given column.
	TopBottomFilter *TopBottomFilter
	// contains filtered or unexported fields
}

With a Filter , you can remove portions of data from a particular visual or view. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FilterClass added in v1.35.0

type FilterClass string
const (
	FilterClassEnforcedValueFilter    FilterClass = "ENFORCED_VALUE_FILTER"
	FilterClassConditionalValueFilter FilterClass = "CONDITIONAL_VALUE_FILTER"
	FilterClassNamedValueFilter       FilterClass = "NAMED_VALUE_FILTER"
)

Enum values for FilterClass

func (FilterClass) Values added in v1.35.0

func (FilterClass) Values() []FilterClass

Values returns all known values for FilterClass. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FilterControl added in v1.28.0

type FilterControl struct {

	// A control from a filter that is scoped across more than one sheet. This
	// represents your filter control on a sheet
	CrossSheet *FilterCrossSheetControl

	// A control from a date filter that is used to specify date and time.
	DateTimePicker *FilterDateTimePickerControl

	// A control to display a dropdown list with buttons that are used to select a
	// single value.
	Dropdown *FilterDropDownControl

	// A control to display a list of buttons or boxes. This is used to select either
	// a single value or multiple values.
	List *FilterListControl

	// A control from a date filter that is used to specify the relative date.
	RelativeDateTime *FilterRelativeDateTimeControl

	// A control to display a horizontal toggle bar. This is used to change a value by
	// sliding the toggle.
	Slider *FilterSliderControl

	// A control to display a text box that is used to enter multiple entries.
	TextArea *FilterTextAreaControl

	// A control to display a text box that is used to enter a single entry.
	TextField *FilterTextFieldControl
	// contains filtered or unexported fields
}

The control of a filter that is used to interact with a dashboard or an analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FilterCrossSheetControl added in v1.62.0

type FilterCrossSheetControl struct {

	// The ID of the FilterCrossSheetControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterCrossSheetControl .
	//
	// This member is required.
	SourceFilterId *string

	// The values that are displayed in a control can be configured to only show
	// values that are valid based on what's selected in other controls.
	CascadingControlConfiguration *CascadingControlConfiguration
	// contains filtered or unexported fields
}

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

type FilterDateTimePickerControl added in v1.28.0

type FilterDateTimePickerControl struct {

	// The ID of the FilterDateTimePickerControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterDateTimePickerControl .
	//
	// This member is required.
	SourceFilterId *string

	// The title of the FilterDateTimePickerControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *DateTimePickerControlDisplayOptions

	// The type of the FilterDropDownControl . Choose one of the following options:
	//   - MULTI_SELECT : The user can select multiple entries from a dropdown menu.
	//   - SINGLE_SELECT : The user can select a single entry from a dropdown menu.
	Type SheetControlDateTimePickerType
	// contains filtered or unexported fields
}

A control from a date filter that is used to specify date and time.

type FilterDropDownControl added in v1.28.0

type FilterDropDownControl struct {

	// The ID of the FilterDropDownControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterDropDownControl .
	//
	// This member is required.
	SourceFilterId *string

	// The title of the FilterDropDownControl .
	//
	// This member is required.
	Title *string

	// The values that are displayed in a control can be configured to only show
	// values that are valid based on what's selected in other controls.
	CascadingControlConfiguration *CascadingControlConfiguration

	// The display options of the FilterDropDownControl .
	DisplayOptions *DropDownControlDisplayOptions

	// A list of selectable values that are used in a control.
	SelectableValues *FilterSelectableValues

	// The type of the FilterDropDownControl . Choose one of the following options:
	//   - MULTI_SELECT : The user can select multiple entries from a dropdown menu.
	//   - SINGLE_SELECT : The user can select a single entry from a dropdown menu.
	Type SheetControlListType
	// contains filtered or unexported fields
}

A control to display a dropdown list with buttons that are used to select a single value.

type FilterGroup added in v1.28.0

type FilterGroup struct {

	// The filter new feature which can apply filter group to all data sets. Choose
	// one of the following options:
	//   - ALL_DATASETS
	//   - SINGLE_DATASET
	//
	// This member is required.
	CrossDataset CrossDatasetTypes

	// The value that uniquely identifies a FilterGroup within a dashboard, template,
	// or analysis.
	//
	// This member is required.
	FilterGroupId *string

	// The list of filters that are present in a FilterGroup .
	//
	// This member is required.
	Filters []Filter

	// The configuration that specifies what scope to apply to a FilterGroup . This is
	// a union type structure. For this structure to be valid, only one of the
	// attributes can be defined.
	//
	// This member is required.
	ScopeConfiguration *FilterScopeConfiguration

	// The status of the FilterGroup .
	Status WidgetStatus
	// contains filtered or unexported fields
}

A grouping of individual filters. Filter groups are applied to the same group of visuals. For more information, see Adding filter conditions (group filters) with AND and OR operators (https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) in the Amazon QuickSight User Guide.

type FilterListConfiguration added in v1.28.0

type FilterListConfiguration struct {

	// The match operator that is used to determine if a filter should be applied.
	//
	// This member is required.
	MatchOperator CategoryFilterMatchOperator

	// The list of category values for the filter.
	CategoryValues []string

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	NullOption FilterNullOption

	// Select all of the values. Null is not the assigned value of select all.
	//   - FILTER_ALL_VALUES
	SelectAllOptions CategoryFilterSelectAllOptions
	// contains filtered or unexported fields
}

A list of filter configurations.

type FilterListControl added in v1.28.0

type FilterListControl struct {

	// The ID of the FilterListControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterListControl .
	//
	// This member is required.
	SourceFilterId *string

	// The title of the FilterListControl .
	//
	// This member is required.
	Title *string

	// The values that are displayed in a control can be configured to only show
	// values that are valid based on what's selected in other controls.
	CascadingControlConfiguration *CascadingControlConfiguration

	// The display options of a control.
	DisplayOptions *ListControlDisplayOptions

	// A list of selectable values that are used in a control.
	SelectableValues *FilterSelectableValues

	// The type of the FilterListControl . Choose one of the following options:
	//   - MULTI_SELECT : The user can select multiple entries from the list.
	//   - SINGLE_SELECT : The user can select a single entry from the list.
	Type SheetControlListType
	// contains filtered or unexported fields
}

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

type FilterNullOption added in v1.28.0

type FilterNullOption string
const (
	FilterNullOptionAllValues    FilterNullOption = "ALL_VALUES"
	FilterNullOptionNullsOnly    FilterNullOption = "NULLS_ONLY"
	FilterNullOptionNonNullsOnly FilterNullOption = "NON_NULLS_ONLY"
)

Enum values for FilterNullOption

func (FilterNullOption) Values added in v1.28.0

Values returns all known values for FilterNullOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

A transform operation that filters rows based on a condition.

type FilterOperationSelectedFieldsConfiguration added in v1.28.0

type FilterOperationSelectedFieldsConfiguration struct {

	// The selected columns of a dataset.
	SelectedColumns []ColumnIdentifier

	// A structure that contains the options that choose which fields are filtered in
	// the CustomActionFilterOperation . Valid values are defined as follows:
	//   - ALL_FIELDS : Applies the filter operation to all fields.
	SelectedFieldOptions SelectedFieldOptions

	// Chooses the fields that are filtered in CustomActionFilterOperation .
	SelectedFields []string
	// contains filtered or unexported fields
}

The configuration of selected fields in the CustomActionFilterOperation . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FilterOperationTargetVisualsConfiguration added in v1.28.0

type FilterOperationTargetVisualsConfiguration struct {

	// The configuration of the same-sheet target visuals that you want to be filtered.
	SameSheetTargetVisualConfiguration *SameSheetTargetVisualConfiguration
	// contains filtered or unexported fields
}

The configuration of target visuals that you want to be filtered. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FilterOperator

type FilterOperator string
const (
	FilterOperatorStringEquals FilterOperator = "StringEquals"
	FilterOperatorStringLike   FilterOperator = "StringLike"
)

Enum values for FilterOperator

func (FilterOperator) Values added in v0.29.0

func (FilterOperator) Values() []FilterOperator

Values returns all known values for FilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FilterRelativeDateTimeControl added in v1.28.0

type FilterRelativeDateTimeControl struct {

	// The ID of the FilterTextAreaControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterTextAreaControl .
	//
	// This member is required.
	SourceFilterId *string

	// The title of the FilterTextAreaControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *RelativeDateTimeControlDisplayOptions
	// contains filtered or unexported fields
}

A control from a date filter that is used to specify the relative date.

type FilterScopeConfiguration added in v1.28.0

type FilterScopeConfiguration struct {

	// The configuration that applies a filter to all sheets. When you choose AllSheets
	// as the value for a FilterScopeConfiguration , this filter is applied to all
	// visuals of all sheets in an Analysis, Dashboard, or Template. The
	// AllSheetsFilterScopeConfiguration is chosen.
	AllSheets *AllSheetsFilterScopeConfiguration

	// The configuration for applying a filter to specific sheets.
	SelectedSheets *SelectedSheetsFilterScopeConfiguration
	// contains filtered or unexported fields
}

The scope configuration for a FilterGroup . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FilterSelectableValues added in v1.28.0

type FilterSelectableValues struct {

	// The values that are used in the FilterSelectableValues .
	Values []string
	// contains filtered or unexported fields
}

A list of selectable values that are used in a control.

type FilterSliderControl added in v1.28.0

type FilterSliderControl struct {

	// The ID of the FilterSliderControl .
	//
	// This member is required.
	FilterControlId *string

	// The larger value that is displayed at the right of the slider.
	//
	// This member is required.
	MaximumValue float64

	// The smaller value that is displayed at the left of the slider.
	//
	// This member is required.
	MinimumValue float64

	// The source filter ID of the FilterSliderControl .
	//
	// This member is required.
	SourceFilterId *string

	// The number of increments that the slider bar is divided into.
	//
	// This member is required.
	StepSize float64

	// The title of the FilterSliderControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *SliderControlDisplayOptions

	// The type of the FilterSliderControl . Choose one of the following options:
	//   - SINGLE_POINT : Filter against(equals) a single data point.
	//   - RANGE : Filter data that is in a specified range.
	Type SheetControlSliderType
	// contains filtered or unexported fields
}

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

type FilterTextAreaControl added in v1.28.0

type FilterTextAreaControl struct {

	// The ID of the FilterTextAreaControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterTextAreaControl .
	//
	// This member is required.
	SourceFilterId *string

	// The title of the FilterTextAreaControl .
	//
	// This member is required.
	Title *string

	// The delimiter that is used to separate the lines in text.
	Delimiter *string

	// The display options of a control.
	DisplayOptions *TextAreaControlDisplayOptions
	// contains filtered or unexported fields
}

A control to display a text box that is used to enter multiple entries.

type FilterTextFieldControl added in v1.28.0

type FilterTextFieldControl struct {

	// The ID of the FilterTextFieldControl .
	//
	// This member is required.
	FilterControlId *string

	// The source filter ID of the FilterTextFieldControl .
	//
	// This member is required.
	SourceFilterId *string

	// The title of the FilterTextFieldControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *TextFieldControlDisplayOptions
	// contains filtered or unexported fields
}

A control to display a text box that is used to enter a single entry.

type FilterVisualScope added in v1.28.0

type FilterVisualScope string
const (
	FilterVisualScopeAllVisuals      FilterVisualScope = "ALL_VISUALS"
	FilterVisualScopeSelectedVisuals FilterVisualScope = "SELECTED_VISUALS"
)

Enum values for FilterVisualScope

func (FilterVisualScope) Values added in v1.28.0

Values returns all known values for FilterVisualScope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Folder added in v1.6.0

type Folder struct {

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

	// The time that the folder was created.
	CreatedTime *time.Time

	// The ID of the folder.
	FolderId *string

	// An array of ancestor ARN strings for the folder.
	FolderPath []string

	// The type of folder it is.
	FolderType FolderType

	// The time that the folder was last updated.
	LastUpdatedTime *time.Time

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

	// The sharing scope of the folder.
	SharingModel SharingModel
	// contains filtered or unexported fields
}

A folder in Amazon QuickSight.

type FolderFilterAttribute added in v1.6.0

type FolderFilterAttribute string
const (
	FolderFilterAttributeParentFolderArn               FolderFilterAttribute = "PARENT_FOLDER_ARN"
	FolderFilterAttributeDirectQuicksightOwner         FolderFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
	FolderFilterAttributeDirectQuicksightSoleOwner     FolderFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
	FolderFilterAttributeDirectQuicksightViewerOrOwner FolderFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
	FolderFilterAttributeQuicksightOwner               FolderFilterAttribute = "QUICKSIGHT_OWNER"
	FolderFilterAttributeQuicksightViewerOrOwner       FolderFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
	FolderFilterAttributeFolderName                    FolderFilterAttribute = "FOLDER_NAME"
)

Enum values for FolderFilterAttribute

func (FolderFilterAttribute) Values added in v1.6.0

Values returns all known values for FolderFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FolderMember added in v1.6.0

type FolderMember struct {

	// The ID of an asset in the folder.
	MemberId *string

	// The type of asset that it is.
	MemberType MemberType
	// contains filtered or unexported fields
}

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

type FolderSearchFilter added in v1.6.0

type FolderSearchFilter struct {

	// The name of a value that you want to use in the filter. For example, "Name":
	// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
	//   - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
	//   folders with that ARN listed as one of the folder's owners or viewers are
	//   returned. Implicit permissions from folders or groups are considered.
	//   - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with
	//   that ARN listed as one of the owners of the folders are returned. Implicit
	//   permissions from folders or groups are considered.
	//   - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
	//   folders with that ARN listed as the only owner of the folder are returned.
	//   Implicit permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders
	//   with that ARN listed as one of the owners of the folders are returned. Implicit
	//   permissions from folders or groups are not considered.
	//   - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
	//   any folders with that ARN listed as one of the owners or viewers of the folders
	//   are returned. Implicit permissions from folders or groups are not considered.
	//   - FOLDER_NAME : Any folders whose names have a substring match to this value
	//   will be returned.
	//   - PARENT_FOLDER_ARN : Provide an ARN of a folder, and any folders that are
	//   directly under that parent folder are returned. If you choose to use this option
	//   and leave the value blank, all root-level folders in the account are returned.
	Name FolderFilterAttribute

	// The comparison operator that you want to use as a filter, for example
	// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
	// If you set the operator value to "StringEquals" , you need to provide an
	// ownership related filter in the "NAME" field and the arn of the user or group
	// whose folders you want to search in the "Value" field. For example,
	// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
	// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
	// to "StringLike" , you need to provide the name of the folders you are searching
	// for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value":
	// "Test" . The "StringLike" operator only supports the NAME value FOLDER_NAME .
	Operator FilterOperator

	// The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want
	// to use as a filter. For example, "Value":
	// "arn:aws:quicksight:us-east-1:1:folder/folderId" .
	Value *string
	// contains filtered or unexported fields
}

A filter to use to search an Amazon QuickSight folder.

type FolderSummary added in v1.6.0

type FolderSummary struct {

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

	// The time that the folder was created.
	CreatedTime *time.Time

	// The ID of the folder.
	FolderId *string

	// The type of folder.
	FolderType FolderType

	// The time that the folder was last updated.
	LastUpdatedTime *time.Time

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

	// The sharing scope of the folder.
	SharingModel SharingModel
	// contains filtered or unexported fields
}

A summary of information about an existing Amazon QuickSight folder.

type FolderType added in v1.6.0

type FolderType string
const (
	FolderTypeShared     FolderType = "SHARED"
	FolderTypeRestricted FolderType = "RESTRICTED"
)

Enum values for FolderType

func (FolderType) Values added in v1.6.0

func (FolderType) Values() []FolderType

Values returns all known values for FolderType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Font added in v1.28.0

type Font struct {

	// Determines the font family settings.
	FontFamily *string
	// contains filtered or unexported fields
}

Determines the font settings.

type FontConfiguration added in v1.28.0

type FontConfiguration struct {

	// Determines the color of the text.
	FontColor *string

	// Determines the appearance of decorative lines on the text.
	FontDecoration FontDecoration

	// The option that determines the text display size.
	FontSize *FontSize

	// Determines the text display face that is inherited by the given font family.
	FontStyle FontStyle

	// The option that determines the text display weight, or boldness.
	FontWeight *FontWeight
	// contains filtered or unexported fields
}

Configures the display properties of the given text.

type FontDecoration added in v1.28.0

type FontDecoration string
const (
	FontDecorationUnderline FontDecoration = "UNDERLINE"
	FontDecorationNone      FontDecoration = "NONE"
)

Enum values for FontDecoration

func (FontDecoration) Values added in v1.28.0

func (FontDecoration) Values() []FontDecoration

Values returns all known values for FontDecoration. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FontSize added in v1.28.0

type FontSize struct {

	// The lexical name for the text size, proportional to its surrounding context.
	Relative RelativeFontSize
	// contains filtered or unexported fields
}

The option that determines the text display size.

type FontStyle added in v1.28.0

type FontStyle string
const (
	FontStyleNormal FontStyle = "NORMAL"
	FontStyleItalic FontStyle = "ITALIC"
)

Enum values for FontStyle

func (FontStyle) Values added in v1.28.0

func (FontStyle) Values() []FontStyle

Values returns all known values for FontStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FontWeight added in v1.28.0

type FontWeight struct {

	// The lexical name for the level of boldness of the text display.
	Name FontWeightName
	// contains filtered or unexported fields
}

The option that determines the text display weight, or boldness.

type FontWeightName added in v1.28.0

type FontWeightName string
const (
	FontWeightNameNormal FontWeightName = "NORMAL"
	FontWeightNameBold   FontWeightName = "BOLD"
)

Enum values for FontWeightName

func (FontWeightName) Values added in v1.28.0

func (FontWeightName) Values() []FontWeightName

Values returns all known values for FontWeightName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ForecastComputation added in v1.28.0

type ForecastComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The custom seasonality value setup of a forecast computation.
	CustomSeasonalityValue *int32

	// The lower boundary setup of a forecast computation.
	LowerBoundary *float64

	// The name of a computation.
	Name *string

	// The periods backward setup of a forecast computation.
	PeriodsBackward *int32

	// The periods forward setup of a forecast computation.
	PeriodsForward *int32

	// The prediction interval setup of a forecast computation.
	PredictionInterval *int32

	// The seasonality setup of a forecast computation. Choose one of the following
	// options:
	//   - AUTOMATIC
	//   - CUSTOM : Checks the custom seasonality value.
	Seasonality ForecastComputationSeasonality

	// The time field that is used in a computation.
	Time *DimensionField

	// The upper boundary setup of a forecast computation.
	UpperBoundary *float64

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The forecast computation configuration.

type ForecastComputationSeasonality added in v1.28.0

type ForecastComputationSeasonality string
const (
	ForecastComputationSeasonalityAutomatic ForecastComputationSeasonality = "AUTOMATIC"
	ForecastComputationSeasonalityCustom    ForecastComputationSeasonality = "CUSTOM"
)

Enum values for ForecastComputationSeasonality

func (ForecastComputationSeasonality) Values added in v1.28.0

Values returns all known values for ForecastComputationSeasonality. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ForecastConfiguration added in v1.28.0

type ForecastConfiguration struct {

	// The forecast properties setup of a forecast in the line chart.
	ForecastProperties *TimeBasedForecastProperties

	// The forecast scenario of a forecast in the line chart.
	Scenario *ForecastScenario
	// contains filtered or unexported fields
}

The forecast configuration that is used in a line chart's display properties.

type ForecastScenario added in v1.28.0

type ForecastScenario struct {

	// The what-if analysis forecast setup with the target date.
	WhatIfPointScenario *WhatIfPointScenario

	// The what-if analysis forecast setup with the date range.
	WhatIfRangeScenario *WhatIfRangeScenario
	// contains filtered or unexported fields
}

The forecast scenario of a forecast in the line chart.

type FormatConfiguration added in v1.28.0

type FormatConfiguration struct {

	// Formatting configuration for DateTime fields.
	DateTimeFormatConfiguration *DateTimeFormatConfiguration

	// Formatting configuration for number fields.
	NumberFormatConfiguration *NumberFormatConfiguration

	// Formatting configuration for string fields.
	StringFormatConfiguration *StringFormatConfiguration
	// contains filtered or unexported fields
}

The formatting configuration for all types of field.

type FreeFormLayoutCanvasSizeOptions added in v1.28.0

type FreeFormLayoutCanvasSizeOptions struct {

	// The options that determine the sizing of the canvas used in a free-form layout.
	ScreenCanvasSizeOptions *FreeFormLayoutScreenCanvasSizeOptions
	// contains filtered or unexported fields
}

Configuration options for the canvas of a free-form layout.

type FreeFormLayoutConfiguration added in v1.28.0

type FreeFormLayoutConfiguration struct {

	// The elements that are included in a free-form layout.
	//
	// This member is required.
	Elements []FreeFormLayoutElement

	// Configuration options for the canvas of a free-form layout.
	CanvasSizeOptions *FreeFormLayoutCanvasSizeOptions
	// contains filtered or unexported fields
}

The configuration of a free-form layout.

type FreeFormLayoutElement added in v1.28.0

type FreeFormLayoutElement struct {

	// A unique identifier for an element within a free-form layout.
	//
	// This member is required.
	ElementId *string

	// The type of element.
	//
	// This member is required.
	ElementType LayoutElementType

	// The height of an element within a free-form layout.
	//
	// This member is required.
	Height *string

	// The width of an element within a free-form layout.
	//
	// This member is required.
	Width *string

	// The x-axis coordinate of the element.
	//
	// This member is required.
	XAxisLocation *string

	// The y-axis coordinate of the element.
	//
	// This member is required.
	YAxisLocation *string

	// The background style configuration of a free-form layout element.
	BackgroundStyle *FreeFormLayoutElementBackgroundStyle

	// The border style configuration of a free-form layout element.
	BorderStyle *FreeFormLayoutElementBorderStyle

	// The loading animation configuration of a free-form layout element.
	LoadingAnimation *LoadingAnimation

	// The rendering rules that determine when an element should be displayed within a
	// free-form layout.
	RenderingRules []SheetElementRenderingRule

	// The border style configuration of a free-form layout element. This border style
	// is used when the element is selected.
	SelectedBorderStyle *FreeFormLayoutElementBorderStyle

	// The visibility of an element within a free-form layout.
	Visibility Visibility
	// contains filtered or unexported fields
}

An element within a free-form layout.

type FreeFormLayoutElementBackgroundStyle added in v1.28.0

type FreeFormLayoutElementBackgroundStyle struct {

	// The background color of a free-form layout element.
	Color *string

	// The background visibility of a free-form layout element.
	Visibility Visibility
	// contains filtered or unexported fields
}

The background style configuration of a free-form layout element.

type FreeFormLayoutElementBorderStyle added in v1.28.0

type FreeFormLayoutElementBorderStyle struct {

	// The border color of a free-form layout element.
	Color *string

	// The border visibility of a free-form layout element.
	Visibility Visibility
	// contains filtered or unexported fields
}

The background style configuration of a free-form layout element.

type FreeFormLayoutScreenCanvasSizeOptions added in v1.28.0

type FreeFormLayoutScreenCanvasSizeOptions struct {

	// The width that the view port will be optimized for when the layout renders.
	//
	// This member is required.
	OptimizedViewPortWidth *string
	// contains filtered or unexported fields
}

The options that determine the sizing of the canvas used in a free-form layout.

type FreeFormSectionLayoutConfiguration added in v1.28.0

type FreeFormSectionLayoutConfiguration struct {

	// The elements that are included in the free-form layout.
	//
	// This member is required.
	Elements []FreeFormLayoutElement
	// contains filtered or unexported fields
}

The free-form layout configuration of a section.

type FunnelChartAggregatedFieldWells added in v1.28.0

type FunnelChartAggregatedFieldWells struct {

	// The category field wells of a funnel chart. Values are grouped by category
	// fields.
	Category []DimensionField

	// The value field wells of a funnel chart. Values are aggregated based on
	// categories.
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a FunnelChartVisual .

type FunnelChartConfiguration added in v1.28.0

type FunnelChartConfiguration struct {

	// The label options of the categories that are displayed in a FunnelChartVisual .
	CategoryLabelOptions *ChartAxisLabelOptions

	// The options that determine the presentation of the data labels.
	DataLabelOptions *FunnelChartDataLabelOptions

	// The field well configuration of a FunnelChartVisual .
	FieldWells *FunnelChartFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The sort configuration of a FunnelChartVisual .
	SortConfiguration *FunnelChartSortConfiguration

	// The tooltip configuration of a FunnelChartVisual .
	Tooltip *TooltipOptions

	// The label options for the values that are displayed in a FunnelChartVisual .
	ValueLabelOptions *ChartAxisLabelOptions

	// The visual palette configuration of a FunnelChartVisual .
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a FunnelChartVisual .

type FunnelChartDataLabelOptions added in v1.28.0

type FunnelChartDataLabelOptions struct {

	// The visibility of the category labels within the data labels.
	CategoryLabelVisibility Visibility

	// The color of the data label text.
	LabelColor *string

	// The font configuration for the data labels. Only the FontSize attribute of the
	// font configuration is used for data labels.
	LabelFontConfiguration *FontConfiguration

	// Determines the style of the metric labels.
	MeasureDataLabelStyle FunnelChartMeasureDataLabelStyle

	// The visibility of the measure labels within the data labels.
	MeasureLabelVisibility Visibility

	// Determines the positioning of the data label relative to a section of the
	// funnel.
	Position DataLabelPosition

	// The visibility option that determines if data labels are displayed.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the presentation of the data labels.

type FunnelChartFieldWells added in v1.28.0

type FunnelChartFieldWells struct {

	// The field well configuration of a FunnelChartVisual .
	FunnelChartAggregatedFieldWells *FunnelChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a FunnelChartVisual . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type FunnelChartMeasureDataLabelStyle added in v1.28.0

type FunnelChartMeasureDataLabelStyle string
const (
	FunnelChartMeasureDataLabelStyleValueOnly                         FunnelChartMeasureDataLabelStyle = "VALUE_ONLY"
	FunnelChartMeasureDataLabelStylePercentageByFirstStage            FunnelChartMeasureDataLabelStyle = "PERCENTAGE_BY_FIRST_STAGE"
	FunnelChartMeasureDataLabelStylePercentageByPreviousStage         FunnelChartMeasureDataLabelStyle = "PERCENTAGE_BY_PREVIOUS_STAGE"
	FunnelChartMeasureDataLabelStyleValueAndPercentageByFirstStage    FunnelChartMeasureDataLabelStyle = "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE"
	FunnelChartMeasureDataLabelStyleValueAndPercentageByPreviousStage FunnelChartMeasureDataLabelStyle = "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE"
)

Enum values for FunnelChartMeasureDataLabelStyle

func (FunnelChartMeasureDataLabelStyle) Values added in v1.28.0

Values returns all known values for FunnelChartMeasureDataLabelStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FunnelChartSortConfiguration added in v1.28.0

type FunnelChartSortConfiguration struct {

	// The limit on the number of categories displayed.
	CategoryItemsLimit *ItemsLimitConfiguration

	// The sort configuration of the category fields.
	CategorySort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a FunnelChartVisual .

type FunnelChartVisual added in v1.28.0

type FunnelChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a FunnelChartVisual .
	ChartConfiguration *FunnelChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A funnel chart. For more information, see Using funnel charts (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the Amazon QuickSight User Guide.

type GaugeChartArcConditionalFormatting added in v1.28.0

type GaugeChartArcConditionalFormatting struct {

	// The conditional formatting of the arc foreground color.
	ForegroundColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The options that determine the presentation of the arc of a GaugeChartVisual .

type GaugeChartConditionalFormatting added in v1.28.0

type GaugeChartConditionalFormatting struct {

	// Conditional formatting options of a GaugeChartVisual .
	ConditionalFormattingOptions []GaugeChartConditionalFormattingOption
	// contains filtered or unexported fields
}

The conditional formatting of a GaugeChartVisual .

type GaugeChartConditionalFormattingOption added in v1.28.0

type GaugeChartConditionalFormattingOption struct {

	// The options that determine the presentation of the arc of a GaugeChartVisual .
	Arc *GaugeChartArcConditionalFormatting

	// The conditional formatting for the primary value of a GaugeChartVisual .
	PrimaryValue *GaugeChartPrimaryValueConditionalFormatting
	// contains filtered or unexported fields
}

Conditional formatting options of a GaugeChartVisual .

type GaugeChartConfiguration added in v1.28.0

type GaugeChartConfiguration struct {

	// The data label configuration of a GaugeChartVisual .
	DataLabels *DataLabelOptions

	// The field well configuration of a GaugeChartVisual .
	FieldWells *GaugeChartFieldWells

	// The options that determine the presentation of the GaugeChartVisual .
	GaugeChartOptions *GaugeChartOptions

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The tooltip configuration of a GaugeChartVisual .
	TooltipOptions *TooltipOptions

	// The visual palette configuration of a GaugeChartVisual .
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a GaugeChartVisual .

type GaugeChartFieldWells added in v1.28.0

type GaugeChartFieldWells struct {

	// The target value field wells of a GaugeChartVisual .
	TargetValues []MeasureField

	// The value field wells of a GaugeChartVisual .
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a GaugeChartVisual .

type GaugeChartOptions added in v1.28.0

type GaugeChartOptions struct {

	// The arc configuration of a GaugeChartVisual .
	Arc *ArcConfiguration

	// The arc axis configuration of a GaugeChartVisual .
	ArcAxis *ArcAxisConfiguration

	// The comparison configuration of a GaugeChartVisual .
	Comparison *ComparisonConfiguration

	// The options that determine the primary value display type.
	PrimaryValueDisplayType PrimaryValueDisplayType

	// The options that determine the primary value font configuration.
	PrimaryValueFontConfiguration *FontConfiguration
	// contains filtered or unexported fields
}

The options that determine the presentation of the GaugeChartVisual .

type GaugeChartPrimaryValueConditionalFormatting added in v1.28.0

type GaugeChartPrimaryValueConditionalFormatting struct {

	// The conditional formatting of the primary value icon.
	Icon *ConditionalFormattingIcon

	// The conditional formatting of the primary value text color.
	TextColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting for the primary value of a GaugeChartVisual .

type GaugeChartVisual added in v1.28.0

type GaugeChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a GaugeChartVisual .
	ChartConfiguration *GaugeChartConfiguration

	// The conditional formatting of a GaugeChartVisual .
	ConditionalFormatting *GaugeChartConditionalFormatting

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A gauge chart. For more information, see Using gauge charts (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the Amazon QuickSight User Guide.

type GeoSpatialColumnGroup

type GeoSpatialColumnGroup struct {

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

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

	// Country code.
	CountryCode GeoSpatialCountryCode
	// contains filtered or unexported fields
}

Geospatial column group that denotes a hierarchy.

type GeoSpatialCountryCode

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

Enum values for GeoSpatialCountryCode

func (GeoSpatialCountryCode) Values added in v0.29.0

Values returns all known values for GeoSpatialCountryCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

func (GeoSpatialDataRole) Values added in v0.29.0

Values returns all known values for GeoSpatialDataRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GeospatialCoordinateBounds added in v1.28.0

type GeospatialCoordinateBounds struct {

	// The longitude of the east bound of the geospatial coordinate bounds.
	//
	// This member is required.
	East *float64

	// The latitude of the north bound of the geospatial coordinate bounds.
	//
	// This member is required.
	North *float64

	// The latitude of the south bound of the geospatial coordinate bounds.
	//
	// This member is required.
	South *float64

	// The longitude of the west bound of the geospatial coordinate bounds.
	//
	// This member is required.
	West *float64
	// contains filtered or unexported fields
}

The bound options (north, south, west, east) of the geospatial window options.

type GeospatialHeatmapColorScale added in v1.36.0

type GeospatialHeatmapColorScale struct {

	// The list of colors to be used in heatmap point style.
	Colors []GeospatialHeatmapDataColor
	// contains filtered or unexported fields
}

The color scale specification for the heatmap point style.

type GeospatialHeatmapConfiguration added in v1.36.0

type GeospatialHeatmapConfiguration struct {

	// The color scale specification for the heatmap point style.
	HeatmapColor *GeospatialHeatmapColorScale
	// contains filtered or unexported fields
}

The heatmap configuration of the geospatial point style.

type GeospatialHeatmapDataColor added in v1.36.0

type GeospatialHeatmapDataColor struct {

	// The hex color to be used in the heatmap point style.
	//
	// This member is required.
	Color *string
	// contains filtered or unexported fields
}

The color to be used in the heatmap point style.

type GeospatialMapAggregatedFieldWells added in v1.28.0

type GeospatialMapAggregatedFieldWells struct {

	// The color field wells of a geospatial map.
	Colors []DimensionField

	// The geospatial field wells of a geospatial map. Values are grouped by
	// geospatial fields.
	Geospatial []DimensionField

	// The size field wells of a geospatial map. Values are aggregated based on
	// geospatial fields.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field wells for a geospatial map.

type GeospatialMapConfiguration added in v1.28.0

type GeospatialMapConfiguration struct {

	// The field wells of the visual.
	FieldWells *GeospatialMapFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The map style options of the geospatial map.
	MapStyleOptions *GeospatialMapStyleOptions

	// The point style options of the geospatial map.
	PointStyleOptions *GeospatialPointStyleOptions

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions

	// The visual display options for the visual palette.
	VisualPalette *VisualPalette

	// The window options of the geospatial map.
	WindowOptions *GeospatialWindowOptions
	// contains filtered or unexported fields
}

The configuration of a GeospatialMapVisual .

type GeospatialMapFieldWells added in v1.28.0

type GeospatialMapFieldWells struct {

	// The aggregated field well for a geospatial map.
	GeospatialMapAggregatedFieldWells *GeospatialMapAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a GeospatialMapVisual . This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type GeospatialMapStyleOptions added in v1.28.0

type GeospatialMapStyleOptions struct {

	// The base map style of the geospatial map.
	BaseMapStyle BaseMapStyleType
	// contains filtered or unexported fields
}

The map style options of the geospatial map.

type GeospatialMapVisual added in v1.28.0

type GeospatialMapVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *GeospatialMapConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A geospatial map or a points on map visual. For more information, see Creating point maps (https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the Amazon QuickSight User Guide.

type GeospatialPointStyleOptions added in v1.28.0

type GeospatialPointStyleOptions struct {

	// The cluster marker configuration of the geospatial point style.
	ClusterMarkerConfiguration *ClusterMarkerConfiguration

	// The heatmap configuration of the geospatial point style.
	HeatmapConfiguration *GeospatialHeatmapConfiguration

	// The selected point styles (point, cluster) of the geospatial map.
	SelectedPointStyle GeospatialSelectedPointStyle
	// contains filtered or unexported fields
}

The point style of the geospatial map.

type GeospatialSelectedPointStyle added in v1.28.0

type GeospatialSelectedPointStyle string
const (
	GeospatialSelectedPointStylePoint   GeospatialSelectedPointStyle = "POINT"
	GeospatialSelectedPointStyleCluster GeospatialSelectedPointStyle = "CLUSTER"
	GeospatialSelectedPointStyleHeatmap GeospatialSelectedPointStyle = "HEATMAP"
)

Enum values for GeospatialSelectedPointStyle

func (GeospatialSelectedPointStyle) Values added in v1.28.0

Values returns all known values for GeospatialSelectedPointStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GeospatialWindowOptions added in v1.28.0

type GeospatialWindowOptions struct {

	// The bounds options (north, south, west, east) of the geospatial window options.
	Bounds *GeospatialCoordinateBounds

	// The map zoom modes (manual, auto) of the geospatial window options.
	MapZoomMode MapZoomMode
	// contains filtered or unexported fields
}

The window options of the geospatial map visual.

type GlobalTableBorderOptions added in v1.28.0

type GlobalTableBorderOptions struct {

	// Determines the options for side specific border.
	SideSpecificBorder *TableSideBorderOptions

	// Determines the options for uniform border.
	UniformBorder *TableBorderOptions
	// contains filtered or unexported fields
}

Determines the border options for a table visual.

type GradientColor added in v1.28.0

type GradientColor struct {

	// The list of gradient color stops.
	Stops []GradientStop
	// contains filtered or unexported fields
}

Determines the gradient color settings.

type GradientStop added in v1.28.0

type GradientStop struct {

	// Determines gradient offset value.
	//
	// This member is required.
	GradientOffset float64

	// Determines the color.
	Color *string

	// Determines the data value.
	DataValue *float64
	// contains filtered or unexported fields
}

Determines the gradient stop configuration.

type GridLayoutCanvasSizeOptions added in v1.28.0

type GridLayoutCanvasSizeOptions struct {

	// The options that determine the sizing of the canvas used in a grid layout.
	ScreenCanvasSizeOptions *GridLayoutScreenCanvasSizeOptions
	// contains filtered or unexported fields
}

Configuration options for the canvas of a grid layout.

type GridLayoutConfiguration added in v1.28.0

type GridLayoutConfiguration struct {

	// The elements that are included in a grid layout.
	//
	// This member is required.
	Elements []GridLayoutElement

	// Configuration options for the canvas of a grid layout.
	CanvasSizeOptions *GridLayoutCanvasSizeOptions
	// contains filtered or unexported fields
}

The configuration for a grid layout. Also called a tiled layout. Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

type GridLayoutElement added in v1.28.0

type GridLayoutElement struct {

	// The width of a grid element expressed as a number of grid columns.
	//
	// This member is required.
	ColumnSpan *int32

	// A unique identifier for an element within a grid layout.
	//
	// This member is required.
	ElementId *string

	// The type of element.
	//
	// This member is required.
	ElementType LayoutElementType

	// The height of a grid element expressed as a number of grid rows.
	//
	// This member is required.
	RowSpan *int32

	// The column index for the upper left corner of an element.
	ColumnIndex *int32

	// The row index for the upper left corner of an element.
	RowIndex *int32
	// contains filtered or unexported fields
}

An element within a grid layout.

type GridLayoutScreenCanvasSizeOptions added in v1.28.0

type GridLayoutScreenCanvasSizeOptions struct {

	// This value determines the layout behavior when the viewport is resized.
	//   - FIXED : A fixed width will be used when optimizing the layout. In the Amazon
	//   QuickSight console, this option is called Classic .
	//   - RESPONSIVE : The width of the canvas will be responsive and optimized to the
	//   view port. In the Amazon QuickSight console, this option is called Tiled .
	//
	// This member is required.
	ResizeOption ResizeOption

	// The width that the view port will be optimized for when the layout renders.
	OptimizedViewPortWidth *string
	// contains filtered or unexported fields
}

The options that determine the sizing of the canvas used in a grid layout.

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
	// contains filtered or unexported fields
}

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

type GroupFilterAttribute added in v1.21.0

type GroupFilterAttribute string
const (
	GroupFilterAttributeGroupName GroupFilterAttribute = "GROUP_NAME"
)

Enum values for GroupFilterAttribute

func (GroupFilterAttribute) Values added in v1.21.0

Values returns all known values for GroupFilterAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GroupFilterOperator added in v1.21.0

type GroupFilterOperator string
const (
	GroupFilterOperatorStartsWith GroupFilterOperator = "StartsWith"
)

Enum values for GroupFilterOperator

func (GroupFilterOperator) Values added in v1.21.0

Values returns all known values for GroupFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

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

type GroupSearchFilter added in v1.21.0

type GroupSearchFilter struct {

	// The name of the value that you want to use as a filter, for example "Name":
	// "GROUP_NAME" . Currently, the only supported name is GROUP_NAME .
	//
	// This member is required.
	Name GroupFilterAttribute

	// The comparison operator that you want to use as a filter, for example
	// "Operator": "StartsWith" . Currently, the only supported operator is StartsWith .
	//
	// This member is required.
	Operator GroupFilterOperator

	// The value of the named item, in this case GROUP_NAME , that you want to use as a
	// filter.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A GroupSearchFilter object that you want to apply to your search.

type GrowthRateComputation added in v1.28.0

type GrowthRateComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The name of a computation.
	Name *string

	// The period size setup of a growth rate computation.
	PeriodSize *int32

	// The time field that is used in a computation.
	Time *DimensionField

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The growth rate computation configuration.

type GutterStyle

type GutterStyle struct {

	// This Boolean value controls whether to display a gutter space between sheet
	// tiles.
	Show *bool
	// contains filtered or unexported fields
}

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

type HeaderFooterSectionConfiguration added in v1.28.0

type HeaderFooterSectionConfiguration struct {

	// The layout configuration of the header or footer section.
	//
	// This member is required.
	Layout *SectionLayoutConfiguration

	// The unique identifier of the header or footer section.
	//
	// This member is required.
	SectionId *string

	// The style options of a header or footer section.
	Style *SectionStyle
	// contains filtered or unexported fields
}

The configuration of a header or footer section.

type HeatMapAggregatedFieldWells added in v1.28.0

type HeatMapAggregatedFieldWells struct {

	// The columns field well of a heat map.
	Columns []DimensionField

	// The rows field well of a heat map.
	Rows []DimensionField

	// The values field well of a heat map.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field wells of a heat map.

type HeatMapConfiguration added in v1.28.0

type HeatMapConfiguration struct {

	// The color options (gradient color, point of divergence) in a heat map.
	ColorScale *ColorScale

	// The label options of the column that is displayed in a heat map.
	ColumnLabelOptions *ChartAxisLabelOptions

	// The options that determine if visual data labels are displayed.
	DataLabels *DataLabelOptions

	// The field wells of the visual.
	FieldWells *HeatMapFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The label options of the row that is displayed in a heat map .
	RowLabelOptions *ChartAxisLabelOptions

	// The sort configuration of a heat map.
	SortConfiguration *HeatMapSortConfiguration

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions
	// contains filtered or unexported fields
}

The configuration of a heat map.

type HeatMapFieldWells added in v1.28.0

type HeatMapFieldWells struct {

	// The aggregated field wells of a heat map.
	HeatMapAggregatedFieldWells *HeatMapAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a heat map. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type HeatMapSortConfiguration added in v1.28.0

type HeatMapSortConfiguration struct {

	// The limit on the number of columns that are displayed in a heat map.
	HeatMapColumnItemsLimitConfiguration *ItemsLimitConfiguration

	// The column sort configuration for heat map for columns that aren't a part of a
	// field well.
	HeatMapColumnSort []FieldSortOptions

	// The limit on the number of rows that are displayed in a heat map.
	HeatMapRowItemsLimitConfiguration *ItemsLimitConfiguration

	// The field sort configuration of the rows fields.
	HeatMapRowSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a heat map.

type HeatMapVisual added in v1.28.0

type HeatMapVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a heat map.
	ChartConfiguration *HeatMapConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A heat map. For more information, see Using heat maps (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the Amazon QuickSight User Guide.

type HistogramAggregatedFieldWells added in v1.28.0

type HistogramAggregatedFieldWells struct {

	// The value field wells of a histogram. Values are aggregated by COUNT or
	// DISTINCT_COUNT .
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a histogram.

type HistogramBinOptions added in v1.28.0

type HistogramBinOptions struct {

	// The options that determine the bin count of a histogram.
	BinCount *BinCountOptions

	// The options that determine the bin width of a histogram.
	BinWidth *BinWidthOptions

	// The options that determine the selected bin type.
	SelectedBinType HistogramBinType

	// The options that determine the bin start value.
	StartValue *float64
	// contains filtered or unexported fields
}

The options that determine the presentation of histogram bins.

type HistogramBinType added in v1.28.0

type HistogramBinType string
const (
	HistogramBinTypeBinCount HistogramBinType = "BIN_COUNT"
	HistogramBinTypeBinWidth HistogramBinType = "BIN_WIDTH"
)

Enum values for HistogramBinType

func (HistogramBinType) Values added in v1.28.0

Values returns all known values for HistogramBinType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type HistogramConfiguration added in v1.28.0

type HistogramConfiguration struct {

	// The options that determine the presentation of histogram bins.
	BinOptions *HistogramBinOptions

	// The data label configuration of a histogram.
	DataLabels *DataLabelOptions

	// The field well configuration of a histogram.
	FieldWells *HistogramFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The tooltip configuration of a histogram.
	Tooltip *TooltipOptions

	// The visual palette configuration of a histogram.
	VisualPalette *VisualPalette

	// The options that determine the presentation of the x-axis.
	XAxisDisplayOptions *AxisDisplayOptions

	// The options that determine the presentation of the x-axis label.
	XAxisLabelOptions *ChartAxisLabelOptions

	// The options that determine the presentation of the y-axis.
	YAxisDisplayOptions *AxisDisplayOptions
	// contains filtered or unexported fields
}

The configuration for a HistogramVisual .

type HistogramFieldWells added in v1.28.0

type HistogramFieldWells struct {

	// The field well configuration of a histogram.
	HistogramAggregatedFieldWells *HistogramAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a histogram.

type HistogramVisual added in v1.28.0

type HistogramVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration for a HistogramVisual .
	ChartConfiguration *HistogramConfiguration

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A histogram. For more information, see Using histograms (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the Amazon QuickSight User Guide.

type HorizontalTextAlignment added in v1.28.0

type HorizontalTextAlignment string
const (
	HorizontalTextAlignmentLeft   HorizontalTextAlignment = "LEFT"
	HorizontalTextAlignmentCenter HorizontalTextAlignment = "CENTER"
	HorizontalTextAlignmentRight  HorizontalTextAlignment = "RIGHT"
	HorizontalTextAlignmentAuto   HorizontalTextAlignment = "AUTO"
)

Enum values for HorizontalTextAlignment

func (HorizontalTextAlignment) Values added in v1.28.0

Values returns all known values for HorizontalTextAlignment. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IAMPolicyAssignment

type IAMPolicyAssignment struct {

	// Assignment ID.
	AssignmentId *string

	// Assignment name.
	AssignmentName *string

	// Assignment status.
	AssignmentStatus AssignmentStatus

	// The Amazon Web Services account ID.
	AwsAccountId *string

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

	// The Amazon Resource Name (ARN) for the IAM policy.
	PolicyArn *string
	// contains filtered or unexported fields
}

An Identity and Access Management (IAM) policy assignment.

type IAMPolicyAssignmentSummary

type IAMPolicyAssignmentSummary struct {

	// Assignment name.
	AssignmentName *string

	// Assignment status.
	AssignmentStatus AssignmentStatus
	// contains filtered or unexported fields
}

IAM policy assignment summary.

type Icon added in v1.28.0

type Icon string
const (
	IconCaretUp        Icon = "CARET_UP"
	IconCaretDown      Icon = "CARET_DOWN"
	IconPlus           Icon = "PLUS"
	IconMinus          Icon = "MINUS"
	IconArrowUp        Icon = "ARROW_UP"
	IconArrowDown      Icon = "ARROW_DOWN"
	IconArrowLeft      Icon = "ARROW_LEFT"
	IconArrowUpLeft    Icon = "ARROW_UP_LEFT"
	IconArrowDownLeft  Icon = "ARROW_DOWN_LEFT"
	IconArrowRight     Icon = "ARROW_RIGHT"
	IconArrowUpRight   Icon = "ARROW_UP_RIGHT"
	IconArrowDownRight Icon = "ARROW_DOWN_RIGHT"
	IconFaceUp         Icon = "FACE_UP"
	IconFaceDown       Icon = "FACE_DOWN"
	IconFaceFlat       Icon = "FACE_FLAT"
	IconOneBar         Icon = "ONE_BAR"
	IconTwoBar         Icon = "TWO_BAR"
	IconThreeBar       Icon = "THREE_BAR"
	IconCircle         Icon = "CIRCLE"
	IconTriangle       Icon = "TRIANGLE"
	IconSquare         Icon = "SQUARE"
	IconFlag           Icon = "FLAG"
	IconThumbsUp       Icon = "THUMBS_UP"
	IconThumbsDown     Icon = "THUMBS_DOWN"
	IconCheckmark      Icon = "CHECKMARK"
	IconX              Icon = "X"
)

Enum values for Icon

func (Icon) Values added in v1.28.0

func (Icon) Values() []Icon

Values returns all known values for Icon. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IdentityCenterConfiguration added in v1.52.0

type IdentityCenterConfiguration struct {

	// A Boolean option that controls whether Trusted Identity Propagation should be
	// used.
	EnableIdentityPropagation *bool
	// contains filtered or unexported fields
}

The parameters for an IAM Identity Center configuration.

type IdentityStore

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

Enum values for IdentityStore

func (IdentityStore) Values added in v0.29.0

func (IdentityStore) Values() []IdentityStore

Values returns all known values for IdentityStore. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IdentityType

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

Enum values for IdentityType

func (IdentityType) Values added in v0.29.0

func (IdentityType) Values() []IdentityType

Values returns all known values for IdentityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IdentityTypeNotSupportedException

type IdentityTypeNotSupportedException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 IncrementalRefresh added in v1.34.0

type IncrementalRefresh struct {

	// The lookback window setup for an incremental refresh configuration.
	//
	// This member is required.
	LookbackWindow *LookbackWindow
	// contains filtered or unexported fields
}

The incremental refresh configuration for a dataset.

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
	// contains filtered or unexported fields
}

Information about the SPICE ingestion for a dataset.

type IngestionErrorType

type IngestionErrorType string
const (
	IngestionErrorTypeFailureToAssumeRole             IngestionErrorType = "FAILURE_TO_ASSUME_ROLE"
	IngestionErrorTypeIngestionSuperseded             IngestionErrorType = "INGESTION_SUPERSEDED"
	IngestionErrorTypeIngestionCanceled               IngestionErrorType = "INGESTION_CANCELED"
	IngestionErrorTypeDataSetDeleted                  IngestionErrorType = "DATA_SET_DELETED"
	IngestionErrorTypeDataSetNotSpice                 IngestionErrorType = "DATA_SET_NOT_SPICE"
	IngestionErrorTypeS3UploadedFileDeleted           IngestionErrorType = "S3_UPLOADED_FILE_DELETED"
	IngestionErrorTypeS3ManifestError                 IngestionErrorType = "S3_MANIFEST_ERROR"
	IngestionErrorTypeDataToleranceException          IngestionErrorType = "DATA_TOLERANCE_EXCEPTION"
	IngestionErrorTypeSpiceTableNotFound              IngestionErrorType = "SPICE_TABLE_NOT_FOUND"
	IngestionErrorTypeDataSetSizeLimitExceeded        IngestionErrorType = "DATA_SET_SIZE_LIMIT_EXCEEDED"
	IngestionErrorTypeRowSizeLimitExceeded            IngestionErrorType = "ROW_SIZE_LIMIT_EXCEEDED"
	IngestionErrorTypeAccountCapacityLimitExceeded    IngestionErrorType = "ACCOUNT_CAPACITY_LIMIT_EXCEEDED"
	IngestionErrorTypeCustomerError                   IngestionErrorType = "CUSTOMER_ERROR"
	IngestionErrorTypeDataSourceNotFound              IngestionErrorType = "DATA_SOURCE_NOT_FOUND"
	IngestionErrorTypeIamRoleNotAvailable             IngestionErrorType = "IAM_ROLE_NOT_AVAILABLE"
	IngestionErrorTypeConnectionFailure               IngestionErrorType = "CONNECTION_FAILURE"
	IngestionErrorTypeSqlTableNotFound                IngestionErrorType = "SQL_TABLE_NOT_FOUND"
	IngestionErrorTypePermissionDenied                IngestionErrorType = "PERMISSION_DENIED"
	IngestionErrorTypeSslCertificateValidationFailure IngestionErrorType = "SSL_CERTIFICATE_VALIDATION_FAILURE"
	IngestionErrorTypeOauthTokenFailure               IngestionErrorType = "OAUTH_TOKEN_FAILURE"
	IngestionErrorTypeSourceApiLimitExceededFailure   IngestionErrorType = "SOURCE_API_LIMIT_EXCEEDED_FAILURE"
	IngestionErrorTypePasswordAuthenticationFailure   IngestionErrorType = "PASSWORD_AUTHENTICATION_FAILURE"
	IngestionErrorTypeSqlSchemaMismatchError          IngestionErrorType = "SQL_SCHEMA_MISMATCH_ERROR"
	IngestionErrorTypeInvalidDateFormat               IngestionErrorType = "INVALID_DATE_FORMAT"
	IngestionErrorTypeInvalidDataprepSyntax           IngestionErrorType = "INVALID_DATAPREP_SYNTAX"
	IngestionErrorTypeSourceResourceLimitExceeded     IngestionErrorType = "SOURCE_RESOURCE_LIMIT_EXCEEDED"
	IngestionErrorTypeSqlInvalidParameterValue        IngestionErrorType = "SQL_INVALID_PARAMETER_VALUE"
	IngestionErrorTypeQueryTimeout                    IngestionErrorType = "QUERY_TIMEOUT"
	IngestionErrorTypeSqlNumericOverflow              IngestionErrorType = "SQL_NUMERIC_OVERFLOW"
	IngestionErrorTypeUnresolvableHost                IngestionErrorType = "UNRESOLVABLE_HOST"
	IngestionErrorTypeUnroutableHost                  IngestionErrorType = "UNROUTABLE_HOST"
	IngestionErrorTypeSqlException                    IngestionErrorType = "SQL_EXCEPTION"
	IngestionErrorTypeS3FileInaccessible              IngestionErrorType = "S3_FILE_INACCESSIBLE"
	IngestionErrorTypeIotFileNotFound                 IngestionErrorType = "IOT_FILE_NOT_FOUND"
	IngestionErrorTypeIotDataSetFileEmpty             IngestionErrorType = "IOT_DATA_SET_FILE_EMPTY"
	IngestionErrorTypeInvalidDataSourceConfig         IngestionErrorType = "INVALID_DATA_SOURCE_CONFIG"
	IngestionErrorTypeDataSourceAuthFailed            IngestionErrorType = "DATA_SOURCE_AUTH_FAILED"
	IngestionErrorTypeDataSourceConnectionFailed      IngestionErrorType = "DATA_SOURCE_CONNECTION_FAILED"
	IngestionErrorTypeFailureToProcessJsonFile        IngestionErrorType = "FAILURE_TO_PROCESS_JSON_FILE"
	IngestionErrorTypeInternalServiceError            IngestionErrorType = "INTERNAL_SERVICE_ERROR"
	IngestionErrorTypeRefreshSuppressedByEdit         IngestionErrorType = "REFRESH_SUPPRESSED_BY_EDIT"
	IngestionErrorTypePermissionNotFound              IngestionErrorType = "PERMISSION_NOT_FOUND"
	IngestionErrorTypeElasticsearchCursorNotEnabled   IngestionErrorType = "ELASTICSEARCH_CURSOR_NOT_ENABLED"
	IngestionErrorTypeCursorNotEnabled                IngestionErrorType = "CURSOR_NOT_ENABLED"
	IngestionErrorTypeDuplicateColumnNamesFound       IngestionErrorType = "DUPLICATE_COLUMN_NAMES_FOUND"
)

Enum values for IngestionErrorType

func (IngestionErrorType) Values added in v0.29.0

Values returns all known values for IngestionErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IngestionRequestSource

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

Enum values for IngestionRequestSource

func (IngestionRequestSource) Values added in v0.29.0

Values returns all known values for IngestionRequestSource. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IngestionRequestType

type IngestionRequestType string
const (
	IngestionRequestTypeInitialIngestion   IngestionRequestType = "INITIAL_INGESTION"
	IngestionRequestTypeEdit               IngestionRequestType = "EDIT"
	IngestionRequestTypeIncrementalRefresh IngestionRequestType = "INCREMENTAL_REFRESH"
	IngestionRequestTypeFullRefresh        IngestionRequestType = "FULL_REFRESH"
)

Enum values for IngestionRequestType

func (IngestionRequestType) Values added in v0.29.0

Values returns all known values for IngestionRequestType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

func (IngestionStatus) Values added in v0.29.0

func (IngestionStatus) Values() []IngestionStatus

Values returns all known values for IngestionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IngestionType added in v1.13.0

type IngestionType string
const (
	IngestionTypeIncrementalRefresh IngestionType = "INCREMENTAL_REFRESH"
	IngestionTypeFullRefresh        IngestionType = "FULL_REFRESH"
)

Enum values for IngestionType

func (IngestionType) Values added in v1.13.0

func (IngestionType) Values() []IngestionType

Values returns all known values for IngestionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

	// The sub data type of the column. Sub types are only available for decimal
	// columns that are part of a SPICE dataset.
	SubType ColumnDataSubType
	// contains filtered or unexported fields
}

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

func (InputColumnDataType) Values added in v0.29.0

Values returns all known values for InputColumnDataType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InsightConfiguration added in v1.28.0

type InsightConfiguration struct {

	// The computations configurations of the insight visual
	Computations []Computation

	// The custom narrative of the insight visual.
	CustomNarrative *CustomNarrativeOptions

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions
	// contains filtered or unexported fields
}

The configuration of an insight visual.

type InsightVisual added in v1.28.0

type InsightVisual struct {

	// The dataset that is used in the insight visual.
	//
	// This member is required.
	DataSetIdentifier *string

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of an insight visual.
	InsightConfiguration *InsightConfiguration

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

An insight visual. For more information, see Working with insights (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the Amazon QuickSight User Guide.

type IntegerDatasetParameter added in v1.35.0

type IntegerDatasetParameter struct {

	// An identifier for the integer parameter created in the dataset.
	//
	// This member is required.
	Id *string

	// The name of the integer parameter that is created in the dataset.
	//
	// This member is required.
	Name *string

	// The value type of the dataset parameter. Valid values are single value or multi
	// value .
	//
	// This member is required.
	ValueType DatasetParameterValueType

	// A list of default values for a given integer parameter. This structure only
	// accepts static values.
	DefaultValues *IntegerDatasetParameterDefaultValues
	// contains filtered or unexported fields
}

An integer parameter for a dataset.

type IntegerDatasetParameterDefaultValues added in v1.35.0

type IntegerDatasetParameterDefaultValues struct {

	// A list of static default values for a given integer parameter.
	StaticValues []int64
	// contains filtered or unexported fields
}

The default values of an integer parameter.

type IntegerDefaultValues added in v1.28.0

type IntegerDefaultValues struct {

	// The dynamic value of the IntegerDefaultValues . Different defaults are displayed
	// according to users, groups, and values mapping.
	DynamicValue *DynamicDefaultValue

	// The static values of the IntegerDefaultValues .
	StaticValues []int64
	// contains filtered or unexported fields
}

The default values of the IntegerParameterDeclaration .

type IntegerParameter

type IntegerParameter struct {

	// The name of the integer parameter.
	//
	// This member is required.
	Name *string

	// The values for the integer parameter.
	//
	// This member is required.
	Values []int64
	// contains filtered or unexported fields
}

An integer parameter.

type IntegerParameterDeclaration added in v1.28.0

type IntegerParameterDeclaration struct {

	// The name of the parameter that is being declared.
	//
	// This member is required.
	Name *string

	// The value type determines whether the parameter is a single-value or
	// multi-value parameter.
	//
	// This member is required.
	ParameterValueType ParameterValueType

	// The default values of a parameter. If the parameter is a single-value
	// parameter, a maximum of one default value can be provided.
	DefaultValues *IntegerDefaultValues

	// A list of dataset parameters that are mapped to an analysis parameter.
	MappedDataSetParameters []MappedDataSetParameter

	// A parameter declaration for the Integer data type.
	ValueWhenUnset *IntegerValueWhenUnsetConfiguration
	// contains filtered or unexported fields
}

A parameter declaration for the Integer data type.

type IntegerValueWhenUnsetConfiguration added in v1.28.0

type IntegerValueWhenUnsetConfiguration struct {

	// A custom value that's used when the value of a parameter isn't set.
	CustomValue *int64

	// The built-in options for default values. The value can be one of the following:
	//   - RECOMMENDED : The recommended value.
	//   - NULL : The NULL value.
	ValueWhenUnsetOption ValueWhenUnsetOption
	// contains filtered or unexported fields
}

A parameter declaration for the Integer data type. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type InternalFailureException

type InternalFailureException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 InvalidRequestException added in v1.27.0

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

func (*InvalidRequestException) Error added in v1.27.0

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode added in v1.27.0

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault added in v1.27.0

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

func (*InvalidRequestException) ErrorMessage added in v1.27.0

func (e *InvalidRequestException) ErrorMessage() string

type ItemsLimitConfiguration added in v1.28.0

type ItemsLimitConfiguration struct {

	// The limit on how many items of a field are showed in the chart. For example,
	// the number of slices that are displayed in a pie chart.
	ItemsLimit *int64

	// The Show other of an axis in the chart. Choose one of the following options:
	//   - INCLUDE
	//   - EXCLUDE
	OtherCategories OtherCategories
	// contains filtered or unexported fields
}

The limit configuration of the visual display for an axis.

type JiraParameters

type JiraParameters struct {

	// The base URL of the Jira site.
	//
	// This member is required.
	SiteBaseUrl *string
	// contains filtered or unexported fields
}

The parameters for Jira.

type JoinInstruction

type JoinInstruction struct {

	// The operand on the left side of a join.
	//
	// This member is required.
	LeftOperand *string

	// The join instructions provided in the ON clause of a join.
	//
	// This member is required.
	OnClause *string

	// The operand on the right side of a join.
	//
	// This member is required.
	RightOperand *string

	// The type of join that it is.
	//
	// This member is required.
	Type JoinType

	// Join key properties of the left operand.
	LeftJoinKeyProperties *JoinKeyProperties

	// Join key properties of the right operand.
	RightJoinKeyProperties *JoinKeyProperties
	// contains filtered or unexported fields
}

The instructions associated with a join.

type JoinKeyProperties added in v0.31.0

type JoinKeyProperties struct {

	// A value that indicates that a row in a table is uniquely identified by the
	// columns in a join key. This is used by Amazon QuickSight to optimize query
	// performance.
	UniqueKey *bool
	// contains filtered or unexported fields
}

Properties associated with the columns participating in a join.

type JoinType

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

Enum values for JoinType

func (JoinType) Values added in v0.29.0

func (JoinType) Values() []JoinType

Values returns all known values for JoinType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type KPIActualValueConditionalFormatting added in v1.43.0

type KPIActualValueConditionalFormatting struct {

	// The conditional formatting of the actual value's icon.
	Icon *ConditionalFormattingIcon

	// The conditional formatting of the actual value's text color.
	TextColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting for the actual value of a KPI visual.

type KPIComparisonValueConditionalFormatting added in v1.43.0

type KPIComparisonValueConditionalFormatting struct {

	// The conditional formatting of the comparison value's icon.
	Icon *ConditionalFormattingIcon

	// The conditional formatting of the comparison value's text color.
	TextColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting for the comparison value of a KPI visual.

type KPIConditionalFormatting added in v1.28.0

type KPIConditionalFormatting struct {

	// The conditional formatting options of a KPI visual.
	ConditionalFormattingOptions []KPIConditionalFormattingOption
	// contains filtered or unexported fields
}

The conditional formatting of a KPI visual.

type KPIConditionalFormattingOption added in v1.28.0

type KPIConditionalFormattingOption struct {

	// The conditional formatting for the actual value of a KPI visual.
	ActualValue *KPIActualValueConditionalFormatting

	// The conditional formatting for the comparison value of a KPI visual.
	ComparisonValue *KPIComparisonValueConditionalFormatting

	// The conditional formatting for the primary value of a KPI visual.
	PrimaryValue *KPIPrimaryValueConditionalFormatting

	// The conditional formatting for the progress bar of a KPI visual.
	ProgressBar *KPIProgressBarConditionalFormatting
	// contains filtered or unexported fields
}

The conditional formatting options of a KPI visual.

type KPIConfiguration added in v1.28.0

type KPIConfiguration struct {

	// The field well configuration of a KPI visual.
	FieldWells *KPIFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The options that determine the presentation of a KPI visual.
	KPIOptions *KPIOptions

	// The sort configuration of a KPI visual.
	SortConfiguration *KPISortConfiguration
	// contains filtered or unexported fields
}

The configuration of a KPI visual.

type KPIFieldWells added in v1.28.0

type KPIFieldWells struct {

	// The target value field wells of a KPI visual.
	TargetValues []MeasureField

	// The trend group field wells of a KPI visual.
	TrendGroups []DimensionField

	// The value field wells of a KPI visual.
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a KPI visual.

type KPIOptions added in v1.28.0

type KPIOptions struct {

	// The comparison configuration of a KPI visual.
	Comparison *ComparisonConfiguration

	// The options that determine the primary value display type.
	PrimaryValueDisplayType PrimaryValueDisplayType

	// The options that determine the primary value font configuration.
	PrimaryValueFontConfiguration *FontConfiguration

	// The options that determine the presentation of the progress bar of a KPI visual.
	ProgressBar *ProgressBarOptions

	// The options that determine the presentation of the secondary value of a KPI
	// visual.
	SecondaryValue *SecondaryValueOptions

	// The options that determine the secondary value font configuration.
	SecondaryValueFontConfiguration *FontConfiguration

	// The options that determine the visibility, color, type, and tooltip visibility
	// of the sparkline of a KPI visual.
	Sparkline *KPISparklineOptions

	// The options that determine the presentation of trend arrows in a KPI visual.
	TrendArrows *TrendArrowOptions

	// The options that determine the layout a KPI visual.
	VisualLayoutOptions *KPIVisualLayoutOptions
	// contains filtered or unexported fields
}

The options that determine the presentation of a KPI visual.

type KPIPrimaryValueConditionalFormatting added in v1.28.0

type KPIPrimaryValueConditionalFormatting struct {

	// The conditional formatting of the primary value's icon.
	Icon *ConditionalFormattingIcon

	// The conditional formatting of the primary value's text color.
	TextColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting for the primary value of a KPI visual.

type KPIProgressBarConditionalFormatting added in v1.28.0

type KPIProgressBarConditionalFormatting struct {

	// The conditional formatting of the progress bar's foreground color.
	ForegroundColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting for the progress bar of a KPI visual.

type KPISortConfiguration added in v1.28.0

type KPISortConfiguration struct {

	// The sort configuration of the trend group fields.
	TrendGroupSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a KPI visual.

type KPISparklineOptions added in v1.43.0

type KPISparklineOptions struct {

	// The type of the sparkline.
	//
	// This member is required.
	Type KPISparklineType

	// The color of the sparkline.
	Color *string

	// The tooltip visibility of the sparkline.
	TooltipVisibility Visibility

	// The visibility of the sparkline.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

type KPISparklineType added in v1.43.0

type KPISparklineType string
const (
	KPISparklineTypeLine KPISparklineType = "LINE"
	KPISparklineTypeArea KPISparklineType = "AREA"
)

Enum values for KPISparklineType

func (KPISparklineType) Values added in v1.43.0

Values returns all known values for KPISparklineType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type KPIVisual added in v1.28.0

type KPIVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a KPI visual.
	ChartConfiguration *KPIConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The conditional formatting of a KPI visual.
	ConditionalFormatting *KPIConditionalFormatting

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A key performance indicator (KPI). For more information, see Using KPIs (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the Amazon QuickSight User Guide.

type KPIVisualLayoutOptions added in v1.43.0

type KPIVisualLayoutOptions struct {

	// The standard layout of the KPI visual.
	StandardLayout *KPIVisualStandardLayout
	// contains filtered or unexported fields
}

The options that determine the layout a KPI visual.

type KPIVisualStandardLayout added in v1.43.0

type KPIVisualStandardLayout struct {

	// The standard layout type.
	//
	// This member is required.
	Type KPIVisualStandardLayoutType
	// contains filtered or unexported fields
}

The standard layout of the KPI visual.

type KPIVisualStandardLayoutType added in v1.43.0

type KPIVisualStandardLayoutType string
const (
	KPIVisualStandardLayoutTypeClassic  KPIVisualStandardLayoutType = "CLASSIC"
	KPIVisualStandardLayoutTypeVertical KPIVisualStandardLayoutType = "VERTICAL"
)

Enum values for KPIVisualStandardLayoutType

func (KPIVisualStandardLayoutType) Values added in v1.43.0

Values returns all known values for KPIVisualStandardLayoutType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LabelOptions added in v1.28.0

type LabelOptions struct {

	// The text for the label.
	CustomLabel *string

	// The font configuration of the label.
	FontConfiguration *FontConfiguration

	// Determines whether or not the label is visible.
	Visibility Visibility
	// contains filtered or unexported fields
}

The share label options for the labels.

type Layout added in v1.28.0

type Layout struct {

	// The configuration that determines what the type of layout for a sheet.
	//
	// This member is required.
	Configuration *LayoutConfiguration
	// contains filtered or unexported fields
}

A Layout defines the placement of elements within a sheet. For more information, see Types of layout (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the Amazon QuickSight User Guide. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type LayoutConfiguration added in v1.28.0

type LayoutConfiguration struct {

	// A free-form is optimized for a fixed width and has more control over the exact
	// placement of layout elements.
	FreeFormLayout *FreeFormLayoutConfiguration

	// A type of layout that can be used on a sheet. In a grid layout, visuals snap to
	// a grid with standard spacing and alignment. Dashboards are displayed as
	// designed, with options to fit to screen or view at actual size. A grid layout
	// can be configured to behave in one of two ways when the viewport is resized:
	// FIXED or RESPONSIVE .
	GridLayout *GridLayoutConfiguration

	// A section based layout organizes visuals into multiple sections and has
	// customized header, footer and page break.
	SectionBasedLayout *SectionBasedLayoutConfiguration
	// contains filtered or unexported fields
}

The configuration that determines what the type of layout will be used on a sheet. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type LayoutElementType added in v1.28.0

type LayoutElementType string
const (
	LayoutElementTypeVisual           LayoutElementType = "VISUAL"
	LayoutElementTypeFilterControl    LayoutElementType = "FILTER_CONTROL"
	LayoutElementTypeParameterControl LayoutElementType = "PARAMETER_CONTROL"
	LayoutElementTypeTextBox          LayoutElementType = "TEXT_BOX"
)

Enum values for LayoutElementType

func (LayoutElementType) Values added in v1.28.0

Values returns all known values for LayoutElementType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LegendOptions added in v1.28.0

type LegendOptions struct {

	// The height of the legend. If this value is omitted, a default height is used
	// when rendering.
	Height *string

	// The positions for the legend. Choose one of the following options:
	//   - AUTO
	//   - RIGHT
	//   - BOTTOM
	//   - LEFT
	Position LegendPosition

	// The custom title for the legend.
	Title *LabelOptions

	// Determines whether or not the legend is visible.
	Visibility Visibility

	// The width of the legend. If this value is omitted, a default width is used when
	// rendering.
	Width *string
	// contains filtered or unexported fields
}

The options for the legend setup of a visual.

type LegendPosition added in v1.28.0

type LegendPosition string
const (
	LegendPositionAuto   LegendPosition = "AUTO"
	LegendPositionRight  LegendPosition = "RIGHT"
	LegendPositionBottom LegendPosition = "BOTTOM"
	LegendPositionTop    LegendPosition = "TOP"
)

Enum values for LegendPosition

func (LegendPosition) Values added in v1.28.0

func (LegendPosition) Values() []LegendPosition

Values returns all known values for LegendPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LimitExceededException

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType ExceptionResourceType
	RequestId    *string
	// contains filtered or unexported fields
}

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 LineChartAggregatedFieldWells added in v1.28.0

type LineChartAggregatedFieldWells struct {

	// The category field wells of a line chart. Values are grouped by category fields.
	Category []DimensionField

	// The color field wells of a line chart. Values are grouped by category fields.
	Colors []DimensionField

	// The small multiples field well of a line chart.
	SmallMultiples []DimensionField

	// The value field wells of a line chart. Values are aggregated based on
	// categories.
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a line chart.

type LineChartConfiguration added in v1.28.0

type LineChartConfiguration struct {

	// The default configuration of a line chart's contribution analysis.
	ContributionAnalysisDefaults []ContributionAnalysisDefault

	// The data label configuration of a line chart.
	DataLabels *DataLabelOptions

	// The options that determine the default presentation of all line series in
	// LineChartVisual .
	DefaultSeriesSettings *LineChartDefaultSeriesSettings

	// The field well configuration of a line chart.
	FieldWells *LineChartFieldWells

	// The forecast configuration of a line chart.
	ForecastConfigurations []ForecastConfiguration

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend configuration of a line chart.
	Legend *LegendOptions

	// The series axis configuration of a line chart.
	PrimaryYAxisDisplayOptions *LineSeriesAxisDisplayOptions

	// The options that determine the presentation of the y-axis label.
	PrimaryYAxisLabelOptions *ChartAxisLabelOptions

	// The reference lines configuration of a line chart.
	ReferenceLines []ReferenceLine

	// The series axis configuration of a line chart.
	SecondaryYAxisDisplayOptions *LineSeriesAxisDisplayOptions

	// The options that determine the presentation of the secondary y-axis label.
	SecondaryYAxisLabelOptions *ChartAxisLabelOptions

	// The series item configuration of a line chart.
	Series []SeriesItem

	// The settings of a chart's single axis configuration.
	SingleAxisOptions *SingleAxisOptions

	// The small multiples setup for the visual.
	SmallMultiplesOptions *SmallMultiplesOptions

	// The sort configuration of a line chart.
	SortConfiguration *LineChartSortConfiguration

	// The tooltip configuration of a line chart.
	Tooltip *TooltipOptions

	// Determines the type of the line chart.
	Type LineChartType

	// The visual palette configuration of a line chart.
	VisualPalette *VisualPalette

	// The options that determine the presentation of the x-axis.
	XAxisDisplayOptions *AxisDisplayOptions

	// The options that determine the presentation of the x-axis label.
	XAxisLabelOptions *ChartAxisLabelOptions
	// contains filtered or unexported fields
}

The configuration of a line chart.

type LineChartDefaultSeriesSettings added in v1.28.0

type LineChartDefaultSeriesSettings struct {

	// The axis to which you are binding all line series to.
	AxisBinding AxisBinding

	// Line styles options for all line series in the visual.
	LineStyleSettings *LineChartLineStyleSettings

	// Marker styles options for all line series in the visual.
	MarkerStyleSettings *LineChartMarkerStyleSettings
	// contains filtered or unexported fields
}

The options that determine the default presentation of all line series in LineChartVisual .

type LineChartFieldWells added in v1.28.0

type LineChartFieldWells struct {

	// The field well configuration of a line chart.
	LineChartAggregatedFieldWells *LineChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a line chart.

type LineChartLineStyle added in v1.28.0

type LineChartLineStyle string
const (
	LineChartLineStyleSolid  LineChartLineStyle = "SOLID"
	LineChartLineStyleDotted LineChartLineStyle = "DOTTED"
	LineChartLineStyleDashed LineChartLineStyle = "DASHED"
)

Enum values for LineChartLineStyle

func (LineChartLineStyle) Values added in v1.28.0

Values returns all known values for LineChartLineStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LineChartLineStyleSettings added in v1.28.0

type LineChartLineStyleSettings struct {

	// Interpolation style for line series.
	//   - LINEAR : Show as default, linear style.
	//   - SMOOTH : Show as a smooth curve.
	//   - STEPPED : Show steps in line.
	LineInterpolation LineInterpolation

	// Line style for line series.
	//   - SOLID : Show as a solid line.
	//   - DOTTED : Show as a dotted line.
	//   - DASHED : Show as a dashed line.
	LineStyle LineChartLineStyle

	// Configuration option that determines whether to show the line for the series.
	LineVisibility Visibility

	// Width that determines the line thickness.
	LineWidth *string
	// contains filtered or unexported fields
}

Line styles options for a line series in LineChartVisual .

type LineChartMarkerShape added in v1.28.0

type LineChartMarkerShape string
const (
	LineChartMarkerShapeCircle        LineChartMarkerShape = "CIRCLE"
	LineChartMarkerShapeTriangle      LineChartMarkerShape = "TRIANGLE"
	LineChartMarkerShapeSquare        LineChartMarkerShape = "SQUARE"
	LineChartMarkerShapeDiamond       LineChartMarkerShape = "DIAMOND"
	LineChartMarkerShapeRoundedSquare LineChartMarkerShape = "ROUNDED_SQUARE"
)

Enum values for LineChartMarkerShape

func (LineChartMarkerShape) Values added in v1.28.0

Values returns all known values for LineChartMarkerShape. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LineChartMarkerStyleSettings added in v1.28.0

type LineChartMarkerStyleSettings struct {

	// Color of marker in the series.
	MarkerColor *string

	// Shape option for markers in the series.
	//   - CIRCLE : Show marker as a circle.
	//   - TRIANGLE : Show marker as a triangle.
	//   - SQUARE : Show marker as a square.
	//   - DIAMOND : Show marker as a diamond.
	//   - ROUNDED_SQUARE : Show marker as a rounded square.
	MarkerShape LineChartMarkerShape

	// Size of marker in the series.
	MarkerSize *string

	// Configuration option that determines whether to show the markers in the series.
	MarkerVisibility Visibility
	// contains filtered or unexported fields
}

Marker styles options for a line series in LineChartVisual .

type LineChartSeriesSettings added in v1.28.0

type LineChartSeriesSettings struct {

	// Line styles options for a line series in LineChartVisual .
	LineStyleSettings *LineChartLineStyleSettings

	// Marker styles options for a line series in LineChartVisual .
	MarkerStyleSettings *LineChartMarkerStyleSettings
	// contains filtered or unexported fields
}

The options that determine the presentation of a line series in the visual

type LineChartSortConfiguration added in v1.28.0

type LineChartSortConfiguration struct {

	// The limit on the number of categories that are displayed in a line chart.
	CategoryItemsLimitConfiguration *ItemsLimitConfiguration

	// The sort configuration of the category fields.
	CategorySort []FieldSortOptions

	// The limit on the number of lines that are displayed in a line chart.
	ColorItemsLimitConfiguration *ItemsLimitConfiguration

	// The limit on the number of small multiples panels that are displayed.
	SmallMultiplesLimitConfiguration *ItemsLimitConfiguration

	// The sort configuration of the small multiples field.
	SmallMultiplesSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a line chart.

type LineChartType added in v1.28.0

type LineChartType string
const (
	LineChartTypeLine        LineChartType = "LINE"
	LineChartTypeArea        LineChartType = "AREA"
	LineChartTypeStackedArea LineChartType = "STACKED_AREA"
)

Enum values for LineChartType

func (LineChartType) Values added in v1.28.0

func (LineChartType) Values() []LineChartType

Values returns all known values for LineChartType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LineChartVisual added in v1.28.0

type LineChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a line chart.
	ChartConfiguration *LineChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A line chart. For more information, see Using line charts (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the Amazon QuickSight User Guide.

type LineInterpolation added in v1.28.0

type LineInterpolation string
const (
	LineInterpolationLinear  LineInterpolation = "LINEAR"
	LineInterpolationSmooth  LineInterpolation = "SMOOTH"
	LineInterpolationStepped LineInterpolation = "STEPPED"
)

Enum values for LineInterpolation

func (LineInterpolation) Values added in v1.28.0

Values returns all known values for LineInterpolation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LineSeriesAxisDisplayOptions added in v1.28.0

type LineSeriesAxisDisplayOptions struct {

	// The options that determine the presentation of the line series axis.
	AxisOptions *AxisDisplayOptions

	// The configuration options that determine how missing data is treated during the
	// rendering of a line chart.
	MissingDataConfigurations []MissingDataConfiguration
	// contains filtered or unexported fields
}

The series axis configuration of a line chart.

type LinkSharingConfiguration added in v1.15.0

type LinkSharingConfiguration struct {

	// A structure that contains the permissions of a shareable link.
	Permissions []ResourcePermission
	// contains filtered or unexported fields
}

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

type ListControlDisplayOptions added in v1.28.0

type ListControlDisplayOptions struct {

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The configuration of the search options in a list control.
	SearchOptions *ListControlSearchOptions

	// The configuration of the Select all options in a list control.
	SelectAllOptions *ListControlSelectAllOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type ListControlSearchOptions added in v1.28.0

type ListControlSearchOptions struct {

	// The visibility configuration of the search options in a list control.
	Visibility Visibility
	// contains filtered or unexported fields
}

The configuration of the search options in a list control.

type ListControlSelectAllOptions added in v1.28.0

type ListControlSelectAllOptions struct {

	// The visibility configuration of the Select all options in a list control.
	Visibility Visibility
	// contains filtered or unexported fields
}

The configuration of the Select all options in a list control.

type LoadingAnimation added in v1.28.0

type LoadingAnimation struct {

	// The visibility configuration of LoadingAnimation .
	Visibility Visibility
	// contains filtered or unexported fields
}

The configuration of loading animation in free-form layout.

type LocalNavigationConfiguration added in v1.28.0

type LocalNavigationConfiguration struct {

	// The sheet that is targeted for navigation in the same analysis.
	//
	// This member is required.
	TargetSheetId *string
	// contains filtered or unexported fields
}

The navigation configuration for CustomActionNavigationOperation .

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. For this structure to be
	// valid, only one of the attributes can be non-null.
	DataTransforms []TransformOperation
	// contains filtered or unexported fields
}

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 {

	// The Amazon Resource Number (ARN) of the parent dataset.
	DataSetArn *string

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

	// Physical table ID.
	PhysicalTableId *string
	// contains filtered or unexported fields
}

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 LongFormatText added in v1.28.0

type LongFormatText struct {

	// Plain text format.
	PlainText *string

	// Rich text. Examples of rich text include bold, underline, and italics.
	RichText *string
	// contains filtered or unexported fields
}

The text format for a subtitle. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type LookbackWindow added in v1.34.0

type LookbackWindow struct {

	// The name of the lookback window column.
	//
	// This member is required.
	ColumnName *string

	// The lookback window column size.
	//
	// This member is required.
	Size *int64

	// The size unit that is used for the lookback window column. Valid values for
	// this structure are HOUR , DAY , and WEEK .
	//
	// This member is required.
	SizeUnit LookbackWindowSizeUnit
	// contains filtered or unexported fields
}

The lookback window setup of an incremental refresh configuration.

type LookbackWindowSizeUnit added in v1.34.0

type LookbackWindowSizeUnit string
const (
	LookbackWindowSizeUnitHour LookbackWindowSizeUnit = "HOUR"
	LookbackWindowSizeUnitDay  LookbackWindowSizeUnit = "DAY"
	LookbackWindowSizeUnitWeek LookbackWindowSizeUnit = "WEEK"
)

Enum values for LookbackWindowSizeUnit

func (LookbackWindowSizeUnit) Values added in v1.34.0

Values returns all known values for LookbackWindowSizeUnit. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

Amazon S3 manifest file location.

type MapZoomMode added in v1.28.0

type MapZoomMode string
const (
	MapZoomModeAuto   MapZoomMode = "AUTO"
	MapZoomModeManual MapZoomMode = "MANUAL"
)

Enum values for MapZoomMode

func (MapZoomMode) Values added in v1.28.0

func (MapZoomMode) Values() []MapZoomMode

Values returns all known values for MapZoomMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MappedDataSetParameter added in v1.35.0

type MappedDataSetParameter struct {

	// A unique name that identifies a dataset within the analysis or dashboard.
	//
	// This member is required.
	DataSetIdentifier *string

	// The name of the dataset parameter.
	//
	// This member is required.
	DataSetParameterName *string
	// contains filtered or unexported fields
}

A dataset parameter that is mapped to an analysis parameter.

type MarginStyle

type MarginStyle struct {

	// This Boolean value controls whether to display sheet margins.
	Show *bool
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The parameters for MariaDB.

type MaximumLabelType added in v1.28.0

type MaximumLabelType struct {

	// The visibility of the maximum label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The maximum label of a data path label.

type MaximumMinimumComputation added in v1.28.0

type MaximumMinimumComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The type of computation. Choose one of the following options:
	//   - MAXIMUM: A maximum computation.
	//   - MINIMUM: A minimum computation.
	//
	// This member is required.
	Type MaximumMinimumComputationType

	// The name of a computation.
	Name *string

	// The time field that is used in a computation.
	Time *DimensionField

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The maximum and minimum computation configuration.

type MaximumMinimumComputationType added in v1.28.0

type MaximumMinimumComputationType string
const (
	MaximumMinimumComputationTypeMaximum MaximumMinimumComputationType = "MAXIMUM"
	MaximumMinimumComputationTypeMinimum MaximumMinimumComputationType = "MINIMUM"
)

Enum values for MaximumMinimumComputationType

func (MaximumMinimumComputationType) Values added in v1.28.0

Values returns all known values for MaximumMinimumComputationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MeasureField added in v1.28.0

type MeasureField struct {

	// The calculated measure field only used in pivot tables.
	CalculatedMeasureField *CalculatedMeasureField

	// The measure type field with categorical type columns.
	CategoricalMeasureField *CategoricalMeasureField

	// The measure type field with date type columns.
	DateMeasureField *DateMeasureField

	// The measure type field with numerical type columns.
	NumericalMeasureField *NumericalMeasureField
	// contains filtered or unexported fields
}

The measure (metric) type field.

type MemberIdArnPair added in v1.6.0

type MemberIdArnPair struct {

	// The Amazon Resource Name (ARN) of the member.
	MemberArn *string

	// The ID of the member.
	MemberId *string
	// contains filtered or unexported fields
}

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

type MemberType added in v1.6.0

type MemberType string
const (
	MemberTypeDashboard  MemberType = "DASHBOARD"
	MemberTypeAnalysis   MemberType = "ANALYSIS"
	MemberTypeDataset    MemberType = "DATASET"
	MemberTypeDatasource MemberType = "DATASOURCE"
	MemberTypeTopic      MemberType = "TOPIC"
)

Enum values for MemberType

func (MemberType) Values added in v1.6.0

func (MemberType) Values() []MemberType

Values returns all known values for MemberType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MetricComparisonComputation added in v1.28.0

type MetricComparisonComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The field that is used in a metric comparison from value setup.
	FromValue *MeasureField

	// The name of a computation.
	Name *string

	// The field that is used in a metric comparison to value setup.
	TargetValue *MeasureField

	// The time field that is used in a computation.
	Time *DimensionField
	// contains filtered or unexported fields
}

The metric comparison computation configuration.

type MinimumLabelType added in v1.28.0

type MinimumLabelType struct {

	// The visibility of the minimum label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The minimum label of a data path label.

type MissingDataConfiguration added in v1.28.0

type MissingDataConfiguration struct {

	// The treatment option that determines how missing data should be rendered.
	// Choose from the following options:
	//   - INTERPOLATE : Interpolate missing values between the prior and the next
	//   known value.
	//   - SHOW_AS_ZERO : Show missing values as the value 0 .
	//   - SHOW_AS_BLANK : Display a blank space when rendering missing data.
	TreatmentOption MissingDataTreatmentOption
	// contains filtered or unexported fields
}

The configuration options that determine how missing data is treated during the rendering of a line chart.

type MissingDataTreatmentOption added in v1.28.0

type MissingDataTreatmentOption string
const (
	MissingDataTreatmentOptionInterpolate MissingDataTreatmentOption = "INTERPOLATE"
	MissingDataTreatmentOptionShowAsZero  MissingDataTreatmentOption = "SHOW_AS_ZERO"
	MissingDataTreatmentOptionShowAsBlank MissingDataTreatmentOption = "SHOW_AS_BLANK"
)

Enum values for MissingDataTreatmentOption

func (MissingDataTreatmentOption) Values added in v1.28.0

Values returns all known values for MissingDataTreatmentOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

The parameters for MySQL.

type NamedEntityAggType added in v1.35.0

type NamedEntityAggType string
const (
	NamedEntityAggTypeSum           NamedEntityAggType = "SUM"
	NamedEntityAggTypeMin           NamedEntityAggType = "MIN"
	NamedEntityAggTypeMax           NamedEntityAggType = "MAX"
	NamedEntityAggTypeCount         NamedEntityAggType = "COUNT"
	NamedEntityAggTypeAverage       NamedEntityAggType = "AVERAGE"
	NamedEntityAggTypeDistinctCount NamedEntityAggType = "DISTINCT_COUNT"
	NamedEntityAggTypeStdev         NamedEntityAggType = "STDEV"
	NamedEntityAggTypeStdevp        NamedEntityAggType = "STDEVP"
	NamedEntityAggTypeVar           NamedEntityAggType = "VAR"
	NamedEntityAggTypeVarp          NamedEntityAggType = "VARP"
	NamedEntityAggTypePercentile    NamedEntityAggType = "PERCENTILE"
	NamedEntityAggTypeMedian        NamedEntityAggType = "MEDIAN"
	NamedEntityAggTypeCustom        NamedEntityAggType = "CUSTOM"
)

Enum values for NamedEntityAggType

func (NamedEntityAggType) Values added in v1.35.0

Values returns all known values for NamedEntityAggType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NamedEntityDefinition added in v1.35.0

type NamedEntityDefinition struct {

	// The name of the entity.
	FieldName *string

	// The definition of a metric.
	Metric *NamedEntityDefinitionMetric

	// The property name to be used for the named entity.
	PropertyName *string

	// The property role. Valid values for this structure are PRIMARY and ID .
	PropertyRole PropertyRole

	// The property usage. Valid values for this structure are INHERIT , DIMENSION ,
	// and MEASURE .
	PropertyUsage PropertyUsage
	// contains filtered or unexported fields
}

A structure that represents a named entity.

type NamedEntityDefinitionMetric added in v1.35.0

type NamedEntityDefinitionMetric struct {

	// The aggregation of a named entity. Valid values for this structure are SUM , MIN
	// , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP ,
	// PERCENTILE , MEDIAN , and CUSTOM .
	Aggregation NamedEntityAggType

	// The additional parameters for an aggregation function.
	AggregationFunctionParameters map[string]string
	// contains filtered or unexported fields
}

A structure that represents a metric.

type NamedFilterAggType added in v1.35.0

type NamedFilterAggType string
const (
	NamedFilterAggTypeNoAggregation NamedFilterAggType = "NO_AGGREGATION"
	NamedFilterAggTypeSum           NamedFilterAggType = "SUM"
	NamedFilterAggTypeAverage       NamedFilterAggType = "AVERAGE"
	NamedFilterAggTypeCount         NamedFilterAggType = "COUNT"
	NamedFilterAggTypeDistinctCount NamedFilterAggType = "DISTINCT_COUNT"
	NamedFilterAggTypeMax           NamedFilterAggType = "MAX"
	NamedFilterAggTypeMedian        NamedFilterAggType = "MEDIAN"
	NamedFilterAggTypeMin           NamedFilterAggType = "MIN"
	NamedFilterAggTypeStdev         NamedFilterAggType = "STDEV"
	NamedFilterAggTypeStdevp        NamedFilterAggType = "STDEVP"
	NamedFilterAggTypeVar           NamedFilterAggType = "VAR"
	NamedFilterAggTypeVarp          NamedFilterAggType = "VARP"
)

Enum values for NamedFilterAggType

func (NamedFilterAggType) Values added in v1.35.0

Values returns all known values for NamedFilterAggType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NamedFilterType added in v1.35.0

type NamedFilterType string
const (
	NamedFilterTypeCategoryFilter        NamedFilterType = "CATEGORY_FILTER"
	NamedFilterTypeNumericEqualityFilter NamedFilterType = "NUMERIC_EQUALITY_FILTER"
	NamedFilterTypeNumericRangeFilter    NamedFilterType = "NUMERIC_RANGE_FILTER"
	NamedFilterTypeDateRangeFilter       NamedFilterType = "DATE_RANGE_FILTER"
	NamedFilterTypeRelativeDateFilter    NamedFilterType = "RELATIVE_DATE_FILTER"
)

Enum values for NamedFilterType

func (NamedFilterType) Values added in v1.35.0

func (NamedFilterType) Values() []NamedFilterType

Values returns all known values for NamedFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NamespaceError

type NamespaceError struct {

	// The message for the error.
	Message *string

	// The error type.
	Type NamespaceErrorType
	// contains filtered or unexported fields
}

Errors that occur during namespace creation.

type NamespaceErrorType

type NamespaceErrorType string
const (
	NamespaceErrorTypePermissionDenied     NamespaceErrorType = "PERMISSION_DENIED"
	NamespaceErrorTypeInternalServiceError NamespaceErrorType = "INTERNAL_SERVICE_ERROR"
)

Enum values for NamespaceErrorType

func (NamespaceErrorType) Values added in v0.29.0

Values returns all known values for NamespaceErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NamespaceInfoV2

type NamespaceInfoV2 struct {

	// The namespace ARN.
	Arn *string

	// The namespace Amazon Web Services 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 occurred when the namespace was created.
	NamespaceError *NamespaceError
	// contains filtered or unexported fields
}

The error type.

type NamespaceStatus

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

Enum values for NamespaceStatus

func (NamespaceStatus) Values added in v0.29.0

func (NamespaceStatus) Values() []NamespaceStatus

Values returns all known values for NamespaceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NegativeFormat added in v1.35.0

type NegativeFormat struct {

	// The prefix for a negative format.
	Prefix *string

	// The suffix for a negative format.
	Suffix *string
	// contains filtered or unexported fields
}

A structure that represents a negative format.

type NegativeValueConfiguration added in v1.28.0

type NegativeValueConfiguration struct {

	// Determines the display mode of the negative value configuration.
	//
	// This member is required.
	DisplayMode NegativeValueDisplayMode
	// contains filtered or unexported fields
}

The options that determine the negative value configuration.

type NegativeValueDisplayMode added in v1.28.0

type NegativeValueDisplayMode string
const (
	NegativeValueDisplayModePositive NegativeValueDisplayMode = "POSITIVE"
	NegativeValueDisplayModeNegative NegativeValueDisplayMode = "NEGATIVE"
)

Enum values for NegativeValueDisplayMode

func (NegativeValueDisplayMode) Values added in v1.28.0

Values returns all known values for NegativeValueDisplayMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NetworkInterface added in v1.35.0

type NetworkInterface struct {

	// The availability zone that the network interface resides in.
	AvailabilityZone *string

	// An error message.
	ErrorMessage *string

	// The network interface ID.
	NetworkInterfaceId *string

	// The status of the network interface.
	Status NetworkInterfaceStatus

	// The subnet ID associated with the network interface.
	SubnetId *string
	// contains filtered or unexported fields
}

The structure that contains information about a network interface.

type NetworkInterfaceStatus added in v1.35.0

type NetworkInterfaceStatus string
const (
	NetworkInterfaceStatusCreating                       NetworkInterfaceStatus = "CREATING"
	NetworkInterfaceStatusAvailable                      NetworkInterfaceStatus = "AVAILABLE"
	NetworkInterfaceStatusCreationFailed                 NetworkInterfaceStatus = "CREATION_FAILED"
	NetworkInterfaceStatusUpdating                       NetworkInterfaceStatus = "UPDATING"
	NetworkInterfaceStatusUpdateFailed                   NetworkInterfaceStatus = "UPDATE_FAILED"
	NetworkInterfaceStatusDeleting                       NetworkInterfaceStatus = "DELETING"
	NetworkInterfaceStatusDeleted                        NetworkInterfaceStatus = "DELETED"
	NetworkInterfaceStatusDeletionFailed                 NetworkInterfaceStatus = "DELETION_FAILED"
	NetworkInterfaceStatusDeletionScheduled              NetworkInterfaceStatus = "DELETION_SCHEDULED"
	NetworkInterfaceStatusAttachmentFailedRollbackFailed NetworkInterfaceStatus = "ATTACHMENT_FAILED_ROLLBACK_FAILED"
)

Enum values for NetworkInterfaceStatus

func (NetworkInterfaceStatus) Values added in v1.35.0

Values returns all known values for NetworkInterfaceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NewDefaultValues added in v1.35.0

type NewDefaultValues struct {

	// A list of static default values for a given date time parameter.
	DateTimeStaticValues []time.Time

	// A list of static default values for a given decimal parameter.
	DecimalStaticValues []float64

	// A list of static default values for a given integer parameter.
	IntegerStaticValues []int64

	// A list of static default values for a given string parameter.
	StringStaticValues []string
	// contains filtered or unexported fields
}

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

type NullValueFormatConfiguration added in v1.28.0

type NullValueFormatConfiguration struct {

	// Determines the null string of null values.
	//
	// This member is required.
	NullString *string
	// contains filtered or unexported fields
}

The options that determine the null value format configuration.

type NumberDisplayFormatConfiguration added in v1.28.0

type NumberDisplayFormatConfiguration struct {

	// The option that determines the decimal places configuration.
	DecimalPlacesConfiguration *DecimalPlacesConfiguration

	// The options that determine the negative value configuration.
	NegativeValueConfiguration *NegativeValueConfiguration

	// The options that determine the null value format configuration.
	NullValueFormatConfiguration *NullValueFormatConfiguration

	// Determines the number scale value of the number format.
	NumberScale NumberScale

	// Determines the prefix value of the number format.
	Prefix *string

	// The options that determine the numeric separator configuration.
	SeparatorConfiguration *NumericSeparatorConfiguration

	// Determines the suffix value of the number format.
	Suffix *string
	// contains filtered or unexported fields
}

The options that determine the number display format configuration.

type NumberFormatConfiguration added in v1.28.0

type NumberFormatConfiguration struct {

	// The options that determine the numeric format configuration.
	FormatConfiguration *NumericFormatConfiguration
	// contains filtered or unexported fields
}

Formatting configuration for number fields.

type NumberScale added in v1.28.0

type NumberScale string
const (
	NumberScaleNone      NumberScale = "NONE"
	NumberScaleAuto      NumberScale = "AUTO"
	NumberScaleThousands NumberScale = "THOUSANDS"
	NumberScaleMillions  NumberScale = "MILLIONS"
	NumberScaleBillions  NumberScale = "BILLIONS"
	NumberScaleTrillions NumberScale = "TRILLIONS"
)

Enum values for NumberScale

func (NumberScale) Values added in v1.28.0

func (NumberScale) Values() []NumberScale

Values returns all known values for NumberScale. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NumericAxisOptions added in v1.28.0

type NumericAxisOptions struct {

	// The range setup of a numeric axis.
	Range *AxisDisplayRange

	// The scale setup of a numeric axis.
	Scale *AxisScale
	// contains filtered or unexported fields
}

The options for an axis with a numeric field.

type NumericEqualityDrillDownFilter added in v1.28.0

type NumericEqualityDrillDownFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The value of the double input numeric drill down filter.
	//
	// This member is required.
	Value float64
	// contains filtered or unexported fields
}

The numeric equality type drill down filter.

type NumericEqualityFilter added in v1.28.0

type NumericEqualityFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// The match operator that is used to determine if a filter should be applied.
	//
	// This member is required.
	MatchOperator NumericEqualityMatchOperator

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	//
	// This member is required.
	NullOption FilterNullOption

	// The aggregation function of the filter.
	AggregationFunction *AggregationFunction

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration

	// The parameter whose value should be used for the filter value.
	ParameterName *string

	// Select all of the values. Null is not the assigned value of select all.
	//   - FILTER_ALL_VALUES
	SelectAllOptions NumericFilterSelectAllOptions

	// The input value.
	Value *float64
	// contains filtered or unexported fields
}

A NumericEqualityFilter filters values that are equal to the specified value.

type NumericEqualityMatchOperator added in v1.28.0

type NumericEqualityMatchOperator string
const (
	NumericEqualityMatchOperatorEquals       NumericEqualityMatchOperator = "EQUALS"
	NumericEqualityMatchOperatorDoesNotEqual NumericEqualityMatchOperator = "DOES_NOT_EQUAL"
)

Enum values for NumericEqualityMatchOperator

func (NumericEqualityMatchOperator) Values added in v1.28.0

Values returns all known values for NumericEqualityMatchOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NumericFilterSelectAllOptions added in v1.28.0

type NumericFilterSelectAllOptions string
const (
	NumericFilterSelectAllOptionsFilterAllValues NumericFilterSelectAllOptions = "FILTER_ALL_VALUES"
)

Enum values for NumericFilterSelectAllOptions

func (NumericFilterSelectAllOptions) Values added in v1.28.0

Values returns all known values for NumericFilterSelectAllOptions. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NumericFormatConfiguration added in v1.28.0

type NumericFormatConfiguration struct {

	// The options that determine the currency display format configuration.
	CurrencyDisplayFormatConfiguration *CurrencyDisplayFormatConfiguration

	// The options that determine the number display format configuration.
	NumberDisplayFormatConfiguration *NumberDisplayFormatConfiguration

	// The options that determine the percentage display format configuration.
	PercentageDisplayFormatConfiguration *PercentageDisplayFormatConfiguration
	// contains filtered or unexported fields
}

The options that determine the numeric format configuration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type NumericRangeFilter added in v1.28.0

type NumericRangeFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	//
	// This member is required.
	NullOption FilterNullOption

	// The aggregation function of the filter.
	AggregationFunction *AggregationFunction

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration

	// Determines whether the maximum value in the filter value range should be
	// included in the filtered results.
	IncludeMaximum *bool

	// Determines whether the minimum value in the filter value range should be
	// included in the filtered results.
	IncludeMinimum *bool

	// The maximum value for the filter value range.
	RangeMaximum *NumericRangeFilterValue

	// The minimum value for the filter value range.
	RangeMinimum *NumericRangeFilterValue

	// Select all of the values. Null is not the assigned value of select all.
	//   - FILTER_ALL_VALUES
	SelectAllOptions NumericFilterSelectAllOptions
	// contains filtered or unexported fields
}

A NumericRangeFilter filters values that are within the value range.

type NumericRangeFilterValue added in v1.28.0

type NumericRangeFilterValue struct {

	// The parameter that is used in the numeric range.
	Parameter *string

	// The static value of the numeric range filter.
	StaticValue *float64
	// contains filtered or unexported fields
}

The value input pf the numeric range filter.

type NumericSeparatorConfiguration added in v1.28.0

type NumericSeparatorConfiguration struct {

	// Determines the decimal separator.
	DecimalSeparator NumericSeparatorSymbol

	// The options that determine the thousands separator configuration.
	ThousandsSeparator *ThousandSeparatorOptions
	// contains filtered or unexported fields
}

The options that determine the numeric separator configuration.

type NumericSeparatorSymbol added in v1.28.0

type NumericSeparatorSymbol string
const (
	NumericSeparatorSymbolComma NumericSeparatorSymbol = "COMMA"
	NumericSeparatorSymbolDot   NumericSeparatorSymbol = "DOT"
	NumericSeparatorSymbolSpace NumericSeparatorSymbol = "SPACE"
)

Enum values for NumericSeparatorSymbol

func (NumericSeparatorSymbol) Values added in v1.28.0

Values returns all known values for NumericSeparatorSymbol. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type NumericalAggregationFunction added in v1.28.0

type NumericalAggregationFunction struct {

	// An aggregation based on the percentile of values in a dimension or measure.
	PercentileAggregation *PercentileAggregation

	// Built-in aggregation functions for numerical values.
	//   - SUM : The sum of a dimension or measure.
	//   - AVERAGE : The average of a dimension or measure.
	//   - MIN : The minimum value of a dimension or measure.
	//   - MAX : The maximum value of a dimension or measure.
	//   - COUNT : The count of a dimension or measure.
	//   - DISTINCT_COUNT : The count of distinct values in a dimension or measure.
	//   - VAR : The variance of a dimension or measure.
	//   - VARP : The partitioned variance of a dimension or measure.
	//   - STDEV : The standard deviation of a dimension or measure.
	//   - STDEVP : The partitioned standard deviation of a dimension or measure.
	//   - MEDIAN : The median value of a dimension or measure.
	SimpleNumericalAggregation SimpleNumericalAggregationFunction
	// contains filtered or unexported fields
}

Aggregation for numerical values.

type NumericalDimensionField added in v1.28.0

type NumericalDimensionField struct {

	// The column that is used in the NumericalDimensionField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The format configuration of the field.
	FormatConfiguration *NumberFormatConfiguration

	// The custom hierarchy ID.
	HierarchyId *string
	// contains filtered or unexported fields
}

The dimension type field with numerical type columns.

type NumericalMeasureField added in v1.28.0

type NumericalMeasureField struct {

	// The column that is used in the NumericalMeasureField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The aggregation function of the measure field.
	AggregationFunction *NumericalAggregationFunction

	// The format configuration of the field.
	FormatConfiguration *NumberFormatConfiguration
	// contains filtered or unexported fields
}

The measure type field with numerical type columns.

type OracleParameters added in v0.30.0

type OracleParameters struct {

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

	// An Oracle host.
	//
	// This member is required.
	Host *string

	// The port.
	//
	// This member is required.
	Port *int32
	// contains filtered or unexported fields
}

The parameters for Oracle.

type OtherCategories added in v1.28.0

type OtherCategories string
const (
	OtherCategoriesInclude OtherCategories = "INCLUDE"
	OtherCategoriesExclude OtherCategories = "EXCLUDE"
)

Enum values for OtherCategories

func (OtherCategories) Values added in v1.28.0

func (OtherCategories) Values() []OtherCategories

Values returns all known values for OtherCategories. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OutputColumn

type OutputColumn struct {

	// A description for a column.
	Description *string

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

	// The sub data type of the column.
	SubType ColumnDataSubType

	// The data type of the column.
	Type ColumnDataType
	// contains filtered or unexported fields
}

Output column.

type OverrideDatasetParameterOperation added in v1.35.0

type OverrideDatasetParameterOperation struct {

	// The name of the parameter to be overridden with different values.
	//
	// This member is required.
	ParameterName *string

	// The new default values for the parameter.
	NewDefaultValues *NewDefaultValues

	// The new name for the parameter.
	NewParameterName *string
	// contains filtered or unexported fields
}

A transform operation that overrides the dataset parameter values that are defined in another dataset.

type PaginationConfiguration added in v1.28.0

type PaginationConfiguration struct {

	// Indicates the page number.
	//
	// This member is required.
	PageNumber *int64

	// Indicates how many items render in one page.
	//
	// This member is required.
	PageSize *int64
	// contains filtered or unexported fields
}

The pagination configuration for a table visual or boxplot.

type PanelBorderStyle added in v1.28.0

type PanelBorderStyle string
const (
	PanelBorderStyleSolid  PanelBorderStyle = "SOLID"
	PanelBorderStyleDashed PanelBorderStyle = "DASHED"
	PanelBorderStyleDotted PanelBorderStyle = "DOTTED"
)

Enum values for PanelBorderStyle

func (PanelBorderStyle) Values added in v1.28.0

Values returns all known values for PanelBorderStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PanelConfiguration added in v1.28.0

type PanelConfiguration struct {

	// Sets the background color for each panel.
	BackgroundColor *string

	// Determines whether or not a background for each small multiples panel is
	// rendered.
	BackgroundVisibility Visibility

	// Sets the line color of panel borders.
	BorderColor *string

	// Sets the line style of panel borders.
	BorderStyle PanelBorderStyle

	// Sets the line thickness of panel borders.
	BorderThickness *string

	// Determines whether or not each panel displays a border.
	BorderVisibility Visibility

	// Sets the total amount of negative space to display between sibling panels.
	GutterSpacing *string

	// Determines whether or not negative space between sibling panels is rendered.
	GutterVisibility Visibility

	// Configures the title display within each small multiples panel.
	Title *PanelTitleOptions
	// contains filtered or unexported fields
}

A collection of options that configure how each panel displays in a small multiples chart.

type PanelTitleOptions added in v1.28.0

type PanelTitleOptions struct {

	// Configures the display properties of the given text.
	FontConfiguration *FontConfiguration

	// Sets the horizontal text alignment of the title within each panel.
	HorizontalTextAlignment HorizontalTextAlignment

	// Determines whether or not panel titles are displayed.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the title styles for each small multiples panel.

type PaperOrientation added in v1.28.0

type PaperOrientation string
const (
	PaperOrientationPortrait  PaperOrientation = "PORTRAIT"
	PaperOrientationLandscape PaperOrientation = "LANDSCAPE"
)

Enum values for PaperOrientation

func (PaperOrientation) Values added in v1.28.0

Values returns all known values for PaperOrientation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PaperSize added in v1.28.0

type PaperSize string
const (
	PaperSizeUsLetter        PaperSize = "US_LETTER"
	PaperSizeUsLegal         PaperSize = "US_LEGAL"
	PaperSizeUsTabloidLedger PaperSize = "US_TABLOID_LEDGER"
	PaperSizeA0              PaperSize = "A0"
	PaperSizeA1              PaperSize = "A1"
	PaperSizeA2              PaperSize = "A2"
	PaperSizeA3              PaperSize = "A3"
	PaperSizeA4              PaperSize = "A4"
	PaperSizeA5              PaperSize = "A5"
	PaperSizeJisB4           PaperSize = "JIS_B4"
	PaperSizeJisB5           PaperSize = "JIS_B5"
)

Enum values for PaperSize

func (PaperSize) Values added in v1.28.0

func (PaperSize) Values() []PaperSize

Values returns all known values for PaperSize. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ParameterControl added in v1.28.0

type ParameterControl struct {

	// A control from a date parameter that specifies date and time.
	DateTimePicker *ParameterDateTimePickerControl

	// A control to display a dropdown list with buttons that are used to select a
	// single value.
	Dropdown *ParameterDropDownControl

	// A control to display a list with buttons or boxes that are used to select
	// either a single value or multiple values.
	List *ParameterListControl

	// A control to display a horizontal toggle bar. This is used to change a value by
	// sliding the toggle.
	Slider *ParameterSliderControl

	// A control to display a text box that is used to enter multiple entries.
	TextArea *ParameterTextAreaControl

	// A control to display a text box that is used to enter a single entry.
	TextField *ParameterTextFieldControl
	// contains filtered or unexported fields
}

The control of a parameter that users can interact with in a dashboard or an analysis. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ParameterDateTimePickerControl added in v1.28.0

type ParameterDateTimePickerControl struct {

	// The ID of the ParameterDateTimePickerControl .
	//
	// This member is required.
	ParameterControlId *string

	// The name of the ParameterDateTimePickerControl .
	//
	// This member is required.
	SourceParameterName *string

	// The title of the ParameterDateTimePickerControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *DateTimePickerControlDisplayOptions
	// contains filtered or unexported fields
}

A control from a date parameter that specifies date and time.

type ParameterDeclaration added in v1.28.0

type ParameterDeclaration struct {

	// A parameter declaration for the DateTime data type.
	DateTimeParameterDeclaration *DateTimeParameterDeclaration

	// A parameter declaration for the Decimal data type.
	DecimalParameterDeclaration *DecimalParameterDeclaration

	// A parameter declaration for the Integer data type.
	IntegerParameterDeclaration *IntegerParameterDeclaration

	// A parameter declaration for the String data type.
	StringParameterDeclaration *StringParameterDeclaration
	// contains filtered or unexported fields
}

The declaration definition of a parameter. For more information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the Amazon QuickSight User Guide. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ParameterDropDownControl added in v1.28.0

type ParameterDropDownControl struct {

	// The ID of the ParameterDropDownControl .
	//
	// This member is required.
	ParameterControlId *string

	// The source parameter name of the ParameterDropDownControl .
	//
	// This member is required.
	SourceParameterName *string

	// The title of the ParameterDropDownControl .
	//
	// This member is required.
	Title *string

	// The values that are displayed in a control can be configured to only show
	// values that are valid based on what's selected in other controls.
	CascadingControlConfiguration *CascadingControlConfiguration

	// The display options of a control.
	DisplayOptions *DropDownControlDisplayOptions

	// A list of selectable values that are used in a control.
	SelectableValues *ParameterSelectableValues

	// The type parameter name of the ParameterDropDownControl .
	Type SheetControlListType
	// contains filtered or unexported fields
}

A control to display a dropdown list with buttons that are used to select a single value.

type ParameterListControl added in v1.28.0

type ParameterListControl struct {

	// The ID of the ParameterListControl .
	//
	// This member is required.
	ParameterControlId *string

	// The source parameter name of the ParameterListControl .
	//
	// This member is required.
	SourceParameterName *string

	// The title of the ParameterListControl .
	//
	// This member is required.
	Title *string

	// The values that are displayed in a control can be configured to only show
	// values that are valid based on what's selected in other controls.
	CascadingControlConfiguration *CascadingControlConfiguration

	// The display options of a control.
	DisplayOptions *ListControlDisplayOptions

	// A list of selectable values that are used in a control.
	SelectableValues *ParameterSelectableValues

	// The type of ParameterListControl .
	Type SheetControlListType
	// contains filtered or unexported fields
}

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

type ParameterSelectableValues added in v1.28.0

type ParameterSelectableValues struct {

	// The column identifier that fetches values from the data set.
	LinkToDataSetColumn *ColumnIdentifier

	// The values that are used in ParameterSelectableValues .
	Values []string
	// contains filtered or unexported fields
}

A list of selectable values that are used in a control.

type ParameterSliderControl added in v1.28.0

type ParameterSliderControl struct {

	// The larger value that is displayed at the right of the slider.
	//
	// This member is required.
	MaximumValue float64

	// The smaller value that is displayed at the left of the slider.
	//
	// This member is required.
	MinimumValue float64

	// The ID of the ParameterSliderControl .
	//
	// This member is required.
	ParameterControlId *string

	// The source parameter name of the ParameterSliderControl .
	//
	// This member is required.
	SourceParameterName *string

	// The number of increments that the slider bar is divided into.
	//
	// This member is required.
	StepSize float64

	// The title of the ParameterSliderControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *SliderControlDisplayOptions
	// contains filtered or unexported fields
}

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

type ParameterTextAreaControl added in v1.28.0

type ParameterTextAreaControl struct {

	// The ID of the ParameterTextAreaControl .
	//
	// This member is required.
	ParameterControlId *string

	// The source parameter name of the ParameterTextAreaControl .
	//
	// This member is required.
	SourceParameterName *string

	// The title of the ParameterTextAreaControl .
	//
	// This member is required.
	Title *string

	// The delimiter that is used to separate the lines in text.
	Delimiter *string

	// The display options of a control.
	DisplayOptions *TextAreaControlDisplayOptions
	// contains filtered or unexported fields
}

A control to display a text box that is used to enter multiple entries.

type ParameterTextFieldControl added in v1.28.0

type ParameterTextFieldControl struct {

	// The ID of the ParameterTextFieldControl .
	//
	// This member is required.
	ParameterControlId *string

	// The source parameter name of the ParameterTextFieldControl .
	//
	// This member is required.
	SourceParameterName *string

	// The title of the ParameterTextFieldControl .
	//
	// This member is required.
	Title *string

	// The display options of a control.
	DisplayOptions *TextFieldControlDisplayOptions
	// contains filtered or unexported fields
}

A control to display a text box that is used to enter a single entry.

type ParameterValueType added in v1.28.0

type ParameterValueType string
const (
	ParameterValueTypeMultiValued  ParameterValueType = "MULTI_VALUED"
	ParameterValueTypeSingleValued ParameterValueType = "SINGLE_VALUED"
)

Enum values for ParameterValueType

func (ParameterValueType) Values added in v1.28.0

Values returns all known values for ParameterValueType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Parameters

type Parameters struct {

	// The parameters that have a data type of date-time.
	DateTimeParameters []DateTimeParameter

	// The parameters that have a data type of decimal.
	DecimalParameters []DecimalParameter

	// The parameters that have a data type of integer.
	IntegerParameters []IntegerParameter

	// The parameters that have a data type of string.
	StringParameters []StringParameter
	// contains filtered or unexported fields
}

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

type PercentVisibleRange added in v1.28.0

type PercentVisibleRange struct {

	// The lower bound of the range.
	From *float64

	// The top bound of the range.
	To *float64
	// contains filtered or unexported fields
}

The percent range in the visible range.

type PercentageDisplayFormatConfiguration added in v1.28.0

type PercentageDisplayFormatConfiguration struct {

	// The option that determines the decimal places configuration.
	DecimalPlacesConfiguration *DecimalPlacesConfiguration

	// The options that determine the negative value configuration.
	NegativeValueConfiguration *NegativeValueConfiguration

	// The options that determine the null value format configuration.
	NullValueFormatConfiguration *NullValueFormatConfiguration

	// Determines the prefix value of the percentage format.
	Prefix *string

	// The options that determine the numeric separator configuration.
	SeparatorConfiguration *NumericSeparatorConfiguration

	// Determines the suffix value of the percentage format.
	Suffix *string
	// contains filtered or unexported fields
}

The options that determine the percentage display format configuration.

type PercentileAggregation added in v1.28.0

type PercentileAggregation struct {

	// The percentile value. This value can be any numeric constant 0–100. A
	// percentile value of 50 computes the median value of the measure.
	PercentileValue *float64
	// contains filtered or unexported fields
}

An aggregation based on the percentile of values in a dimension or measure.

type PeriodOverPeriodComputation added in v1.28.0

type PeriodOverPeriodComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The name of a computation.
	Name *string

	// The time field that is used in a computation.
	Time *DimensionField

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The period over period computation configuration.

type PeriodToDateComputation added in v1.28.0

type PeriodToDateComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The name of a computation.
	Name *string

	// The time granularity setup of period to date computation. Choose from the
	// following options:
	//   - YEAR: Year to date.
	//   - MONTH: Month to date.
	PeriodTimeGranularity TimeGranularity

	// The time field that is used in a computation.
	Time *DimensionField

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The period to date computation configuration.

type PhysicalTable

type PhysicalTable interface {
	// contains filtered or unexported methods
}

A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

The following types satisfy this interface:

PhysicalTableMemberCustomSql
PhysicalTableMemberRelationalTable
PhysicalTableMemberS3Source
Example (OutputUsage)
package main

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

func main() {
	var union types.PhysicalTable
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PhysicalTableMemberCustomSql:
		_ = v.Value // Value is types.CustomSql

	case *types.PhysicalTableMemberRelationalTable:
		_ = v.Value // Value is types.RelationalTable

	case *types.PhysicalTableMemberS3Source:
		_ = v.Value // Value is types.S3Source

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type PhysicalTableMemberCustomSql added in v0.31.0

type PhysicalTableMemberCustomSql struct {
	Value CustomSql
	// contains filtered or unexported fields
}

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

type PhysicalTableMemberRelationalTable added in v0.31.0

type PhysicalTableMemberRelationalTable struct {
	Value RelationalTable
	// contains filtered or unexported fields
}

A physical table type for relational data sources.

type PhysicalTableMemberS3Source added in v0.31.0

type PhysicalTableMemberS3Source struct {
	Value S3Source
	// contains filtered or unexported fields
}

A physical table type for as S3 data source.

type PieChartAggregatedFieldWells added in v1.28.0

type PieChartAggregatedFieldWells struct {

	// The category (group/color) field wells of a pie chart.
	Category []DimensionField

	// The small multiples field well of a pie chart.
	SmallMultiples []DimensionField

	// The value field wells of a pie chart. Values are aggregated based on categories.
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a pie chart.

type PieChartConfiguration added in v1.28.0

type PieChartConfiguration struct {

	// The label options of the group/color that is displayed in a pie chart.
	CategoryLabelOptions *ChartAxisLabelOptions

	// The contribution analysis (anomaly configuration) setup of the visual.
	ContributionAnalysisDefaults []ContributionAnalysisDefault

	// The options that determine if visual data labels are displayed.
	DataLabels *DataLabelOptions

	// The options that determine the shape of the chart. This option determines
	// whether the chart is a pie chart or a donut chart.
	DonutOptions *DonutOptions

	// The field wells of the visual.
	FieldWells *PieChartFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The small multiples setup for the visual.
	SmallMultiplesOptions *SmallMultiplesOptions

	// The sort configuration of a pie chart.
	SortConfiguration *PieChartSortConfiguration

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions

	// The label options for the value that is displayed in a pie chart.
	ValueLabelOptions *ChartAxisLabelOptions

	// The palette (chart color) display setup of the visual.
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a pie chart.

type PieChartFieldWells added in v1.28.0

type PieChartFieldWells struct {

	// The field well configuration of a pie chart.
	PieChartAggregatedFieldWells *PieChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a pie chart. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type PieChartSortConfiguration added in v1.28.0

type PieChartSortConfiguration struct {

	// The limit on the number of categories that are displayed in a pie chart.
	CategoryItemsLimit *ItemsLimitConfiguration

	// The sort configuration of the category fields.
	CategorySort []FieldSortOptions

	// The limit on the number of small multiples panels that are displayed.
	SmallMultiplesLimitConfiguration *ItemsLimitConfiguration

	// The sort configuration of the small multiples field.
	SmallMultiplesSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a pie chart.

type PieChartVisual added in v1.28.0

type PieChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a pie chart.
	ChartConfiguration *PieChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A pie or donut chart. The PieChartVisual structure describes a visual that is a member of the pie chart family. The following charts can be described by using this structure:

  • Pie charts
  • Donut charts

For more information, see Using pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the Amazon QuickSight User Guide. For more information, see Using donut charts (https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html) in the Amazon QuickSight User Guide.

type PivotFieldSortOptions added in v1.28.0

type PivotFieldSortOptions struct {

	// The field ID for the field sort options.
	//
	// This member is required.
	FieldId *string

	// The sort by field for the field sort options.
	//
	// This member is required.
	SortBy *PivotTableSortBy
	// contains filtered or unexported fields
}

The field sort options for a pivot table sort configuration.

type PivotTableAggregatedFieldWells added in v1.28.0

type PivotTableAggregatedFieldWells struct {

	// The columns field well for a pivot table. Values are grouped by columns fields.
	Columns []DimensionField

	// The rows field well for a pivot table. Values are grouped by rows fields.
	Rows []DimensionField

	// The values field well for a pivot table. Values are aggregated based on rows
	// and columns fields.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field well for the pivot table.

type PivotTableCellConditionalFormatting added in v1.28.0

type PivotTableCellConditionalFormatting struct {

	// The field ID of the cell for conditional formatting.
	//
	// This member is required.
	FieldId *string

	// The scope of the cell for conditional formatting.
	Scope *PivotTableConditionalFormattingScope

	// A list of cell scopes for conditional formatting.
	Scopes []PivotTableConditionalFormattingScope

	// The text format of the cell for conditional formatting.
	TextFormat *TextConditionalFormat
	// contains filtered or unexported fields
}

The cell conditional formatting option for a pivot table.

type PivotTableConditionalFormatting added in v1.28.0

type PivotTableConditionalFormatting struct {

	// Conditional formatting options for a PivotTableVisual .
	ConditionalFormattingOptions []PivotTableConditionalFormattingOption
	// contains filtered or unexported fields
}

The conditional formatting for a PivotTableVisual .

type PivotTableConditionalFormattingOption added in v1.28.0

type PivotTableConditionalFormattingOption struct {

	// The cell conditional formatting option for a pivot table.
	Cell *PivotTableCellConditionalFormatting
	// contains filtered or unexported fields
}

Conditional formatting options for a PivotTableVisual .

type PivotTableConditionalFormattingScope added in v1.28.0

type PivotTableConditionalFormattingScope struct {

	// The role (field, field total, grand total) of the cell for conditional
	// formatting.
	Role PivotTableConditionalFormattingScopeRole
	// contains filtered or unexported fields
}

The scope of the cell for conditional formatting.

type PivotTableConditionalFormattingScopeRole added in v1.28.0

type PivotTableConditionalFormattingScopeRole string
const (
	PivotTableConditionalFormattingScopeRoleField      PivotTableConditionalFormattingScopeRole = "FIELD"
	PivotTableConditionalFormattingScopeRoleFieldTotal PivotTableConditionalFormattingScopeRole = "FIELD_TOTAL"
	PivotTableConditionalFormattingScopeRoleGrandTotal PivotTableConditionalFormattingScopeRole = "GRAND_TOTAL"
)

Enum values for PivotTableConditionalFormattingScopeRole

func (PivotTableConditionalFormattingScopeRole) Values added in v1.28.0

Values returns all known values for PivotTableConditionalFormattingScopeRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PivotTableConfiguration added in v1.28.0

type PivotTableConfiguration struct {

	// The field options for a pivot table visual.
	FieldOptions *PivotTableFieldOptions

	// The field wells of the visual.
	FieldWells *PivotTableFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The paginated report options for a pivot table visual.
	PaginatedReportOptions *PivotTablePaginatedReportOptions

	// The sort configuration for a PivotTableVisual .
	SortConfiguration *PivotTableSortConfiguration

	// The table options for a pivot table visual.
	TableOptions *PivotTableOptions

	// The total options for a pivot table visual.
	TotalOptions *PivotTableTotalOptions
	// contains filtered or unexported fields
}

The configuration for a PivotTableVisual .

type PivotTableDataPathOption added in v1.28.0

type PivotTableDataPathOption struct {

	// The list of data path values for the data path options.
	//
	// This member is required.
	DataPathList []DataPathValue

	// The width of the data path option.
	Width *string
	// contains filtered or unexported fields
}

The data path options for the pivot table field options.

type PivotTableDataPathType added in v1.46.0

type PivotTableDataPathType string
const (
	PivotTableDataPathTypeHierarchyRowsLayoutColumn PivotTableDataPathType = "HIERARCHY_ROWS_LAYOUT_COLUMN"
	PivotTableDataPathTypeMultipleRowMetricsColumn  PivotTableDataPathType = "MULTIPLE_ROW_METRICS_COLUMN"
	PivotTableDataPathTypeEmptyColumnHeader         PivotTableDataPathType = "EMPTY_COLUMN_HEADER"
	PivotTableDataPathTypeCountMetricColumn         PivotTableDataPathType = "COUNT_METRIC_COLUMN"
)

Enum values for PivotTableDataPathType

func (PivotTableDataPathType) Values added in v1.46.0

Values returns all known values for PivotTableDataPathType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PivotTableFieldCollapseState added in v1.37.0

type PivotTableFieldCollapseState string
const (
	PivotTableFieldCollapseStateCollapsed PivotTableFieldCollapseState = "COLLAPSED"
	PivotTableFieldCollapseStateExpanded  PivotTableFieldCollapseState = "EXPANDED"
)

Enum values for PivotTableFieldCollapseState

func (PivotTableFieldCollapseState) Values added in v1.37.0

Values returns all known values for PivotTableFieldCollapseState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PivotTableFieldCollapseStateOption added in v1.37.0

type PivotTableFieldCollapseStateOption struct {

	// A tagged-union object that sets the collapse state.
	//
	// This member is required.
	Target *PivotTableFieldCollapseStateTarget

	// The state of the field target of a pivot table. Choose one of the following
	// options:
	//   - COLLAPSED
	//   - EXPANDED
	State PivotTableFieldCollapseState
	// contains filtered or unexported fields
}

The collapse state options for the pivot table field options.

type PivotTableFieldCollapseStateTarget added in v1.37.0

type PivotTableFieldCollapseStateTarget struct {

	// The data path of the pivot table's header. Used to set the collapse state.
	FieldDataPathValues []DataPathValue

	// The field ID of the pivot table that the collapse state needs to be set to.
	FieldId *string
	// contains filtered or unexported fields
}

The target of a pivot table field collapse state.

type PivotTableFieldOption added in v1.28.0

type PivotTableFieldOption struct {

	// The field ID of the pivot table field.
	//
	// This member is required.
	FieldId *string

	// The custom label of the pivot table field.
	CustomLabel *string

	// The visibility of the pivot table field.
	Visibility Visibility
	// contains filtered or unexported fields
}

The selected field options for the pivot table field options.

type PivotTableFieldOptions added in v1.28.0

type PivotTableFieldOptions struct {

	// The collapse state options for the pivot table field options.
	CollapseStateOptions []PivotTableFieldCollapseStateOption

	// The data path options for the pivot table field options.
	DataPathOptions []PivotTableDataPathOption

	// The selected field options for the pivot table field options.
	SelectedFieldOptions []PivotTableFieldOption
	// contains filtered or unexported fields
}

The field options for a pivot table visual.

type PivotTableFieldSubtotalOptions added in v1.28.0

type PivotTableFieldSubtotalOptions struct {

	// The field ID of the subtotal options.
	FieldId *string
	// contains filtered or unexported fields
}

The optional configuration of subtotals cells.

type PivotTableFieldWells added in v1.28.0

type PivotTableFieldWells struct {

	// The aggregated field well for the pivot table.
	PivotTableAggregatedFieldWells *PivotTableAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells for a pivot table visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type PivotTableMetricPlacement added in v1.28.0

type PivotTableMetricPlacement string
const (
	PivotTableMetricPlacementRow    PivotTableMetricPlacement = "ROW"
	PivotTableMetricPlacementColumn PivotTableMetricPlacement = "COLUMN"
)

Enum values for PivotTableMetricPlacement

func (PivotTableMetricPlacement) Values added in v1.28.0

Values returns all known values for PivotTableMetricPlacement. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PivotTableOptions added in v1.28.0

type PivotTableOptions struct {

	// The table cell style of cells.
	CellStyle *TableCellStyle

	// The visibility setting of a pivot table's collapsed row dimension fields. If
	// the value of this structure is HIDDEN , all collapsed columns in a pivot table
	// are automatically hidden. The default value is VISIBLE .
	CollapsedRowDimensionsVisibility Visibility

	// The table cell style of the column header.
	ColumnHeaderStyle *TableCellStyle

	// The visibility of the column names.
	ColumnNamesVisibility Visibility

	// The default cell width of the pivot table.
	DefaultCellWidth *string

	// The metric placement (row, column) options.
	MetricPlacement PivotTableMetricPlacement

	// The row alternate color options (widget status, row alternate colors).
	RowAlternateColorOptions *RowAlternateColorOptions

	// The table cell style of row field names.
	RowFieldNamesStyle *TableCellStyle

	// The table cell style of the row headers.
	RowHeaderStyle *TableCellStyle

	// The options for the label that is located above the row headers. This option is
	// only applicable when RowsLayout is set to HIERARCHY .
	RowsLabelOptions *PivotTableRowsLabelOptions

	// The layout for the row dimension headers of a pivot table. Choose one of the
	// following options.
	//   - TABULAR : (Default) Each row field is displayed in a separate column.
	//   - HIERARCHY : All row fields are displayed in a single column. Indentation is
	//   used to differentiate row headers of different fields.
	RowsLayout PivotTableRowsLayout

	// The visibility of the single metric options.
	SingleMetricVisibility Visibility

	// Determines the visibility of the pivot table.
	ToggleButtonsVisibility Visibility
	// contains filtered or unexported fields
}

The table options for a pivot table visual.

type PivotTablePaginatedReportOptions added in v1.28.0

type PivotTablePaginatedReportOptions struct {

	// The visibility of the repeating header rows on each page.
	OverflowColumnHeaderVisibility Visibility

	// The visibility of the printing table overflow across pages.
	VerticalOverflowVisibility Visibility
	// contains filtered or unexported fields
}

The paginated report options for a pivot table visual.

type PivotTableRowsLabelOptions added in v1.41.0

type PivotTableRowsLabelOptions struct {

	// The custom label string for the rows label.
	CustomLabel *string

	// The visibility of the rows label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY .

type PivotTableRowsLayout added in v1.41.0

type PivotTableRowsLayout string
const (
	PivotTableRowsLayoutTabular   PivotTableRowsLayout = "TABULAR"
	PivotTableRowsLayoutHierarchy PivotTableRowsLayout = "HIERARCHY"
)

Enum values for PivotTableRowsLayout

func (PivotTableRowsLayout) Values added in v1.41.0

Values returns all known values for PivotTableRowsLayout. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PivotTableSortBy added in v1.28.0

type PivotTableSortBy struct {

	// The column sort (field id, direction) for the pivot table sort by options.
	Column *ColumnSort

	// The data path sort (data path value, direction) for the pivot table sort by
	// options.
	DataPath *DataPathSort

	// The field sort (field id, direction) for the pivot table sort by options.
	Field *FieldSort
	// contains filtered or unexported fields
}

The sort by field for the field sort options.

type PivotTableSortConfiguration added in v1.28.0

type PivotTableSortConfiguration struct {

	// The field sort options for a pivot table sort configuration.
	FieldSortOptions []PivotFieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration for a PivotTableVisual .

type PivotTableSubtotalLevel added in v1.28.0

type PivotTableSubtotalLevel string
const (
	PivotTableSubtotalLevelAll    PivotTableSubtotalLevel = "ALL"
	PivotTableSubtotalLevelCustom PivotTableSubtotalLevel = "CUSTOM"
	PivotTableSubtotalLevelLast   PivotTableSubtotalLevel = "LAST"
)

Enum values for PivotTableSubtotalLevel

func (PivotTableSubtotalLevel) Values added in v1.28.0

Values returns all known values for PivotTableSubtotalLevel. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PivotTableTotalOptions added in v1.28.0

type PivotTableTotalOptions struct {

	// The column subtotal options.
	ColumnSubtotalOptions *SubtotalOptions

	// The column total options.
	ColumnTotalOptions *PivotTotalOptions

	// The row subtotal options.
	RowSubtotalOptions *SubtotalOptions

	// The row total options.
	RowTotalOptions *PivotTotalOptions
	// contains filtered or unexported fields
}

The total options for a pivot table visual.

type PivotTableVisual added in v1.28.0

type PivotTableVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *PivotTableConfiguration

	// The conditional formatting for a PivotTableVisual .
	ConditionalFormatting *PivotTableConditionalFormatting

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A pivot table. For more information, see Using pivot tables (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the Amazon QuickSight User Guide.

type PivotTotalOptions added in v1.28.0

type PivotTotalOptions struct {

	// The custom label string for the total cells.
	CustomLabel *string

	// The cell styling options for the total of header cells.
	MetricHeaderCellStyle *TableCellStyle

	// The placement (start, end) for the total cells.
	Placement TableTotalsPlacement

	// The scroll status (pinned, scrolled) for the total cells.
	ScrollStatus TableTotalsScrollStatus

	// The total aggregation options for each value field.
	TotalAggregationOptions []TotalAggregationOption

	// The cell styling options for the total cells.
	TotalCellStyle *TableCellStyle

	// The visibility configuration for the total cells.
	TotalsVisibility Visibility

	// The cell styling options for the totals of value cells.
	ValueCellStyle *TableCellStyle
	// contains filtered or unexported fields
}

The optional configuration of totals cells in a PivotTableVisual .

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
	// contains filtered or unexported fields
}

The parameters for PostgreSQL.

type PreconditionNotMetException

type PreconditionNotMetException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 PredefinedHierarchy added in v1.28.0

type PredefinedHierarchy struct {

	// The list of columns that define the predefined hierarchy.
	//
	// This member is required.
	Columns []ColumnIdentifier

	// The hierarchy ID of the predefined hierarchy.
	//
	// This member is required.
	HierarchyId *string

	// The option that determines the drill down filters for the predefined hierarchy.
	DrillDownFilters []DrillDownFilter
	// contains filtered or unexported fields
}

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

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
	// contains filtered or unexported fields
}

The parameters for Presto.

type PrimaryValueDisplayType added in v1.28.0

type PrimaryValueDisplayType string
const (
	PrimaryValueDisplayTypeHidden     PrimaryValueDisplayType = "HIDDEN"
	PrimaryValueDisplayTypeComparison PrimaryValueDisplayType = "COMPARISON"
	PrimaryValueDisplayTypeActual     PrimaryValueDisplayType = "ACTUAL"
)

Enum values for PrimaryValueDisplayType

func (PrimaryValueDisplayType) Values added in v1.28.0

Values returns all known values for PrimaryValueDisplayType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ProgressBarOptions added in v1.28.0

type ProgressBarOptions struct {

	// The visibility of the progress bar.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the presentation of the progress bar of a KPI visual.

type ProjectOperation

type ProjectOperation struct {

	// Projected columns.
	//
	// This member is required.
	ProjectedColumns []string
	// contains filtered or unexported fields
}

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

type PropertyRole added in v1.35.0

type PropertyRole string
const (
	PropertyRolePrimary PropertyRole = "PRIMARY"
	PropertyRoleId      PropertyRole = "ID"
)

Enum values for PropertyRole

func (PropertyRole) Values added in v1.35.0

func (PropertyRole) Values() []PropertyRole

Values returns all known values for PropertyRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PropertyUsage added in v1.35.0

type PropertyUsage string
const (
	PropertyUsageInherit   PropertyUsage = "INHERIT"
	PropertyUsageDimension PropertyUsage = "DIMENSION"
	PropertyUsageMeasure   PropertyUsage = "MEASURE"
)

Enum values for PropertyUsage

func (PropertyUsage) Values added in v1.35.0

func (PropertyUsage) Values() []PropertyUsage

Values returns all known values for PropertyUsage. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

Information about a queued dataset SPICE ingestion.

type QuickSightUserNotFoundException

type QuickSightUserNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 RadarChartAggregatedFieldWells added in v1.31.0

type RadarChartAggregatedFieldWells struct {

	// The aggregated field well categories of a radar chart.
	Category []DimensionField

	// The color that are assigned to the aggregated field wells of a radar chart.
	Color []DimensionField

	// The values that are assigned to the aggregated field wells of a radar chart.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field well configuration of a RadarChartVisual .

type RadarChartAreaStyleSettings added in v1.31.0

type RadarChartAreaStyleSettings struct {

	// The visibility settings of a radar chart.
	Visibility Visibility
	// contains filtered or unexported fields
}

The configured style settings of a radar chart.

type RadarChartAxesRangeScale added in v1.37.0

type RadarChartAxesRangeScale string
const (
	RadarChartAxesRangeScaleAuto        RadarChartAxesRangeScale = "AUTO"
	RadarChartAxesRangeScaleIndependent RadarChartAxesRangeScale = "INDEPENDENT"
	RadarChartAxesRangeScaleShared      RadarChartAxesRangeScale = "SHARED"
)

Enum values for RadarChartAxesRangeScale

func (RadarChartAxesRangeScale) Values added in v1.37.0

Values returns all known values for RadarChartAxesRangeScale. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RadarChartConfiguration added in v1.31.0

type RadarChartConfiguration struct {

	// Determines the visibility of the colors of alternatign bands in a radar chart.
	AlternateBandColorsVisibility Visibility

	// The color of the even-numbered alternate bands of a radar chart.
	AlternateBandEvenColor *string

	// The color of the odd-numbered alternate bands of a radar chart.
	AlternateBandOddColor *string

	// The axis behavior options of a radar chart.
	AxesRangeScale RadarChartAxesRangeScale

	// The base sreies settings of a radar chart.
	BaseSeriesSettings *RadarChartSeriesSettings

	// The category axis of a radar chart.
	CategoryAxis *AxisDisplayOptions

	// The category label options of a radar chart.
	CategoryLabelOptions *ChartAxisLabelOptions

	// The color axis of a radar chart.
	ColorAxis *AxisDisplayOptions

	// The color label options of a radar chart.
	ColorLabelOptions *ChartAxisLabelOptions

	// The field well configuration of a RadarChartVisual .
	FieldWells *RadarChartFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The shape of the radar chart.
	Shape RadarChartShape

	// The sort configuration of a RadarChartVisual .
	SortConfiguration *RadarChartSortConfiguration

	// The start angle of a radar chart's axis.
	StartAngle *float64

	// The palette (chart color) display setup of the visual.
	VisualPalette *VisualPalette
	// contains filtered or unexported fields
}

The configuration of a RadarChartVisual .

type RadarChartFieldWells added in v1.31.0

type RadarChartFieldWells struct {

	// The aggregated field wells of a radar chart visual.
	RadarChartAggregatedFieldWells *RadarChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a radar chart visual.

type RadarChartSeriesSettings added in v1.31.0

type RadarChartSeriesSettings struct {

	// The area style settings of a radar chart.
	AreaStyleSettings *RadarChartAreaStyleSettings
	// contains filtered or unexported fields
}

The series settings of a radar chart.

type RadarChartShape added in v1.31.0

type RadarChartShape string
const (
	RadarChartShapeCircle  RadarChartShape = "CIRCLE"
	RadarChartShapePolygon RadarChartShape = "POLYGON"
)

Enum values for RadarChartShape

func (RadarChartShape) Values added in v1.31.0

func (RadarChartShape) Values() []RadarChartShape

Values returns all known values for RadarChartShape. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RadarChartSortConfiguration added in v1.31.0

type RadarChartSortConfiguration struct {

	// The category items limit for a radar chart.
	CategoryItemsLimit *ItemsLimitConfiguration

	// The category sort options of a radar chart.
	CategorySort []FieldSortOptions

	// The color items limit of a radar chart.
	ColorItemsLimit *ItemsLimitConfiguration

	// The color sort configuration of a radar chart.
	ColorSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a RadarChartVisual .

type RadarChartVisual added in v1.31.0

type RadarChartVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *RadarChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A radar chart visual.

type RangeConstant added in v1.35.0

type RangeConstant struct {

	// The maximum value for a range constant.
	Maximum *string

	// The minimum value for a range constant.
	Minimum *string
	// contains filtered or unexported fields
}

A structure that represents a range constant.

type RangeEndsLabelType added in v1.28.0

type RangeEndsLabelType struct {

	// The visibility of the range ends label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The range ends label type of a data path label.

type RdsParameters

type RdsParameters struct {

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

	// Instance ID.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

The parameters for Amazon RDS.

type RedshiftIAMParameters added in v1.45.0

type RedshiftIAMParameters struct {

	// The user whose permissions and group memberships will be used by Amazon
	// QuickSight to access the cluster. If this user already exists in your database,
	// Amazon QuickSight is granted the same permissions that the user has. If the user
	// doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new
	// user with PUBLIC permissions.
	//
	// This member is required.
	DatabaseUser *string

	// Use the RoleArn structure to allow Amazon QuickSight to call
	// redshift:GetClusterCredentials on your cluster. The calling principal must have
	// iam:PassRole access to pass the role to Amazon QuickSight. The role's trust
	// policy must allow the Amazon QuickSight service principal to assume the role.
	//
	// This member is required.
	RoleArn *string

	// Automatically creates a database user. If your database doesn't have a
	// DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon
	// QuickSight can't connect to your cluster. The RoleArn that you use for this
	// operation must grant access to redshift:CreateClusterUser to successfully
	// create the user.
	AutoCreateDatabaseUser bool

	// A list of groups whose permissions will be granted to Amazon QuickSight to
	// access the cluster. These permissions are combined with the permissions granted
	// to Amazon QuickSight by the DatabaseUser . If you choose to include this
	// parameter, the RoleArn must grant access to redshift:JoinGroup .
	DatabaseGroups []string
	// contains filtered or unexported fields
}

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html) .

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

	// An optional parameter that uses IAM authentication to grant Amazon QuickSight
	// access to your cluster. This parameter can be used instead of
	// DataSourceCredentials (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html)
	// .
	IAMParameters *RedshiftIAMParameters

	// An optional parameter that configures IAM Identity Center authentication to
	// grant Amazon QuickSight access to your cluster. This parameter can only be
	// specified if your Amazon QuickSight account is configured with IAM Identity
	// Center.
	IdentityCenterConfiguration *IdentityCenterConfiguration

	// Port. This field can be blank if the ClusterId is provided.
	Port int32
	// contains filtered or unexported fields
}

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.

type ReferenceLine added in v1.28.0

type ReferenceLine struct {

	// The data configuration of the reference line.
	//
	// This member is required.
	DataConfiguration *ReferenceLineDataConfiguration

	// The label configuration of the reference line.
	LabelConfiguration *ReferenceLineLabelConfiguration

	// The status of the reference line. Choose one of the following options:
	//   - ENABLE
	//   - DISABLE
	Status WidgetStatus

	// The style configuration of the reference line.
	StyleConfiguration *ReferenceLineStyleConfiguration
	// contains filtered or unexported fields
}

The reference line visual display options.

type ReferenceLineCustomLabelConfiguration added in v1.28.0

type ReferenceLineCustomLabelConfiguration struct {

	// The string text of the custom label.
	//
	// This member is required.
	CustomLabel *string
	// contains filtered or unexported fields
}

The configuration for a custom label on a ReferenceLine .

type ReferenceLineDataConfiguration added in v1.28.0

type ReferenceLineDataConfiguration struct {

	// The axis binding type of the reference line. Choose one of the following
	// options:
	//   - PrimaryY
	//   - SecondaryY
	AxisBinding AxisBinding

	// The dynamic configuration of the reference line data configuration.
	DynamicConfiguration *ReferenceLineDynamicDataConfiguration

	// The series type of the reference line data configuration. Choose one of the
	// following options:
	//   - BAR
	//   - LINE
	SeriesType ReferenceLineSeriesType

	// The static data configuration of the reference line data configuration.
	StaticConfiguration *ReferenceLineStaticDataConfiguration
	// contains filtered or unexported fields
}

The data configuration of the reference line.

type ReferenceLineDynamicDataConfiguration added in v1.28.0

type ReferenceLineDynamicDataConfiguration struct {

	// The calculation that is used in the dynamic data.
	//
	// This member is required.
	Calculation *NumericalAggregationFunction

	// The column that the dynamic data targets.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The aggregation function that is used in the dynamic data.
	MeasureAggregationFunction *AggregationFunction
	// contains filtered or unexported fields
}

The dynamic configuration of the reference line data configuration.

type ReferenceLineLabelConfiguration added in v1.28.0

type ReferenceLineLabelConfiguration struct {

	// The custom label configuration of the label in a reference line.
	CustomLabelConfiguration *ReferenceLineCustomLabelConfiguration

	// The font color configuration of the label in a reference line.
	FontColor *string

	// The font configuration of the label in a reference line.
	FontConfiguration *FontConfiguration

	// The horizontal position configuration of the label in a reference line. Choose
	// one of the following options:
	//   - LEFT
	//   - CENTER
	//   - RIGHT
	HorizontalPosition ReferenceLineLabelHorizontalPosition

	// The value label configuration of the label in a reference line.
	ValueLabelConfiguration *ReferenceLineValueLabelConfiguration

	// The vertical position configuration of the label in a reference line. Choose
	// one of the following options:
	//   - ABOVE
	//   - BELOW
	VerticalPosition ReferenceLineLabelVerticalPosition
	// contains filtered or unexported fields
}

The label configuration of a reference line.

type ReferenceLineLabelHorizontalPosition added in v1.28.0

type ReferenceLineLabelHorizontalPosition string
const (
	ReferenceLineLabelHorizontalPositionLeft   ReferenceLineLabelHorizontalPosition = "LEFT"
	ReferenceLineLabelHorizontalPositionCenter ReferenceLineLabelHorizontalPosition = "CENTER"
	ReferenceLineLabelHorizontalPositionRight  ReferenceLineLabelHorizontalPosition = "RIGHT"
)

Enum values for ReferenceLineLabelHorizontalPosition

func (ReferenceLineLabelHorizontalPosition) Values added in v1.28.0

Values returns all known values for ReferenceLineLabelHorizontalPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceLineLabelVerticalPosition added in v1.28.0

type ReferenceLineLabelVerticalPosition string
const (
	ReferenceLineLabelVerticalPositionAbove ReferenceLineLabelVerticalPosition = "ABOVE"
	ReferenceLineLabelVerticalPositionBelow ReferenceLineLabelVerticalPosition = "BELOW"
)

Enum values for ReferenceLineLabelVerticalPosition

func (ReferenceLineLabelVerticalPosition) Values added in v1.28.0

Values returns all known values for ReferenceLineLabelVerticalPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceLinePatternType added in v1.28.0

type ReferenceLinePatternType string
const (
	ReferenceLinePatternTypeSolid  ReferenceLinePatternType = "SOLID"
	ReferenceLinePatternTypeDashed ReferenceLinePatternType = "DASHED"
	ReferenceLinePatternTypeDotted ReferenceLinePatternType = "DOTTED"
)

Enum values for ReferenceLinePatternType

func (ReferenceLinePatternType) Values added in v1.28.0

Values returns all known values for ReferenceLinePatternType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceLineSeriesType added in v1.46.0

type ReferenceLineSeriesType string
const (
	ReferenceLineSeriesTypeBar  ReferenceLineSeriesType = "BAR"
	ReferenceLineSeriesTypeLine ReferenceLineSeriesType = "LINE"
)

Enum values for ReferenceLineSeriesType

func (ReferenceLineSeriesType) Values added in v1.46.0

Values returns all known values for ReferenceLineSeriesType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceLineStaticDataConfiguration added in v1.28.0

type ReferenceLineStaticDataConfiguration struct {

	// The double input of the static data.
	//
	// This member is required.
	Value float64
	// contains filtered or unexported fields
}

The static data configuration of the reference line data configuration.

type ReferenceLineStyleConfiguration added in v1.28.0

type ReferenceLineStyleConfiguration struct {

	// The hex color of the reference line.
	Color *string

	// The pattern type of the line style. Choose one of the following options:
	//   - SOLID
	//   - DASHED
	//   - DOTTED
	Pattern ReferenceLinePatternType
	// contains filtered or unexported fields
}

The style configuration of the reference line.

type ReferenceLineValueLabelConfiguration added in v1.28.0

type ReferenceLineValueLabelConfiguration struct {

	// The format configuration of the value label.
	FormatConfiguration *NumericFormatConfiguration

	// The relative position of the value label. Choose one of the following options:
	//   - BEFORE_CUSTOM_LABEL
	//   - AFTER_CUSTOM_LABEL
	RelativePosition ReferenceLineValueLabelRelativePosition
	// contains filtered or unexported fields
}

The value label configuration of the label in a reference line.

type ReferenceLineValueLabelRelativePosition added in v1.28.0

type ReferenceLineValueLabelRelativePosition string
const (
	ReferenceLineValueLabelRelativePositionBeforeCustomLabel ReferenceLineValueLabelRelativePosition = "BEFORE_CUSTOM_LABEL"
	ReferenceLineValueLabelRelativePositionAfterCustomLabel  ReferenceLineValueLabelRelativePosition = "AFTER_CUSTOM_LABEL"
)

Enum values for ReferenceLineValueLabelRelativePosition

func (ReferenceLineValueLabelRelativePosition) Values added in v1.28.0

Values returns all known values for ReferenceLineValueLabelRelativePosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RefreshConfiguration added in v1.34.0

type RefreshConfiguration struct {

	// The incremental refresh for the dataset.
	//
	// This member is required.
	IncrementalRefresh *IncrementalRefresh
	// contains filtered or unexported fields
}

The refresh configuration of a dataset.

type RefreshFrequency added in v1.34.0

type RefreshFrequency struct {

	// The interval between scheduled refreshes. Valid values are as follows:
	//   - MINUTE15 : The dataset refreshes every 15 minutes. This value is only
	//   supported for incremental refreshes. This interval can only be used for one
	//   schedule per dataset.
	//   - MINUTE30 :The dataset refreshes every 30 minutes. This value is only
	//   supported for incremental refreshes. This interval can only be used for one
	//   schedule per dataset.
	//   - HOURLY : The dataset refreshes every hour. This interval can only be used
	//   for one schedule per dataset.
	//   - DAILY : The dataset refreshes every day.
	//   - WEEKLY : The dataset refreshes every week.
	//   - MONTHLY : The dataset refreshes every month.
	//
	// This member is required.
	Interval RefreshInterval

	// The day of the week that you want to schedule the refresh on. This value is
	// required for weekly and monthly refresh intervals.
	RefreshOnDay *ScheduleRefreshOnEntity

	// The time of day that you want the datset to refresh. This value is expressed in
	// HH:MM format. This field is not required for schedules that refresh hourly.
	TimeOfTheDay *string

	// The timezone that you want the refresh schedule to use. The timezone ID must
	// match a corresponding ID found on java.util.time.getAvailableIDs() .
	Timezone *string
	// contains filtered or unexported fields
}

Specifies the interval between each scheduled refresh of a dataset.

type RefreshInterval added in v1.34.0

type RefreshInterval string
const (
	RefreshIntervalMinute15 RefreshInterval = "MINUTE15"
	RefreshIntervalMinute30 RefreshInterval = "MINUTE30"
	RefreshIntervalHourly   RefreshInterval = "HOURLY"
	RefreshIntervalDaily    RefreshInterval = "DAILY"
	RefreshIntervalWeekly   RefreshInterval = "WEEKLY"
	RefreshIntervalMonthly  RefreshInterval = "MONTHLY"
)

Enum values for RefreshInterval

func (RefreshInterval) Values added in v1.34.0

func (RefreshInterval) Values() []RefreshInterval

Values returns all known values for RefreshInterval. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RefreshSchedule added in v1.34.0

type RefreshSchedule struct {

	// The type of refresh that a datset undergoes. Valid values are as follows:
	//   - FULL_REFRESH : A complete refresh of a dataset.
	//   - INCREMENTAL_REFRESH : A partial refresh of some rows of a dataset, based on
	//   the time window specified.
	// For more information on full and incremental refreshes, see Refreshing SPICE
	// data (https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html)
	// in the Amazon QuickSight User Guide.
	//
	// This member is required.
	RefreshType IngestionType

	// The frequency for the refresh schedule.
	//
	// This member is required.
	ScheduleFrequency *RefreshFrequency

	// An identifier for the refresh schedule.
	//
	// This member is required.
	ScheduleId *string

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

	// Time after which the refresh schedule can be started, expressed in
	// YYYY-MM-DDTHH:MM:SS format.
	StartAfterDateTime *time.Time
	// contains filtered or unexported fields
}

The refresh schedule of a dataset.

type RegisteredUserConsoleFeatureConfigurations added in v1.33.0

type RegisteredUserConsoleFeatureConfigurations struct {

	// The state persistence configurations of an embedded Amazon QuickSight console.
	StatePersistence *StatePersistenceConfigurations
	// contains filtered or unexported fields
}

The feature configurations of an embedded Amazon QuickSight console.

type RegisteredUserDashboardEmbeddingConfiguration added in v1.7.0

type RegisteredUserDashboardEmbeddingConfiguration struct {

	// The dashboard ID for the dashboard that you want the user to see first. This ID
	// is included in the output URL. When the URL in response is accessed, Amazon
	// QuickSight renders this dashboard if the user has permissions to view it. If the
	// user does not have permission to view this dashboard, they see a permissions
	// error message.
	//
	// This member is required.
	InitialDashboardId *string

	// The feature configurations of an embbedded Amazon QuickSight dashboard.
	FeatureConfigurations *RegisteredUserDashboardFeatureConfigurations
	// contains filtered or unexported fields
}

Information about the dashboard you want to embed.

type RegisteredUserDashboardFeatureConfigurations added in v1.33.0

type RegisteredUserDashboardFeatureConfigurations struct {

	// The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
	Bookmarks *BookmarksConfigurations

	// The state persistence settings of an embedded dashboard.
	StatePersistence *StatePersistenceConfigurations
	// contains filtered or unexported fields
}

The feature configuration for an embedded dashboard.

type RegisteredUserDashboardVisualEmbeddingConfiguration added in v1.24.0

type RegisteredUserDashboardVisualEmbeddingConfiguration struct {

	// The visual ID for the visual that you want the user to embed. This ID is
	// included in the output URL. When the URL in response is accessed, Amazon
	// QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard
	// that the visual belongs to must be included in the AuthorizedResourceArns
	// parameter. Otherwise, the request will fail with InvalidParameterValueException .
	//
	// This member is required.
	InitialDashboardVisualId *DashboardVisualId
	// contains filtered or unexported fields
}

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

type RegisteredUserEmbeddingExperienceConfiguration added in v1.7.0

type RegisteredUserEmbeddingExperienceConfiguration struct {

	// The configuration details for providing a dashboard embedding experience.
	Dashboard *RegisteredUserDashboardEmbeddingConfiguration

	// The type of embedding experience. In this case, Amazon QuickSight visuals.
	DashboardVisual *RegisteredUserDashboardVisualEmbeddingConfiguration

	// The configuration details for embedding the Q search bar. For more information
	// about embedding the Q search bar, see Embedding Overview (https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html)
	// in the Amazon QuickSight User Guide.
	QSearchBar *RegisteredUserQSearchBarEmbeddingConfiguration

	// The configuration details for providing each Amazon QuickSight console
	// embedding experience. This can be used along with custom permissions to restrict
	// access to certain features. For more information, see Customizing Access to the
	// Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
	// in the Amazon QuickSight User Guide. Use GenerateEmbedUrlForRegisteredUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html)
	// where you want to provide an authoring portal that allows users to create data
	// sources, datasets, analyses, and dashboards. The users who accesses an embedded
	// Amazon QuickSight console needs to belong to the author or admin security
	// cohort. If you want to restrict permissions to some of these features, add a
	// custom permissions profile to the user with the UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html)
	// API operation. Use the RegisterUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html)
	// API operation to add a new user with a custom permission profile attached. For
	// more information, see the following sections in the Amazon QuickSight User
	// Guide:
	//   - Embedding the Full Functionality of the Amazon QuickSight Console for
	//   Authenticated Users (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html)
	//   - Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
	// For more information about the high-level steps for embedding and for an
	// interactive demo of the ways you can customize embedding, visit the Amazon
	// QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html)
	// .
	QuickSightConsole *RegisteredUserQuickSightConsoleEmbeddingConfiguration
	// contains filtered or unexported fields
}

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console. Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole . You cannot choose more than one experience configuration.

type RegisteredUserQSearchBarEmbeddingConfiguration added in v1.14.0

type RegisteredUserQSearchBarEmbeddingConfiguration struct {

	// The ID of the Q topic that you want to make the starting topic in the Q search
	// bar. You can find a topic ID by navigating to the Topics pane in the Amazon
	// QuickSight application and opening a topic. The ID is in the URL for the topic
	// that you open. If you don't specify an initial topic, a list of all shared
	// topics is shown in the Q bar for your readers. When you select an initial topic,
	// you can specify whether or not readers are allowed to select other topics from
	// the available ones in the list.
	InitialTopicId *string
	// contains filtered or unexported fields
}

Information about the Q search bar embedding experience.

type RegisteredUserQuickSightConsoleEmbeddingConfiguration added in v1.7.0

type RegisteredUserQuickSightConsoleEmbeddingConfiguration struct {

	// The embedding configuration of an embedded Amazon QuickSight console.
	FeatureConfigurations *RegisteredUserConsoleFeatureConfigurations

	// The initial URL path for the Amazon QuickSight console. InitialPath is
	// required. The entry point URL is constrained to the following paths:
	//   - /start
	//   - /start/analyses
	//   - /start/dashboards
	//   - /start/favorites
	//   - /dashboards/DashboardId . DashboardId is the actual ID key from the Amazon
	//   QuickSight console URL of the dashboard.
	//   - /analyses/AnalysisId . AnalysisId is the actual ID key from the Amazon
	//   QuickSight console URL of the analysis.
	InitialPath *string
	// contains filtered or unexported fields
}

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

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 catalog associated with a table.
	Catalog *string

	// The schema name. This name applies to certain relational database engines.
	Schema *string
	// contains filtered or unexported fields
}

A physical table type for relational data sources.

type RelativeDateTimeControlDisplayOptions added in v1.28.0

type RelativeDateTimeControlDisplayOptions struct {

	// Customize how dates are formatted in controls.
	DateTimeFormat *string

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type RelativeDateType added in v1.28.0

type RelativeDateType string
const (
	RelativeDateTypePrevious RelativeDateType = "PREVIOUS"
	RelativeDateTypeThis     RelativeDateType = "THIS"
	RelativeDateTypeLast     RelativeDateType = "LAST"
	RelativeDateTypeNow      RelativeDateType = "NOW"
	RelativeDateTypeNext     RelativeDateType = "NEXT"
)

Enum values for RelativeDateType

func (RelativeDateType) Values added in v1.28.0

Values returns all known values for RelativeDateType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RelativeDatesFilter added in v1.28.0

type RelativeDatesFilter struct {

	// The date configuration of the filter.
	//
	// This member is required.
	AnchorDateConfiguration *AnchorDateConfiguration

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	//
	// This member is required.
	NullOption FilterNullOption

	// The range date type of the filter. Choose one of the options below:
	//   - PREVIOUS
	//   - THIS
	//   - LAST
	//   - NOW
	//   - NEXT
	//
	// This member is required.
	RelativeDateType RelativeDateType

	// The level of time precision that is used to aggregate DateTime values.
	//
	// This member is required.
	TimeGranularity TimeGranularity

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration

	// The configuration for the exclude period of the filter.
	ExcludePeriodConfiguration *ExcludePeriodConfiguration

	// The minimum granularity (period granularity) of the relative dates filter.
	MinimumGranularity TimeGranularity

	// The parameter whose value should be used for the filter value.
	ParameterName *string

	// The date value of the filter.
	RelativeDateValue *int32
	// contains filtered or unexported fields
}

A RelativeDatesFilter filters relative dates values.

type RelativeFontSize added in v1.28.0

type RelativeFontSize string
const (
	RelativeFontSizeExtraSmall RelativeFontSize = "EXTRA_SMALL"
	RelativeFontSizeSmall      RelativeFontSize = "SMALL"
	RelativeFontSizeMedium     RelativeFontSize = "MEDIUM"
	RelativeFontSizeLarge      RelativeFontSize = "LARGE"
	RelativeFontSizeExtraLarge RelativeFontSize = "EXTRA_LARGE"
)

Enum values for RelativeFontSize

func (RelativeFontSize) Values added in v1.28.0

Values returns all known values for RelativeFontSize. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

A transform operation that renames a column.

type ResizeOption added in v1.28.0

type ResizeOption string
const (
	ResizeOptionFixed      ResizeOption = "FIXED"
	ResizeOptionResponsive ResizeOption = "RESPONSIVE"
)

Enum values for ResizeOption

func (ResizeOption) Values added in v1.28.0

func (ResizeOption) Values() []ResizeOption

Values returns all known values for ResizeOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceExistsException

type ResourceExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType ExceptionResourceType
	RequestId    *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	ResourceType ExceptionResourceType
	RequestId    *string
	// contains filtered or unexported fields
}

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 IAM action to grant or revoke permissions on.
	//
	// 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 or group associated with a data source
	//   or dataset. (This is common.)
	//   - The ARN of an Amazon QuickSight user, group, or namespace associated with
	//   an analysis, dashboard, template, or theme. (This is common.)
	//   - The ARN of an Amazon Web Services account root: This is an IAM ARN rather
	//   than a QuickSight ARN. Use this option only to share resources (templates)
	//   across Amazon Web Services accounts. (This is less common.)
	//
	// This member is required.
	Principal *string
	// contains filtered or unexported fields
}

Permission for the resource.

type ResourceStatus

type ResourceStatus string
const (
	ResourceStatusCreationInProgress ResourceStatus = "CREATION_IN_PROGRESS"
	ResourceStatusCreationSuccessful ResourceStatus = "CREATION_SUCCESSFUL"
	ResourceStatusCreationFailed     ResourceStatus = "CREATION_FAILED"
	ResourceStatusUpdateInProgress   ResourceStatus = "UPDATE_IN_PROGRESS"
	ResourceStatusUpdateSuccessful   ResourceStatus = "UPDATE_SUCCESSFUL"
	ResourceStatusUpdateFailed       ResourceStatus = "UPDATE_FAILED"
	ResourceStatusDeleted            ResourceStatus = "DELETED"
)

Enum values for ResourceStatus

func (ResourceStatus) Values added in v0.29.0

func (ResourceStatus) Values() []ResourceStatus

Values returns all known values for ResourceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceUnavailableException

type ResourceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType ExceptionResourceType
	RequestId    *string
	// contains filtered or unexported fields
}

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 Role added in v1.51.0

type Role string
const (
	RoleAdmin  Role = "ADMIN"
	RoleAuthor Role = "AUTHOR"
	RoleReader Role = "READER"
)

Enum values for Role

func (Role) Values added in v1.51.0

func (Role) Values() []Role

Values returns all known values for Role. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RollingDateConfiguration added in v1.28.0

type RollingDateConfiguration struct {

	// The expression of the rolling date configuration.
	//
	// This member is required.
	Expression *string

	// The data set that is used in the rolling date configuration.
	DataSetIdentifier *string
	// contains filtered or unexported fields
}

The rolling date configuration of a date time filter.

type RowAlternateColorOptions added in v1.28.0

type RowAlternateColorOptions struct {

	// Determines the list of row alternate colors.
	RowAlternateColors []string

	// Determines the widget status.
	Status WidgetStatus

	// The primary background color options for alternate rows.
	UsePrimaryBackgroundColor WidgetStatus
	// contains filtered or unexported fields
}

Determines the row alternate color options.

type RowInfo

type RowInfo struct {

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

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

	// The total number of rows in the dataset.
	TotalRowsInDataset *int64
	// contains filtered or unexported fields
}

Information about rows for a data set SPICE ingestion.

type RowLevelPermissionDataSet

type RowLevelPermissionDataSet struct {

	// The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
	//
	// This member is required.
	Arn *string

	// The type of permissions to use when interpreting the permissions for RLS.
	// DENY_ACCESS is included for backward compatibility only.
	//
	// This member is required.
	PermissionPolicy RowLevelPermissionPolicy

	// The user or group rules associated with the dataset that contains permissions
	// for RLS. By default, FormatVersion is VERSION_1 . When FormatVersion is
	// VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2
	// , UserARN and GroupARN are required, and Namespace must not exist.
	FormatVersion RowLevelPermissionFormatVersion

	// The namespace associated with the dataset that contains permissions for RLS.
	Namespace *string

	// The status of the row-level security permission dataset. If enabled, the status
	// is ENABLED . If disabled, the status is DISABLED .
	Status Status
	// contains filtered or unexported fields
}

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

type RowLevelPermissionFormatVersion added in v1.4.0

type RowLevelPermissionFormatVersion string
const (
	RowLevelPermissionFormatVersionVersion1 RowLevelPermissionFormatVersion = "VERSION_1"
	RowLevelPermissionFormatVersionVersion2 RowLevelPermissionFormatVersion = "VERSION_2"
)

Enum values for RowLevelPermissionFormatVersion

func (RowLevelPermissionFormatVersion) Values added in v1.4.0

Values returns all known values for RowLevelPermissionFormatVersion. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RowLevelPermissionPolicy

type RowLevelPermissionPolicy string
const (
	RowLevelPermissionPolicyGrantAccess RowLevelPermissionPolicy = "GRANT_ACCESS"
	RowLevelPermissionPolicyDenyAccess  RowLevelPermissionPolicy = "DENY_ACCESS"
)

Enum values for RowLevelPermissionPolicy

func (RowLevelPermissionPolicy) Values added in v0.29.0

Values returns all known values for RowLevelPermissionPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RowLevelPermissionTagConfiguration added in v1.7.0

type RowLevelPermissionTagConfiguration struct {

	// A set of rules associated with row-level security, such as the tag names and
	// columns that they are assigned to.
	//
	// This member is required.
	TagRules []RowLevelPermissionTagRule

	// The status of row-level security tags. If enabled, the status is ENABLED . If
	// disabled, the status is DISABLED .
	Status Status

	// A list of tag configuration rules to apply to a dataset. All tag configurations
	// have the OR condition. Tags within each tile will be joined (AND). At least one
	// rule in this structure must have all tag values assigned to it to apply
	// Row-level security (RLS) to the dataset.
	TagRuleConfigurations [][]string
	// contains filtered or unexported fields
}

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

type RowLevelPermissionTagRule added in v1.7.0

type RowLevelPermissionTagRule struct {

	// The column name that a tag key is assigned to.
	//
	// This member is required.
	ColumnName *string

	// The unique key for a tag.
	//
	// This member is required.
	TagKey *string

	// A string that you want to use to filter by all the values in a column in the
	// dataset and don’t want to list the values one by one. For example, you can use
	// an asterisk as your match all value.
	MatchAllValue *string

	// A string that you want to use to delimit the values when you pass the values at
	// run time. For example, you can delimit the values with a comma.
	TagMultiValueDelimiter *string
	// contains filtered or unexported fields
}

A set of rules associated with a tag.

type S3BucketConfiguration added in v1.39.0

type S3BucketConfiguration struct {

	// The name of an existing Amazon S3 bucket where the generated snapshot artifacts
	// are sent.
	//
	// This member is required.
	BucketName *string

	// The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
	//
	// This member is required.
	BucketPrefix *string

	// The region that the Amazon S3 bucket is located in. The bucket must be located
	// in the same region that the StartDashboardSnapshotJob API call is made.
	//
	// This member is required.
	BucketRegion *string
	// contains filtered or unexported fields
}

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

type S3Parameters

type S3Parameters struct {

	// Location of the Amazon S3 manifest file. This is NULL if the manifest file was
	// uploaded into Amazon QuickSight.
	//
	// This member is required.
	ManifestFileLocation *ManifestFileLocation

	// Use the RoleArn structure to override an account-wide role for a specific S3
	// data source. For example, say an account administrator has turned off all S3
	// access with an account-wide role. The administrator can then use RoleArn to
	// bypass the account-wide role and allow S3 access for the single S3 data source
	// that is specified in the structure, even if the account-wide role forbidding S3
	// access is still active.
	RoleArn *string
	// contains filtered or unexported fields
}

The parameters for S3.

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 an S3 data source. For files that aren't JSON, only
	// STRING data types are supported in input columns.
	//
	// This member is required.
	InputColumns []InputColumn

	// Information about the format for the S3 source file or files.
	UploadSettings *UploadSettings
	// contains filtered or unexported fields
}

A physical table type for an S3 data source.

type SameSheetTargetVisualConfiguration added in v1.28.0

type SameSheetTargetVisualConfiguration struct {

	// The options that choose the target visual in the same sheet. Valid values are
	// defined as follows:
	//   - ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
	TargetVisualOptions TargetVisualOptions

	// A list of the target visual IDs that are located in the same sheet of the
	// analysis.
	TargetVisuals []string
	// contains filtered or unexported fields
}

The configuration of the same-sheet target visuals that you want to be filtered. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type SankeyDiagramAggregatedFieldWells added in v1.28.0

type SankeyDiagramAggregatedFieldWells struct {

	// The destination field wells of a sankey diagram.
	Destination []DimensionField

	// The source field wells of a sankey diagram.
	Source []DimensionField

	// The weight field wells of a sankey diagram.
	Weight []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a sankey diagram.

type SankeyDiagramChartConfiguration added in v1.28.0

type SankeyDiagramChartConfiguration struct {

	// The data label configuration of a sankey diagram.
	DataLabels *DataLabelOptions

	// The field well configuration of a sankey diagram.
	FieldWells *SankeyDiagramFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The sort configuration of a sankey diagram.
	SortConfiguration *SankeyDiagramSortConfiguration
	// contains filtered or unexported fields
}

The configuration of a sankey diagram.

type SankeyDiagramFieldWells added in v1.28.0

type SankeyDiagramFieldWells struct {

	// The field well configuration of a sankey diagram.
	SankeyDiagramAggregatedFieldWells *SankeyDiagramAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a sankey diagram.

type SankeyDiagramSortConfiguration added in v1.28.0

type SankeyDiagramSortConfiguration struct {

	// The limit on the number of destination nodes that are displayed in a sankey
	// diagram.
	DestinationItemsLimit *ItemsLimitConfiguration

	// The limit on the number of source nodes that are displayed in a sankey diagram.
	SourceItemsLimit *ItemsLimitConfiguration

	// The sort configuration of the weight fields.
	WeightSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a sankey diagram.

type SankeyDiagramVisual added in v1.28.0

type SankeyDiagramVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration of a sankey diagram.
	ChartConfiguration *SankeyDiagramChartConfiguration

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A sankey diagram. For more information, see Using Sankey diagrams (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the Amazon QuickSight User Guide.

type ScatterPlotCategoricallyAggregatedFieldWells added in v1.28.0

type ScatterPlotCategoricallyAggregatedFieldWells struct {

	// The category field well of a scatter plot.
	Category []DimensionField

	// The label field well of a scatter plot.
	Label []DimensionField

	// The size field well of a scatter plot.
	Size []MeasureField

	// The x-axis field well of a scatter plot. The x-axis is aggregated by category.
	XAxis []MeasureField

	// The y-axis field well of a scatter plot. The y-axis is aggregated by category.
	YAxis []MeasureField
	// contains filtered or unexported fields
}

The aggregated field well of a scatter plot.

type ScatterPlotConfiguration added in v1.28.0

type ScatterPlotConfiguration struct {

	// The options that determine if visual data labels are displayed.
	DataLabels *DataLabelOptions

	// The field wells of the visual.
	FieldWells *ScatterPlotFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The sort configuration of a scatter plot.
	SortConfiguration *ScatterPlotSortConfiguration

	// The legend display setup of the visual.
	Tooltip *TooltipOptions

	// The palette (chart color) display setup of the visual.
	VisualPalette *VisualPalette

	// The label display options (grid line, range, scale, and axis step) of the
	// scatter plot's x-axis.
	XAxisDisplayOptions *AxisDisplayOptions

	// The label options (label text, label visibility, and sort icon visibility) of
	// the scatter plot's x-axis.
	XAxisLabelOptions *ChartAxisLabelOptions

	// The label display options (grid line, range, scale, and axis step) of the
	// scatter plot's y-axis.
	YAxisDisplayOptions *AxisDisplayOptions

	// The label options (label text, label visibility, and sort icon visibility) of
	// the scatter plot's y-axis.
	YAxisLabelOptions *ChartAxisLabelOptions
	// contains filtered or unexported fields
}

The configuration of a scatter plot.

type ScatterPlotFieldWells added in v1.28.0

type ScatterPlotFieldWells struct {

	// The aggregated field wells of a scatter plot. The x and y-axes of scatter plots
	// with aggregated field wells are aggregated by category, label, or both.
	ScatterPlotCategoricallyAggregatedFieldWells *ScatterPlotCategoricallyAggregatedFieldWells

	// The unaggregated field wells of a scatter plot. The x and y-axes of these
	// scatter plots are unaggregated.
	ScatterPlotUnaggregatedFieldWells *ScatterPlotUnaggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a scatter plot. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ScatterPlotSortConfiguration added in v1.54.0

type ScatterPlotSortConfiguration struct {

	// The limit configuration of the visual display for an axis.
	ScatterPlotLimitConfiguration *ItemsLimitConfiguration
	// contains filtered or unexported fields
}

The sort configuration of a scatter plot.

type ScatterPlotUnaggregatedFieldWells added in v1.28.0

type ScatterPlotUnaggregatedFieldWells struct {

	// The category field well of a scatter plot.
	Category []DimensionField

	// The label field well of a scatter plot.
	Label []DimensionField

	// The size field well of a scatter plot.
	Size []MeasureField

	// The x-axis field well of a scatter plot. The x-axis is a dimension field and
	// cannot be aggregated.
	XAxis []DimensionField

	// The y-axis field well of a scatter plot. The y-axis is a dimension field and
	// cannot be aggregated.
	YAxis []DimensionField
	// contains filtered or unexported fields
}

The unaggregated field wells of a scatter plot.

type ScatterPlotVisual added in v1.28.0

type ScatterPlotVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *ScatterPlotConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A scatter plot. For more information, see Using scatter plots (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the Amazon QuickSight User Guide.

type ScheduleRefreshOnEntity added in v1.34.0

type ScheduleRefreshOnEntity struct {

	// The day of the month that you want to schedule refresh on.
	DayOfMonth *string

	// The day of the week that you want to schedule a refresh on.
	DayOfWeek DayOfWeek
	// contains filtered or unexported fields
}

The refresh on entity for weekly or monthly schedules.

type ScrollBarOptions added in v1.28.0

type ScrollBarOptions struct {

	// The visibility of the data zoom scroll bar.
	Visibility Visibility

	// The visibility range for the data zoom scroll bar.
	VisibleRange *VisibleRangeOptions
	// contains filtered or unexported fields
}

The visual display options for a data zoom scroll bar.

type SecondaryValueOptions added in v1.28.0

type SecondaryValueOptions struct {

	// Determines the visibility of the secondary value.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the presentation of the secondary value of a KPI visual.

type SectionAfterPageBreak added in v1.28.0

type SectionAfterPageBreak struct {

	// The option that enables or disables a page break at the end of a section.
	Status SectionPageBreakStatus
	// contains filtered or unexported fields
}

The configuration of a page break after a section.

type SectionBasedLayoutCanvasSizeOptions added in v1.28.0

type SectionBasedLayoutCanvasSizeOptions struct {

	// The options for a paper canvas of a section-based layout.
	PaperCanvasSizeOptions *SectionBasedLayoutPaperCanvasSizeOptions
	// contains filtered or unexported fields
}

The options for the canvas of a section-based layout.

type SectionBasedLayoutConfiguration added in v1.28.0

type SectionBasedLayoutConfiguration struct {

	// A list of body section configurations.
	//
	// This member is required.
	BodySections []BodySectionConfiguration

	// The options for the canvas of a section-based layout.
	//
	// This member is required.
	CanvasSizeOptions *SectionBasedLayoutCanvasSizeOptions

	// A list of footer section configurations.
	//
	// This member is required.
	FooterSections []HeaderFooterSectionConfiguration

	// A list of header section configurations.
	//
	// This member is required.
	HeaderSections []HeaderFooterSectionConfiguration
	// contains filtered or unexported fields
}

The configuration for a section-based layout.

type SectionBasedLayoutPaperCanvasSizeOptions added in v1.28.0

type SectionBasedLayoutPaperCanvasSizeOptions struct {

	// Defines the spacing between the canvas content and the top, bottom, left, and
	// right edges.
	PaperMargin *Spacing

	// The paper orientation that is used to define canvas dimensions. Choose one of
	// the following options:
	//   - PORTRAIT
	//   - LANDSCAPE
	PaperOrientation PaperOrientation

	// The paper size that is used to define canvas dimensions.
	PaperSize PaperSize
	// contains filtered or unexported fields
}

The options for a paper canvas of a section-based layout.

type SectionLayoutConfiguration added in v1.28.0

type SectionLayoutConfiguration struct {

	// The free-form layout configuration of a section.
	//
	// This member is required.
	FreeFormLayout *FreeFormSectionLayoutConfiguration
	// contains filtered or unexported fields
}

The layout configuration of a section.

type SectionPageBreakConfiguration added in v1.28.0

type SectionPageBreakConfiguration struct {

	// The configuration of a page break after a section.
	After *SectionAfterPageBreak
	// contains filtered or unexported fields
}

The configuration of a page break for a section.

type SectionPageBreakStatus added in v1.28.0

type SectionPageBreakStatus string
const (
	SectionPageBreakStatusEnabled  SectionPageBreakStatus = "ENABLED"
	SectionPageBreakStatusDisabled SectionPageBreakStatus = "DISABLED"
)

Enum values for SectionPageBreakStatus

func (SectionPageBreakStatus) Values added in v1.28.0

Values returns all known values for SectionPageBreakStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SectionStyle added in v1.28.0

type SectionStyle struct {

	// The height of a section. Heights can only be defined for header and footer
	// sections. The default height margin is 0.5 inches.
	Height *string

	// The spacing between section content and its top, bottom, left, and right edges.
	// There is no padding by default.
	Padding *Spacing
	// contains filtered or unexported fields
}

The options that style a section.

type SelectAllValueOptions added in v1.28.0

type SelectAllValueOptions string
const (
	SelectAllValueOptionsAllValues SelectAllValueOptions = "ALL_VALUES"
)

Enum values for SelectAllValueOptions

func (SelectAllValueOptions) Values added in v1.28.0

Values returns all known values for SelectAllValueOptions. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SelectedFieldOptions added in v1.28.0

type SelectedFieldOptions string
const (
	SelectedFieldOptionsAllFields SelectedFieldOptions = "ALL_FIELDS"
)

Enum values for SelectedFieldOptions

func (SelectedFieldOptions) Values added in v1.28.0

Values returns all known values for SelectedFieldOptions. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SelectedSheetsFilterScopeConfiguration added in v1.28.0

type SelectedSheetsFilterScopeConfiguration struct {

	// The sheet ID and visual IDs of the sheet and visuals that the filter is applied
	// to.
	SheetVisualScopingConfigurations []SheetVisualScopingConfiguration
	// contains filtered or unexported fields
}

The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type SelectedTooltipType added in v1.28.0

type SelectedTooltipType string
const (
	SelectedTooltipTypeBasic    SelectedTooltipType = "BASIC"
	SelectedTooltipTypeDetailed SelectedTooltipType = "DETAILED"
)

Enum values for SelectedTooltipType

func (SelectedTooltipType) Values added in v1.28.0

Values returns all known values for SelectedTooltipType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SemanticEntityType added in v1.35.0

type SemanticEntityType struct {

	// The semantic entity sub type name.
	SubTypeName *string

	// The semantic entity type name.
	TypeName *string

	// The semantic entity type parameters.
	TypeParameters map[string]string
	// contains filtered or unexported fields
}

A structure that represents a semantic entity type.

type SemanticType added in v1.35.0

type SemanticType struct {

	// The semantic type falsey cell value.
	FalseyCellValue *string

	// The other names or aliases for the false cell value.
	FalseyCellValueSynonyms []string

	// The semantic type sub type name.
	SubTypeName *string

	// The semantic type truthy cell value.
	TruthyCellValue *string

	// The other names or aliases for the true cell value.
	TruthyCellValueSynonyms []string

	// The semantic type name.
	TypeName *string

	// The semantic type parameters.
	TypeParameters map[string]string
	// contains filtered or unexported fields
}

A structure that represents a semantic type.

type SeriesItem added in v1.28.0

type SeriesItem struct {

	// The data field series item configuration of a line chart.
	DataFieldSeriesItem *DataFieldSeriesItem

	// The field series item configuration of a line chart.
	FieldSeriesItem *FieldSeriesItem
	// contains filtered or unexported fields
}

The series item configuration of a line chart. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type ServiceNowParameters

type ServiceNowParameters struct {

	// URL of the base site.
	//
	// This member is required.
	SiteBaseUrl *string
	// contains filtered or unexported fields
}

The parameters for ServiceNow.

type ServiceType added in v1.52.0

type ServiceType string
const (
	ServiceTypeRedshift ServiceType = "REDSHIFT"
)

Enum values for ServiceType

func (ServiceType) Values added in v1.52.0

func (ServiceType) Values() []ServiceType

Values returns all known values for ServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SessionLifetimeInMinutesInvalidException

type SessionLifetimeInMinutesInvalidException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 SessionTag added in v1.7.0

type SessionTag struct {

	// The key for the tag.
	//
	// This member is required.
	Key *string

	// The value that you want to assign the tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

type SetParameterValueConfiguration added in v1.28.0

type SetParameterValueConfiguration struct {

	// The destination parameter name of the SetParameterValueConfiguration .
	//
	// This member is required.
	DestinationParameterName *string

	// The configuration of destination parameter values. This is a union type
	// structure. For this structure to be valid, only one of the attributes can be
	// defined.
	//
	// This member is required.
	Value *DestinationParameterValueConfiguration
	// contains filtered or unexported fields
}

The configuration of adding parameters in action.

type ShapeConditionalFormat added in v1.28.0

type ShapeConditionalFormat struct {

	// The conditional formatting for the shape background color of a filled map
	// visual.
	//
	// This member is required.
	BackgroundColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The shape conditional formatting of a filled map visual.

type SharingModel added in v1.42.0

type SharingModel string
const (
	SharingModelAccount   SharingModel = "ACCOUNT"
	SharingModelNamespace SharingModel = "NAMESPACE"
)

Enum values for SharingModel

func (SharingModel) Values added in v1.42.0

func (SharingModel) Values() []SharingModel

Values returns all known values for SharingModel. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Sheet added in v0.29.0

type Sheet struct {

	// The name of a sheet. This name is displayed on the sheet's tab in the Amazon
	// QuickSight console.
	Name *string

	// The unique identifier associated with a sheet.
	SheetId *string
	// contains filtered or unexported fields
}

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.

type SheetContentType added in v1.28.0

type SheetContentType string
const (
	SheetContentTypePaginated   SheetContentType = "PAGINATED"
	SheetContentTypeInteractive SheetContentType = "INTERACTIVE"
)

Enum values for SheetContentType

func (SheetContentType) Values added in v1.28.0

Values returns all known values for SheetContentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SheetControlDateTimePickerType added in v1.28.0

type SheetControlDateTimePickerType string
const (
	SheetControlDateTimePickerTypeSingleValued SheetControlDateTimePickerType = "SINGLE_VALUED"
	SheetControlDateTimePickerTypeDateRange    SheetControlDateTimePickerType = "DATE_RANGE"
)

Enum values for SheetControlDateTimePickerType

func (SheetControlDateTimePickerType) Values added in v1.28.0

Values returns all known values for SheetControlDateTimePickerType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SheetControlInfoIconLabelOptions added in v1.39.0

type SheetControlInfoIconLabelOptions struct {

	// The text content of info icon.
	InfoIconText *string

	// The visibility configuration of info icon label options.
	Visibility Visibility
	// contains filtered or unexported fields
}

A control to display info icons for filters and parameters.

type SheetControlLayout added in v1.28.0

type SheetControlLayout struct {

	// The configuration that determines the elements and canvas size options of sheet
	// control.
	//
	// This member is required.
	Configuration *SheetControlLayoutConfiguration
	// contains filtered or unexported fields
}

A grid layout to define the placement of sheet control.

type SheetControlLayoutConfiguration added in v1.28.0

type SheetControlLayoutConfiguration struct {

	// The configuration that determines the elements and canvas size options of sheet
	// control.
	GridLayout *GridLayoutConfiguration
	// contains filtered or unexported fields
}

The configuration that determines the elements and canvas size options of sheet control.

type SheetControlListType added in v1.28.0

type SheetControlListType string
const (
	SheetControlListTypeMultiSelect  SheetControlListType = "MULTI_SELECT"
	SheetControlListTypeSingleSelect SheetControlListType = "SINGLE_SELECT"
)

Enum values for SheetControlListType

func (SheetControlListType) Values added in v1.28.0

Values returns all known values for SheetControlListType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SheetControlSliderType added in v1.28.0

type SheetControlSliderType string
const (
	SheetControlSliderTypeSinglePoint SheetControlSliderType = "SINGLE_POINT"
	SheetControlSliderTypeRange       SheetControlSliderType = "RANGE"
)

Enum values for SheetControlSliderType

func (SheetControlSliderType) Values added in v1.28.0

Values returns all known values for SheetControlSliderType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SheetControlsOption

type SheetControlsOption struct {

	// Visibility state.
	VisibilityState DashboardUIState
	// contains filtered or unexported fields
}

Sheet controls option.

type SheetDefinition added in v1.28.0

type SheetDefinition struct {

	// The unique identifier of a sheet.
	//
	// This member is required.
	SheetId *string

	// The layout content type of the sheet. Choose one of the following options:
	//   - PAGINATED : Creates a sheet for a paginated report.
	//   - INTERACTIVE : Creates a sheet for an interactive dashboard.
	ContentType SheetContentType

	// A description of the sheet.
	Description *string

	// The list of filter controls that are on a sheet. For more information, see
	// Adding filter controls to analysis sheets (https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html)
	// in the Amazon QuickSight User Guide.
	FilterControls []FilterControl

	// Layouts define how the components of a sheet are arranged. For more
	// information, see Types of layout (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html)
	// in the Amazon QuickSight User Guide.
	Layouts []Layout

	// The name of the sheet. This name is displayed on the sheet's tab in the Amazon
	// QuickSight console.
	Name *string

	// The list of parameter controls that are on a sheet. For more information, see
	// Using a Control with a Parameter in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html)
	// in the Amazon QuickSight User Guide.
	ParameterControls []ParameterControl

	// The control layouts of the sheet.
	SheetControlLayouts []SheetControlLayout

	// The text boxes that are on a sheet.
	TextBoxes []SheetTextBox

	// The title of the sheet.
	Title *string

	// A list of the visuals that are on a sheet. Visual placement is determined by
	// the layout of the sheet.
	Visuals []Visual
	// contains filtered or unexported fields
}

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

type SheetElementConfigurationOverrides added in v1.28.0

type SheetElementConfigurationOverrides struct {

	// Determines whether or not the overrides are visible. Choose one of the
	// following options:
	//   - VISIBLE
	//   - HIDDEN
	Visibility Visibility
	// contains filtered or unexported fields
}

The override configuration of the rendering rules of a sheet.

type SheetElementRenderingRule added in v1.28.0

type SheetElementRenderingRule struct {

	// The override configuration of the rendering rules of a sheet.
	//
	// This member is required.
	ConfigurationOverrides *SheetElementConfigurationOverrides

	// The expression of the rendering rules of a sheet.
	//
	// This member is required.
	Expression *string
	// contains filtered or unexported fields
}

The rendering rules of a sheet that uses a free-form layout.

type SheetLayoutElementMaximizationOption added in v1.31.0

type SheetLayoutElementMaximizationOption struct {

	// The status of the sheet layout maximization options of a dashbaord.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The sheet layout maximization options of a dashbaord.

type SheetStyle

type SheetStyle struct {

	// The display options for tiles.
	Tile *TileStyle

	// The layout options for tiles.
	TileLayout *TileLayoutStyle
	// contains filtered or unexported fields
}

The theme display options for sheets.

type SheetTextBox added in v1.28.0

type SheetTextBox struct {

	// The unique identifier for a text box. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have text boxes that share identifiers.
	//
	// This member is required.
	SheetTextBoxId *string

	// The content that is displayed in the text box.
	Content *string
	// contains filtered or unexported fields
}

A text box.

type SheetVisualScopingConfiguration added in v1.28.0

type SheetVisualScopingConfiguration struct {

	// The scope of the applied entities. Choose one of the following options:
	//   - ALL_VISUALS
	//   - SELECTED_VISUALS
	//
	// This member is required.
	Scope FilterVisualScope

	// The selected sheet that the filter is applied to.
	//
	// This member is required.
	SheetId *string

	// The selected visuals that the filter is applied to.
	VisualIds []string
	// contains filtered or unexported fields
}

The filter that is applied to the options.

type ShortFormatText added in v1.28.0

type ShortFormatText struct {

	// Plain text format.
	PlainText *string

	// Rich text. Examples of rich text include bold, underline, and italics.
	RichText *string
	// contains filtered or unexported fields
}

The text format for the title. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type SignupResponse added in v1.23.0

type SignupResponse struct {

	// The name of your Amazon QuickSight account.
	AccountName *string

	// The type of Active Directory that is being used to authenticate the Amazon
	// QuickSight account. Valid values are SIMPLE_AD , AD_CONNECTOR , and MICROSOFT_AD
	// .
	DirectoryType *string

	// A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication
	// method.
	IAMUser bool

	// The user login name for your Amazon QuickSight account.
	UserLoginName *string
	// contains filtered or unexported fields
}

A SignupResponse object that contains a summary of a newly created account.

type SimpleAttributeAggregationFunction added in v1.39.0

type SimpleAttributeAggregationFunction string
const (
	SimpleAttributeAggregationFunctionUniqueValue SimpleAttributeAggregationFunction = "UNIQUE_VALUE"
)

Enum values for SimpleAttributeAggregationFunction

func (SimpleAttributeAggregationFunction) Values added in v1.39.0

Values returns all known values for SimpleAttributeAggregationFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SimpleClusterMarker added in v1.28.0

type SimpleClusterMarker struct {

	// The color of the simple cluster marker.
	Color *string
	// contains filtered or unexported fields
}

The simple cluster marker of the cluster marker.

type SimpleNumericalAggregationFunction added in v1.28.0

type SimpleNumericalAggregationFunction string
const (
	SimpleNumericalAggregationFunctionSum           SimpleNumericalAggregationFunction = "SUM"
	SimpleNumericalAggregationFunctionAverage       SimpleNumericalAggregationFunction = "AVERAGE"
	SimpleNumericalAggregationFunctionMin           SimpleNumericalAggregationFunction = "MIN"
	SimpleNumericalAggregationFunctionMax           SimpleNumericalAggregationFunction = "MAX"
	SimpleNumericalAggregationFunctionCount         SimpleNumericalAggregationFunction = "COUNT"
	SimpleNumericalAggregationFunctionDistinctCount SimpleNumericalAggregationFunction = "DISTINCT_COUNT"
	SimpleNumericalAggregationFunctionVar           SimpleNumericalAggregationFunction = "VAR"
	SimpleNumericalAggregationFunctionVarp          SimpleNumericalAggregationFunction = "VARP"
	SimpleNumericalAggregationFunctionStdev         SimpleNumericalAggregationFunction = "STDEV"
	SimpleNumericalAggregationFunctionStdevp        SimpleNumericalAggregationFunction = "STDEVP"
	SimpleNumericalAggregationFunctionMedian        SimpleNumericalAggregationFunction = "MEDIAN"
)

Enum values for SimpleNumericalAggregationFunction

func (SimpleNumericalAggregationFunction) Values added in v1.28.0

Values returns all known values for SimpleNumericalAggregationFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SimpleTotalAggregationFunction added in v1.46.0

type SimpleTotalAggregationFunction string
const (
	SimpleTotalAggregationFunctionDefault SimpleTotalAggregationFunction = "DEFAULT"
	SimpleTotalAggregationFunctionSum     SimpleTotalAggregationFunction = "SUM"
	SimpleTotalAggregationFunctionAverage SimpleTotalAggregationFunction = "AVERAGE"
	SimpleTotalAggregationFunctionMin     SimpleTotalAggregationFunction = "MIN"
	SimpleTotalAggregationFunctionMax     SimpleTotalAggregationFunction = "MAX"
	SimpleTotalAggregationFunctionNone    SimpleTotalAggregationFunction = "NONE"
)

Enum values for SimpleTotalAggregationFunction

func (SimpleTotalAggregationFunction) Values added in v1.46.0

Values returns all known values for SimpleTotalAggregationFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SingleAxisOptions added in v1.54.0

type SingleAxisOptions struct {

	// The Y axis options of a single axis configuration.
	YAxisOptions *YAxisOptions
	// contains filtered or unexported fields
}

The settings of a chart's single axis configuration.

type SingleYAxisOption added in v1.54.0

type SingleYAxisOption string
const (
	SingleYAxisOptionPrimaryYAxis SingleYAxisOption = "PRIMARY_Y_AXIS"
)

Enum values for SingleYAxisOption

func (SingleYAxisOption) Values added in v1.54.0

Values returns all known values for SingleYAxisOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SliderControlDisplayOptions added in v1.28.0

type SliderControlDisplayOptions struct {

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type SmallMultiplesAxisPlacement added in v1.38.0

type SmallMultiplesAxisPlacement string
const (
	SmallMultiplesAxisPlacementOutside SmallMultiplesAxisPlacement = "OUTSIDE"
	SmallMultiplesAxisPlacementInside  SmallMultiplesAxisPlacement = "INSIDE"
)

Enum values for SmallMultiplesAxisPlacement

func (SmallMultiplesAxisPlacement) Values added in v1.38.0

Values returns all known values for SmallMultiplesAxisPlacement. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SmallMultiplesAxisProperties added in v1.38.0

type SmallMultiplesAxisProperties struct {

	// Defines the placement of the axis. By default, axes are rendered OUTSIDE of the
	// panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
	Placement SmallMultiplesAxisPlacement

	// Determines whether scale of the axes are shared or independent. The default
	// value is SHARED .
	Scale SmallMultiplesAxisScale
	// contains filtered or unexported fields
}

Configures the properties of a chart's axes that are used by small multiples panels.

type SmallMultiplesAxisScale added in v1.38.0

type SmallMultiplesAxisScale string
const (
	SmallMultiplesAxisScaleShared      SmallMultiplesAxisScale = "SHARED"
	SmallMultiplesAxisScaleIndependent SmallMultiplesAxisScale = "INDEPENDENT"
)

Enum values for SmallMultiplesAxisScale

func (SmallMultiplesAxisScale) Values added in v1.38.0

Values returns all known values for SmallMultiplesAxisScale. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SmallMultiplesOptions added in v1.28.0

type SmallMultiplesOptions struct {

	// Sets the maximum number of visible columns to display in the grid of small
	// multiples panels. The default is Auto , which automatically adjusts the columns
	// in the grid to fit the overall layout and size of the given chart.
	MaxVisibleColumns *int64

	// Sets the maximum number of visible rows to display in the grid of small
	// multiples panels. The default value is Auto , which automatically adjusts the
	// rows in the grid to fit the overall layout and size of the given chart.
	MaxVisibleRows *int64

	// Configures the display options for each small multiples panel.
	PanelConfiguration *PanelConfiguration

	// The properties of a small multiples X axis.
	XAxis *SmallMultiplesAxisProperties

	// The properties of a small multiples Y axis.
	YAxis *SmallMultiplesAxisProperties
	// contains filtered or unexported fields
}

Options that determine the layout and display options of a chart's small multiples.

type SnapshotAnonymousUser added in v1.39.0

type SnapshotAnonymousUser struct {

	// The tags to be used for row-level security (RLS). Make sure that the relevant
	// datasets have RLS tags configured before you start a snapshot export job. You
	// can configure the RLS tags of a dataset with a
	// DataSet$RowLevelPermissionTagConfiguration API call. These are not the tags that
	// are used for Amazon Web Services resource tagging. For more information on row
	// level security in Amazon QuickSight, see Using Row-Level Security (RLS) with
	// Tags (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html)
	// in the Amazon QuickSight User Guide.
	RowLevelPermissionTags []SessionTag
	// contains filtered or unexported fields
}

A structure that contains information on the anonymous user configuration.

type SnapshotAnonymousUserRedacted added in v1.39.0

type SnapshotAnonymousUserRedacted struct {

	// The tag keys for the RowLevelPermissionTags .
	RowLevelPermissionTagKeys []string
	// contains filtered or unexported fields
}

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

type SnapshotConfiguration added in v1.39.0

type SnapshotConfiguration struct {

	// A list of SnapshotJobResultFileGroup objects that contain information about the
	// snapshot that is generated. This list can hold a maximum of 6 FileGroup
	// configurations.
	//
	// This member is required.
	FileGroups []SnapshotFileGroup

	// A structure that contains information on the Amazon S3 bucket that the
	// generated snapshot is stored in.
	DestinationConfiguration *SnapshotDestinationConfiguration

	// A list of Amazon QuickSight parameters and the list's override values.
	Parameters *Parameters
	// contains filtered or unexported fields
}

Describes the configuration of the dashboard snapshot.

type SnapshotDestinationConfiguration added in v1.39.0

type SnapshotDestinationConfiguration struct {

	// A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3
	// destination configurations. This structure can hold a maximum of 1
	// S3DestinationConfiguration .
	S3Destinations []SnapshotS3DestinationConfiguration
	// contains filtered or unexported fields
}

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

type SnapshotFile added in v1.39.0

type SnapshotFile struct {

	// The format of the snapshot file to be generated. You can choose between CSV ,
	// Excel , or PDF .
	//
	// This member is required.
	FormatType SnapshotFileFormatType

	// A list of SnapshotFileSheetSelection objects that contain information on the
	// dashboard sheet that is exported. These objects provide information about the
	// snapshot artifacts that are generated during the job. This structure can hold a
	// maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for
	// PDF.
	//
	// This member is required.
	SheetSelections []SnapshotFileSheetSelection
	// contains filtered or unexported fields
}

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

type SnapshotFileFormatType added in v1.39.0

type SnapshotFileFormatType string
const (
	SnapshotFileFormatTypeCsv   SnapshotFileFormatType = "CSV"
	SnapshotFileFormatTypePdf   SnapshotFileFormatType = "PDF"
	SnapshotFileFormatTypeExcel SnapshotFileFormatType = "EXCEL"
)

Enum values for SnapshotFileFormatType

func (SnapshotFileFormatType) Values added in v1.39.0

Values returns all known values for SnapshotFileFormatType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SnapshotFileGroup added in v1.39.0

type SnapshotFileGroup struct {

	// A list of SnapshotFile objects that contain the information on the snapshot
	// files that need to be generated. This structure can hold 1 configuration at a
	// time.
	Files []SnapshotFile
	// contains filtered or unexported fields
}

A structure that contains the information on the snapshot files.

type SnapshotFileSheetSelection added in v1.39.0

type SnapshotFileSheetSelection struct {

	// The selection scope of the visuals on a sheet of a dashboard that you are
	// generating a snapthot of. You can choose one of the following options.
	//   - ALL_VISUALS - Selects all visuals that are on the sheet. This value is
	//   required if the snapshot is a PDF.
	//   - SELECTED_VISUALS - Select the visual that you want to add to the snapshot.
	//   This value is required if the snapshot is a CSV or Excel workbook.
	//
	// This member is required.
	SelectionScope SnapshotFileSheetSelectionScope

	// The sheet ID of the dashboard to generate the snapshot artifact from. This
	// value is required for CSV, Excel, and PDF format types.
	//
	// This member is required.
	SheetId *string

	// A structure that lists the IDs of the visuals in the selected sheet. Supported
	// visual types are table, pivot table visuals. This value is required if you are
	// generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID
	// for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are
	// generating an Excel workbook, the order of the visual IDs provided in this
	// structure determines the order of the worksheets in the Excel file.
	VisualIds []string
	// contains filtered or unexported fields
}

A structure that contains information that identifies the snapshot that needs to be generated.

type SnapshotFileSheetSelectionScope added in v1.39.0

type SnapshotFileSheetSelectionScope string
const (
	SnapshotFileSheetSelectionScopeAllVisuals      SnapshotFileSheetSelectionScope = "ALL_VISUALS"
	SnapshotFileSheetSelectionScopeSelectedVisuals SnapshotFileSheetSelectionScope = "SELECTED_VISUALS"
)

Enum values for SnapshotFileSheetSelectionScope

func (SnapshotFileSheetSelectionScope) Values added in v1.39.0

Values returns all known values for SnapshotFileSheetSelectionScope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SnapshotJobErrorInfo added in v1.39.0

type SnapshotJobErrorInfo struct {

	// The error message.
	ErrorMessage *string

	// The error type.
	ErrorType *string
	// contains filtered or unexported fields
}

An object that contains information on the error that caused the snapshot job to fail.

type SnapshotJobResult added in v1.39.0

type SnapshotJobResult struct {

	// A list of AnonymousUserSnapshotJobResult objects that contain information on
	// anonymous users and their user configurations. This data provided by you when
	// you make a StartDashboardSnapshotJob API call.
	AnonymousUsers []AnonymousUserSnapshotJobResult
	// contains filtered or unexported fields
}

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

type SnapshotJobResultErrorInfo added in v1.39.0

type SnapshotJobResultErrorInfo struct {

	// The error message.
	ErrorMessage *string

	// The error type.
	ErrorType *string
	// contains filtered or unexported fields
}

Information on the error that caused the snapshot job to fail.

type SnapshotJobResultFileGroup added in v1.39.0

type SnapshotJobResultFileGroup struct {

	// A list of SnapshotFile objects.
	Files []SnapshotFile

	// A list of SnapshotJobS3Result objects.
	S3Results []SnapshotJobS3Result
	// contains filtered or unexported fields
}

A structure that contains information on the generated snapshot file groups.

type SnapshotJobS3Result added in v1.39.0

type SnapshotJobS3Result struct {

	// An array of error records that describe any failures that occur while the
	// dashboard snapshot job runs.
	ErrorInfo []SnapshotJobResultErrorInfo

	// A list of Amazon S3 bucket configurations that are provided when you make a
	// StartDashboardSnapshotJob API call.
	S3DestinationConfiguration *SnapshotS3DestinationConfiguration

	// The Amazon S3 Uri.
	S3Uri *string
	// contains filtered or unexported fields
}

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

type SnapshotJobStatus added in v1.39.0

type SnapshotJobStatus string
const (
	SnapshotJobStatusQueued    SnapshotJobStatus = "QUEUED"
	SnapshotJobStatusRunning   SnapshotJobStatus = "RUNNING"
	SnapshotJobStatusCompleted SnapshotJobStatus = "COMPLETED"
	SnapshotJobStatusFailed    SnapshotJobStatus = "FAILED"
)

Enum values for SnapshotJobStatus

func (SnapshotJobStatus) Values added in v1.39.0

Values returns all known values for SnapshotJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SnapshotS3DestinationConfiguration added in v1.39.0

type SnapshotS3DestinationConfiguration struct {

	// A structure that contains details about the Amazon S3 bucket that the generated
	// dashboard snapshot is saved in.
	//
	// This member is required.
	BucketConfiguration *S3BucketConfiguration
	// contains filtered or unexported fields
}

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

type SnapshotUserConfiguration added in v1.39.0

type SnapshotUserConfiguration struct {

	// An array of records that describe the anonymous users that the dashboard
	// snapshot is generated for.
	AnonymousUsers []SnapshotAnonymousUser
	// contains filtered or unexported fields
}

A structure that contains information about the users that the dashboard snapshot is generated for.

type SnapshotUserConfigurationRedacted added in v1.39.0

type SnapshotUserConfigurationRedacted struct {

	// An array of records that describe anonymous users that the dashboard snapshot
	// is generated for. Sensitive user information is excluded.
	AnonymousUsers []SnapshotAnonymousUserRedacted
	// contains filtered or unexported fields
}

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.

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
	// contains filtered or unexported fields
}

The parameters for Snowflake.

type SortDirection added in v1.28.0

type SortDirection string
const (
	SortDirectionAsc  SortDirection = "ASC"
	SortDirectionDesc SortDirection = "DESC"
)

Enum values for SortDirection

func (SortDirection) Values added in v1.28.0

func (SortDirection) Values() []SortDirection

Values returns all known values for SortDirection. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Spacing added in v1.28.0

type Spacing struct {

	// Define the bottom spacing.
	Bottom *string

	// Define the left spacing.
	Left *string

	// Define the right spacing.
	Right *string

	// Define the top spacing.
	Top *string
	// contains filtered or unexported fields
}

The configuration of spacing (often a margin or padding).

type SparkParameters

type SparkParameters struct {

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

	// Port.
	//
	// This member is required.
	Port *int32
	// contains filtered or unexported fields
}

The parameters for Spark.

type SpecialValue added in v1.38.0

type SpecialValue string
const (
	SpecialValueEmpty SpecialValue = "EMPTY"
	SpecialValueNull  SpecialValue = "NULL"
	SpecialValueOther SpecialValue = "OTHER"
)

Enum values for SpecialValue

func (SpecialValue) Values added in v1.38.0

func (SpecialValue) Values() []SpecialValue

Values returns all known values for SpecialValue. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

The parameters for SQL Server.

type SslProperties

type SslProperties struct {

	// A Boolean option to control whether SSL should be disabled.
	DisableSsl bool
	// contains filtered or unexported fields
}

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

type StarburstParameters added in v1.46.0

type StarburstParameters struct {

	// The catalog name for the Starburst data source.
	//
	// This member is required.
	Catalog *string

	// The host name of the Starburst data source.
	//
	// This member is required.
	Host *string

	// The port for the Starburst data source.
	//
	// This member is required.
	Port *int32

	// The product type for the Starburst data source.
	ProductType StarburstProductType
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Starburst data source.

type StarburstProductType added in v1.46.0

type StarburstProductType string
const (
	StarburstProductTypeGalaxy     StarburstProductType = "GALAXY"
	StarburstProductTypeEnterprise StarburstProductType = "ENTERPRISE"
)

Enum values for StarburstProductType

func (StarburstProductType) Values added in v1.46.0

Values returns all known values for StarburstProductType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StatePersistenceConfigurations added in v1.33.0

type StatePersistenceConfigurations struct {

	// Determines if a Amazon QuickSight dashboard's state persistence settings are
	// turned on or off.
	//
	// This member is required.
	Enabled bool
	// contains filtered or unexported fields
}

The state perssitence configuration of an embedded dashboard.

type Status added in v1.7.0

type Status string
const (
	StatusEnabled  Status = "ENABLED"
	StatusDisabled Status = "DISABLED"
)

Enum values for Status

func (Status) Values added in v1.7.0

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StringDatasetParameter added in v1.35.0

type StringDatasetParameter struct {

	// An identifier for the string parameter that is created in the dataset.
	//
	// This member is required.
	Id *string

	// The name of the string parameter that is created in the dataset.
	//
	// This member is required.
	Name *string

	// The value type of the dataset parameter. Valid values are single value or multi
	// value .
	//
	// This member is required.
	ValueType DatasetParameterValueType

	// A list of default values for a given string dataset parameter type. This
	// structure only accepts static values.
	DefaultValues *StringDatasetParameterDefaultValues
	// contains filtered or unexported fields
}

A string parameter for a dataset.

type StringDatasetParameterDefaultValues added in v1.35.0

type StringDatasetParameterDefaultValues struct {

	// A list of static default values for a given string parameter.
	StaticValues []string
	// contains filtered or unexported fields
}

The default values of a string parameter.

type StringDefaultValues added in v1.28.0

type StringDefaultValues struct {

	// The dynamic value of the StringDefaultValues . Different defaults displayed
	// according to users, groups, and values mapping.
	DynamicValue *DynamicDefaultValue

	// The static values of the DecimalDefaultValues .
	StaticValues []string
	// contains filtered or unexported fields
}

The default values of the StringParameterDeclaration .

type StringFormatConfiguration added in v1.28.0

type StringFormatConfiguration struct {

	// The options that determine the null value format configuration.
	NullValueFormatConfiguration *NullValueFormatConfiguration

	// The formatting configuration for numeric strings.
	NumericFormatConfiguration *NumericFormatConfiguration
	// contains filtered or unexported fields
}

Formatting configuration for string fields.

type StringParameter

type StringParameter struct {

	// A display name for a string parameter.
	//
	// This member is required.
	Name *string

	// The values of a string parameter.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

A string parameter.

type StringParameterDeclaration added in v1.28.0

type StringParameterDeclaration struct {

	// The name of the parameter that is being declared.
	//
	// This member is required.
	Name *string

	// The value type determines whether the parameter is a single-value or
	// multi-value parameter.
	//
	// This member is required.
	ParameterValueType ParameterValueType

	// The default values of a parameter. If the parameter is a single-value
	// parameter, a maximum of one default value can be provided.
	DefaultValues *StringDefaultValues

	// A list of dataset parameters that are mapped to an analysis parameter.
	MappedDataSetParameters []MappedDataSetParameter

	// The configuration that defines the default value of a String parameter when a
	// value has not been set.
	ValueWhenUnset *StringValueWhenUnsetConfiguration
	// contains filtered or unexported fields
}

A parameter declaration for the String data type.

type StringValueWhenUnsetConfiguration added in v1.28.0

type StringValueWhenUnsetConfiguration struct {

	// A custom value that's used when the value of a parameter isn't set.
	CustomValue *string

	// The built-in options for default values. The value can be one of the following:
	//   - RECOMMENDED : The recommended value.
	//   - NULL : The NULL value.
	ValueWhenUnsetOption ValueWhenUnsetOption
	// contains filtered or unexported fields
}

The configuration that defines the default value of a String parameter when a value has not been set.

type StyledCellType added in v1.41.0

type StyledCellType string
const (
	StyledCellTypeTotal        StyledCellType = "TOTAL"
	StyledCellTypeMetricHeader StyledCellType = "METRIC_HEADER"
	StyledCellTypeValue        StyledCellType = "VALUE"
)

Enum values for StyledCellType

func (StyledCellType) Values added in v1.41.0

func (StyledCellType) Values() []StyledCellType

Values returns all known values for StyledCellType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SubtotalOptions added in v1.28.0

type SubtotalOptions struct {

	// The custom label string for the subtotal cells.
	CustomLabel *string

	// The field level (all, custom, last) for the subtotal cells.
	FieldLevel PivotTableSubtotalLevel

	// The optional configuration of subtotal cells.
	FieldLevelOptions []PivotTableFieldSubtotalOptions

	// The cell styling options for the subtotals of header cells.
	MetricHeaderCellStyle *TableCellStyle

	// The style targets options for subtotals.
	StyleTargets []TableStyleTarget

	// The cell styling options for the subtotal cells.
	TotalCellStyle *TableCellStyle

	// The visibility configuration for the subtotal cells.
	TotalsVisibility Visibility

	// The cell styling options for the subtotals of value cells.
	ValueCellStyle *TableCellStyle
	// contains filtered or unexported fields
}

The subtotal options.

type TableAggregatedFieldWells added in v1.28.0

type TableAggregatedFieldWells struct {

	// The group by field well for a pivot table. Values are grouped by group by
	// fields.
	GroupBy []DimensionField

	// The values field well for a pivot table. Values are aggregated based on group
	// by fields.
	Values []MeasureField
	// contains filtered or unexported fields
}

The aggregated field well for the table.

type TableBorderOptions added in v1.28.0

type TableBorderOptions struct {

	// The color of a table border.
	Color *string

	// The style (none, solid) of a table border.
	Style TableBorderStyle

	// The thickness of a table border.
	Thickness *int32
	// contains filtered or unexported fields
}

The border options for a table border.

type TableBorderStyle added in v1.28.0

type TableBorderStyle string
const (
	TableBorderStyleNone  TableBorderStyle = "NONE"
	TableBorderStyleSolid TableBorderStyle = "SOLID"
)

Enum values for TableBorderStyle

func (TableBorderStyle) Values added in v1.28.0

Values returns all known values for TableBorderStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TableCellConditionalFormatting added in v1.28.0

type TableCellConditionalFormatting struct {

	// The field ID of the cell for conditional formatting.
	//
	// This member is required.
	FieldId *string

	// The text format of the cell for conditional formatting.
	TextFormat *TextConditionalFormat
	// contains filtered or unexported fields
}

The cell conditional formatting option for a table.

type TableCellImageScalingConfiguration added in v1.28.0

type TableCellImageScalingConfiguration string
const (
	TableCellImageScalingConfigurationFitToCellHeight TableCellImageScalingConfiguration = "FIT_TO_CELL_HEIGHT"
	TableCellImageScalingConfigurationFitToCellWidth  TableCellImageScalingConfiguration = "FIT_TO_CELL_WIDTH"
	TableCellImageScalingConfigurationDoNotScale      TableCellImageScalingConfiguration = "DO_NOT_SCALE"
)

Enum values for TableCellImageScalingConfiguration

func (TableCellImageScalingConfiguration) Values added in v1.28.0

Values returns all known values for TableCellImageScalingConfiguration. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TableCellImageSizingConfiguration added in v1.28.0

type TableCellImageSizingConfiguration struct {

	// The cell scaling configuration of the sizing options for the table image
	// configuration.
	TableCellImageScalingConfiguration TableCellImageScalingConfiguration
	// contains filtered or unexported fields
}

The sizing options for the table image configuration.

type TableCellStyle added in v1.28.0

type TableCellStyle struct {

	// The background color for the table cells.
	BackgroundColor *string

	// The borders for the table cells.
	Border *GlobalTableBorderOptions

	// The font configuration of the table cells.
	FontConfiguration *FontConfiguration

	// The height color for the table cells.
	Height *int32

	// The horizontal text alignment (left, center, right, auto) for the table cells.
	HorizontalTextAlignment HorizontalTextAlignment

	// The text wrap (none, wrap) for the table cells.
	TextWrap TextWrap

	// The vertical text alignment (top, middle, bottom) for the table cells.
	VerticalTextAlignment VerticalTextAlignment

	// The visibility of the table cells.
	Visibility Visibility
	// contains filtered or unexported fields
}

The table cell style for a cell in pivot table or table visual.

type TableConditionalFormatting added in v1.28.0

type TableConditionalFormatting struct {

	// Conditional formatting options for a PivotTableVisual .
	ConditionalFormattingOptions []TableConditionalFormattingOption
	// contains filtered or unexported fields
}

The conditional formatting for a PivotTableVisual .

type TableConditionalFormattingOption added in v1.28.0

type TableConditionalFormattingOption struct {

	// The cell conditional formatting option for a table.
	Cell *TableCellConditionalFormatting

	// The row conditional formatting option for a table.
	Row *TableRowConditionalFormatting
	// contains filtered or unexported fields
}

Conditional formatting options for a PivotTableVisual .

type TableConfiguration added in v1.28.0

type TableConfiguration struct {

	// The field options for a table visual.
	FieldOptions *TableFieldOptions

	// The field wells of the visual.
	FieldWells *TableFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The paginated report options for a table visual.
	PaginatedReportOptions *TablePaginatedReportOptions

	// The sort configuration for a TableVisual .
	SortConfiguration *TableSortConfiguration

	// A collection of inline visualizations to display within a chart.
	TableInlineVisualizations []TableInlineVisualization

	// The table options for a table visual.
	TableOptions *TableOptions

	// The total options for a table visual.
	TotalOptions *TotalOptions
	// contains filtered or unexported fields
}

The configuration for a TableVisual .

type TableFieldCustomIconContent added in v1.28.0

type TableFieldCustomIconContent struct {

	// The icon set type (link) of the custom icon content for table URL link content.
	Icon TableFieldIconSetType
	// contains filtered or unexported fields
}

The custom icon content for the table link content configuration.

type TableFieldCustomTextContent added in v1.28.0

type TableFieldCustomTextContent struct {

	// The font configuration of the custom text content for the table URL link
	// content.
	//
	// This member is required.
	FontConfiguration *FontConfiguration

	// The string value of the custom text content for the table URL link content.
	Value *string
	// contains filtered or unexported fields
}

The custom text content (value, font configuration) for the table link content configuration.

type TableFieldIconSetType added in v1.28.0

type TableFieldIconSetType string
const (
	TableFieldIconSetTypeLink TableFieldIconSetType = "LINK"
)

Enum values for TableFieldIconSetType

func (TableFieldIconSetType) Values added in v1.28.0

Values returns all known values for TableFieldIconSetType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TableFieldImageConfiguration added in v1.28.0

type TableFieldImageConfiguration struct {

	// The sizing options for the table image configuration.
	SizingOptions *TableCellImageSizingConfiguration
	// contains filtered or unexported fields
}

The image configuration of a table field URL.

type TableFieldLinkConfiguration added in v1.28.0

type TableFieldLinkConfiguration struct {

	// The URL content (text, icon) for the table link configuration.
	//
	// This member is required.
	Content *TableFieldLinkContentConfiguration

	// The URL target (new tab, new window, same tab) for the table link configuration.
	//
	// This member is required.
	Target URLTargetConfiguration
	// contains filtered or unexported fields
}

The link configuration of a table field URL.

type TableFieldLinkContentConfiguration added in v1.28.0

type TableFieldLinkContentConfiguration struct {

	// The custom icon content for the table link content configuration.
	CustomIconContent *TableFieldCustomIconContent

	// The custom text content (value, font configuration) for the table link content
	// configuration.
	CustomTextContent *TableFieldCustomTextContent
	// contains filtered or unexported fields
}

The URL content (text, icon) for the table link configuration.

type TableFieldOption added in v1.28.0

type TableFieldOption struct {

	// The field ID for a table field.
	//
	// This member is required.
	FieldId *string

	// The custom label for a table field.
	CustomLabel *string

	// The URL configuration for a table field.
	URLStyling *TableFieldURLConfiguration

	// The visibility of a table field.
	Visibility Visibility

	// The width for a table field.
	Width *string
	// contains filtered or unexported fields
}

The options for a table field.

type TableFieldOptions added in v1.28.0

type TableFieldOptions struct {

	// The order of the field IDs that are configured as field options for a table
	// visual.
	Order []string

	// The settings for the pinned columns of a table visual.
	PinnedFieldOptions *TablePinnedFieldOptions

	// The field options to be configured to a table.
	SelectedFieldOptions []TableFieldOption
	// contains filtered or unexported fields
}

The field options of a table visual.

type TableFieldURLConfiguration added in v1.28.0

type TableFieldURLConfiguration struct {

	// The image configuration of a table field URL.
	ImageConfiguration *TableFieldImageConfiguration

	// The link configuration of a table field URL.
	LinkConfiguration *TableFieldLinkConfiguration
	// contains filtered or unexported fields
}

The URL configuration for a table field.

type TableFieldWells added in v1.28.0

type TableFieldWells struct {

	// The aggregated field well for the table.
	TableAggregatedFieldWells *TableAggregatedFieldWells

	// The unaggregated field well for the table.
	TableUnaggregatedFieldWells *TableUnaggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells for a table visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type TableInlineVisualization added in v1.30.0

type TableInlineVisualization struct {

	// The configuration of the inline visualization of the data bars within a chart.
	DataBars *DataBarsOptions
	// contains filtered or unexported fields
}

The inline visualization of a specific type to display within a chart.

type TableOptions added in v1.28.0

type TableOptions struct {

	// The table cell style of table cells.
	CellStyle *TableCellStyle

	// The table cell style of a table header.
	HeaderStyle *TableCellStyle

	// The orientation (vertical, horizontal) for a table.
	Orientation TableOrientation

	// The row alternate color options (widget status, row alternate colors) for a
	// table.
	RowAlternateColorOptions *RowAlternateColorOptions
	// contains filtered or unexported fields
}

The table options for a table visual.

type TableOrientation added in v1.28.0

type TableOrientation string
const (
	TableOrientationVertical   TableOrientation = "VERTICAL"
	TableOrientationHorizontal TableOrientation = "HORIZONTAL"
)

Enum values for TableOrientation

func (TableOrientation) Values added in v1.28.0

Values returns all known values for TableOrientation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TablePaginatedReportOptions added in v1.28.0

type TablePaginatedReportOptions struct {

	// The visibility of repeating header rows on each page.
	OverflowColumnHeaderVisibility Visibility

	// The visibility of printing table overflow across pages.
	VerticalOverflowVisibility Visibility
	// contains filtered or unexported fields
}

The paginated report options for a table visual.

type TablePinnedFieldOptions added in v1.42.0

type TablePinnedFieldOptions struct {

	// A list of columns to be pinned to the left of a table visual.
	PinnedLeftFields []string
	// contains filtered or unexported fields
}

The settings for the pinned columns of a table visual.

type TableRowConditionalFormatting added in v1.28.0

type TableRowConditionalFormatting struct {

	// The conditional formatting color (solid, gradient) of the background for a
	// table row.
	BackgroundColor *ConditionalFormattingColor

	// The conditional formatting color (solid, gradient) of the text for a table row.
	TextColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting of a table row.

type TableSideBorderOptions added in v1.28.0

type TableSideBorderOptions struct {

	// The table border options of the bottom border.
	Bottom *TableBorderOptions

	// The table border options of the inner horizontal border.
	InnerHorizontal *TableBorderOptions

	// The table border options of the inner vertical border.
	InnerVertical *TableBorderOptions

	// The table border options of the left border.
	Left *TableBorderOptions

	// The table border options of the right border.
	Right *TableBorderOptions

	// The table border options of the top border.
	Top *TableBorderOptions
	// contains filtered or unexported fields
}

The side border options for a table.

type TableSortConfiguration added in v1.28.0

type TableSortConfiguration struct {

	// The pagination configuration (page size, page number) for the table.
	PaginationConfiguration *PaginationConfiguration

	// The field sort options for rows in the table.
	RowSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration for a TableVisual .

type TableStyleTarget added in v1.41.0

type TableStyleTarget struct {

	// The cell type of the table style target.
	//
	// This member is required.
	CellType StyledCellType
	// contains filtered or unexported fields
}

The table style target.

type TableTotalsPlacement added in v1.28.0

type TableTotalsPlacement string
const (
	TableTotalsPlacementStart TableTotalsPlacement = "START"
	TableTotalsPlacementEnd   TableTotalsPlacement = "END"
	TableTotalsPlacementAuto  TableTotalsPlacement = "AUTO"
)

Enum values for TableTotalsPlacement

func (TableTotalsPlacement) Values added in v1.28.0

Values returns all known values for TableTotalsPlacement. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TableTotalsScrollStatus added in v1.28.0

type TableTotalsScrollStatus string
const (
	TableTotalsScrollStatusPinned   TableTotalsScrollStatus = "PINNED"
	TableTotalsScrollStatusScrolled TableTotalsScrollStatus = "SCROLLED"
)

Enum values for TableTotalsScrollStatus

func (TableTotalsScrollStatus) Values added in v1.28.0

Values returns all known values for TableTotalsScrollStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TableUnaggregatedFieldWells added in v1.28.0

type TableUnaggregatedFieldWells struct {

	// The values field well for a pivot table. Values are unaggregated for an
	// unaggregated table.
	Values []UnaggregatedField
	// contains filtered or unexported fields
}

The unaggregated field well for the table.

type TableVisual added in v1.28.0

type TableVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *TableConfiguration

	// The conditional formatting for a PivotTableVisual .
	ConditionalFormatting *TableConditionalFormatting

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A table visual. For more information, see Using tables as visuals (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the Amazon QuickSight User Guide.

type Tag

type Tag struct {

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

	// Tag value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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 Amazon Web Services tagging feature.
	//
	// This member is required.
	Tags []ColumnTag
	// contains filtered or unexported fields
}

A transform operation that tags a column with additional information.

type TargetVisualOptions added in v1.28.0

type TargetVisualOptions string
const (
	TargetVisualOptionsAllVisuals TargetVisualOptions = "ALL_VISUALS"
)

Enum values for TargetVisualOptions

func (TargetVisualOptions) Values added in v1.28.0

Values returns all known values for TargetVisualOptions. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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 Amazon Web Services Region for each
	// Amazon Web Services account.
	TemplateId *string

	// A structure describing the versions of the template.
	Version *TemplateVersion
	// contains filtered or unexported fields
}

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. You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services 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
	// contains filtered or unexported fields
}

The template alias.

type TemplateError

type TemplateError struct {

	// Description of the error type.
	Message *string

	// Type of error.
	Type TemplateErrorType

	// An error path that shows which entities caused the template error.
	ViolatedEntities []Entity
	// contains filtered or unexported fields
}

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

type TemplateErrorType

type TemplateErrorType string
const (
	TemplateErrorTypeSourceNotFound  TemplateErrorType = "SOURCE_NOT_FOUND"
	TemplateErrorTypeDataSetNotFound TemplateErrorType = "DATA_SET_NOT_FOUND"
	TemplateErrorTypeInternalFailure TemplateErrorType = "INTERNAL_FAILURE"
	TemplateErrorTypeAccessDenied    TemplateErrorType = "ACCESS_DENIED"
)

Enum values for TemplateErrorType

func (TemplateErrorType) Values added in v0.29.0

Values returns all known values for TemplateErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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 Amazon Web Services Region for
	// each Amazon Web Services account.
	TemplateId *string
	// contains filtered or unexported fields
}

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. Any dashboard created from
	// this template should be bound to new datasets matching the same schema described
	// through this API operation.
	DataSetConfigurations []DataSetConfiguration

	// The description of the template.
	Description *string

	// Errors associated with this template version.
	Errors []TemplateError

	// A list of the associated sheets with the unique identifier and name of each
	// sheet.
	Sheets []Sheet

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

	// The status that is associated with the template.
	//   - CREATION_IN_PROGRESS
	//   - CREATION_SUCCESSFUL
	//   - CREATION_FAILED
	//   - UPDATE_IN_PROGRESS
	//   - UPDATE_SUCCESSFUL
	//   - UPDATE_FAILED
	//   - DELETED
	Status ResourceStatus

	// The ARN of the theme associated with this version of the template.
	ThemeArn *string

	// The version number of the template version.
	VersionNumber *int64
	// contains filtered or unexported fields
}

A version of a template.

type TemplateVersionDefinition added in v1.28.0

type TemplateVersionDefinition struct {

	// An array of dataset configurations. These configurations define the required
	// columns for each dataset used within a template.
	//
	// This member is required.
	DataSetConfigurations []DataSetConfiguration

	// The configuration for default analysis settings.
	AnalysisDefaults *AnalysisDefaults

	// An array of calculated field definitions for the template.
	CalculatedFields []CalculatedField

	// An array of template-level column configurations. Column configurations are
	// used to set default formatting for a column that's used throughout a template.
	ColumnConfigurations []ColumnConfiguration

	// Filter definitions for a template. For more information, see Filtering Data (https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html)
	// in the Amazon QuickSight User Guide.
	FilterGroups []FilterGroup

	// An array of option definitions for a template.
	Options *AssetOptions

	// An array of parameter declarations for a template. Parameters are named
	// variables that can transfer a value for use by an action or an object. For more
	// information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
	// in the Amazon QuickSight User Guide.
	ParameterDeclarations []ParameterDeclaration

	// An array of sheet definitions for a template.
	Sheets []SheetDefinition
	// contains filtered or unexported fields
}

The detailed definition 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The parameters for Teradata.

type TextAreaControlDisplayOptions added in v1.28.0

type TextAreaControlDisplayOptions struct {

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The configuration of the placeholder options in a text area control.
	PlaceholderOptions *TextControlPlaceholderOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type TextConditionalFormat added in v1.28.0

type TextConditionalFormat struct {

	// The conditional formatting for the text background color.
	BackgroundColor *ConditionalFormattingColor

	// The conditional formatting for the icon.
	Icon *ConditionalFormattingIcon

	// The conditional formatting for the text color.
	TextColor *ConditionalFormattingColor
	// contains filtered or unexported fields
}

The conditional formatting for the text.

type TextControlPlaceholderOptions added in v1.28.0

type TextControlPlaceholderOptions struct {

	// The visibility configuration of the placeholder options in a text control.
	Visibility Visibility
	// contains filtered or unexported fields
}

The configuration of the placeholder options in a text control.

type TextFieldControlDisplayOptions added in v1.28.0

type TextFieldControlDisplayOptions struct {

	// The configuration of info icon label options.
	InfoIconLabelOptions *SheetControlInfoIconLabelOptions

	// The configuration of the placeholder options in a text field control.
	PlaceholderOptions *TextControlPlaceholderOptions

	// The options to configure the title visibility, name, and font size.
	TitleOptions *LabelOptions
	// contains filtered or unexported fields
}

The display options of a control.

type TextQualifier

type TextQualifier string
const (
	TextQualifierDoubleQuote TextQualifier = "DOUBLE_QUOTE"
	TextQualifierSingleQuote TextQualifier = "SINGLE_QUOTE"
)

Enum values for TextQualifier

func (TextQualifier) Values added in v0.29.0

func (TextQualifier) Values() []TextQualifier

Values returns all known values for TextQualifier. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TextWrap added in v1.28.0

type TextWrap string
const (
	TextWrapNone TextWrap = "NONE"
	TextWrapWrap TextWrap = "WRAP"
)

Enum values for TextWrap

func (TextWrap) Values added in v1.28.0

func (TextWrap) Values() []TextWrap

Values returns all known values for TextWrap. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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
	// contains filtered or unexported fields
}

Summary information about a theme.

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
	// contains filtered or unexported fields
}

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

	// Determines the typography options.
	Typography *Typography

	// Color properties that apply to the UI and to charts, excluding the colors that
	// apply to data.
	UIColorPalette *UIColorPalette
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Theme error.

type ThemeErrorType

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

Enum values for ThemeErrorType

func (ThemeErrorType) Values added in v0.29.0

func (ThemeErrorType) Values() []ThemeErrorType

Values returns all known values for ThemeErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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 Amazon Web Services Region for each
	// Amazon Web Services account.
	ThemeId *string
	// contains filtered or unexported fields
}

The theme summary.

type ThemeType

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

Enum values for ThemeType

func (ThemeType) Values added in v0.29.0

func (ThemeType) Values() []ThemeType

Values returns all known values for ThemeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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 Amazon 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The theme version.

type ThousandSeparatorOptions added in v1.28.0

type ThousandSeparatorOptions struct {

	// Determines the thousands separator symbol.
	Symbol NumericSeparatorSymbol

	// Determines the visibility of the thousands separator.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the thousands separator configuration.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

type TileStyle

type TileStyle struct {

	// The border around a tile.
	Border *BorderStyle
	// contains filtered or unexported fields
}

Display options related to tiles on a sheet.

type TimeBasedForecastProperties added in v1.28.0

type TimeBasedForecastProperties struct {

	// The lower boundary setup of a forecast computation.
	LowerBoundary *float64

	// The periods backward setup of a forecast computation.
	PeriodsBackward *int32

	// The periods forward setup of a forecast computation.
	PeriodsForward *int32

	// The prediction interval setup of a forecast computation.
	PredictionInterval *int32

	// The seasonality setup of a forecast computation. Choose one of the following
	// options:
	//   - NULL : The input is set to NULL .
	//   - NON_NULL : The input is set to a custom value.
	Seasonality *int32

	// The upper boundary setup of a forecast computation.
	UpperBoundary *float64
	// contains filtered or unexported fields
}

The forecast properties setup of a forecast in the line chart.

type TimeEqualityFilter added in v1.28.0

type TimeEqualityFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration

	// The parameter whose value should be used for the filter value. This field is
	// mutually exclusive to Value and RollingDate .
	ParameterName *string

	// The rolling date input for the TimeEquality filter. This field is mutually
	// exclusive to Value and ParameterName .
	RollingDate *RollingDateConfiguration

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TimeGranularity

	// The value of a TimeEquality filter. This field is mutually exclusive to
	// RollingDate and ParameterName .
	Value *time.Time
	// contains filtered or unexported fields
}

A TimeEqualityFilter filters values that are equal to a given value.

type TimeGranularity added in v1.28.0

type TimeGranularity string
const (
	TimeGranularityYear        TimeGranularity = "YEAR"
	TimeGranularityQuarter     TimeGranularity = "QUARTER"
	TimeGranularityMonth       TimeGranularity = "MONTH"
	TimeGranularityWeek        TimeGranularity = "WEEK"
	TimeGranularityDay         TimeGranularity = "DAY"
	TimeGranularityHour        TimeGranularity = "HOUR"
	TimeGranularityMinute      TimeGranularity = "MINUTE"
	TimeGranularitySecond      TimeGranularity = "SECOND"
	TimeGranularityMillisecond TimeGranularity = "MILLISECOND"
)

Enum values for TimeGranularity

func (TimeGranularity) Values added in v1.28.0

func (TimeGranularity) Values() []TimeGranularity

Values returns all known values for TimeGranularity. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TimeRangeDrillDownFilter added in v1.28.0

type TimeRangeDrillDownFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// The maximum value for the filter value range.
	//
	// This member is required.
	RangeMaximum *time.Time

	// The minimum value for the filter value range.
	//
	// This member is required.
	RangeMinimum *time.Time

	// The level of time precision that is used to aggregate DateTime values.
	//
	// This member is required.
	TimeGranularity TimeGranularity
	// contains filtered or unexported fields
}

The time range drill down filter.

type TimeRangeFilter added in v1.28.0

type TimeRangeFilter struct {

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// This option determines how null values should be treated when filtering data.
	//   - ALL_VALUES : Include null values in filtered results.
	//   - NULLS_ONLY : Only include null values in filtered results.
	//   - NON_NULLS_ONLY : Exclude null values from filtered results.
	//
	// This member is required.
	NullOption FilterNullOption

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration

	// The exclude period of the time range filter.
	ExcludePeriodConfiguration *ExcludePeriodConfiguration

	// Determines whether the maximum value in the filter value range should be
	// included in the filtered results.
	IncludeMaximum *bool

	// Determines whether the minimum value in the filter value range should be
	// included in the filtered results.
	IncludeMinimum *bool

	// The maximum value for the filter value range.
	RangeMaximumValue *TimeRangeFilterValue

	// The minimum value for the filter value range.
	RangeMinimumValue *TimeRangeFilterValue

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TimeGranularity
	// contains filtered or unexported fields
}

A TimeRangeFilter filters values that are between two specified values.

type TimeRangeFilterValue added in v1.28.0

type TimeRangeFilterValue struct {

	// The parameter type input value.
	Parameter *string

	// The rolling date input value.
	RollingDate *RollingDateConfiguration

	// The static input value.
	StaticValue *time.Time
	// contains filtered or unexported fields
}

The value of a time range filter. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type TooltipItem added in v1.28.0

type TooltipItem struct {

	// The tooltip item for the columns that are not part of a field well.
	ColumnTooltipItem *ColumnTooltipItem

	// The tooltip item for the fields.
	FieldTooltipItem *FieldTooltipItem
	// contains filtered or unexported fields
}

The tooltip. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type TooltipOptions added in v1.28.0

type TooltipOptions struct {

	// The setup for the detailed tooltip. The tooltip setup is always saved. The
	// display type is decided based on the tooltip type.
	FieldBasedTooltip *FieldBasedTooltip

	// The selected type for the tooltip. Choose one of the following options:
	//   - BASIC : A basic tooltip.
	//   - DETAILED : A detailed tooltip.
	SelectedTooltipType SelectedTooltipType

	// Determines whether or not the tooltip is visible.
	TooltipVisibility Visibility
	// contains filtered or unexported fields
}

The display options for the visual tooltip.

type TooltipTarget added in v1.59.0

type TooltipTarget string
const (
	TooltipTargetBoth TooltipTarget = "BOTH"
	TooltipTargetBar  TooltipTarget = "BAR"
	TooltipTargetLine TooltipTarget = "LINE"
)

Enum values for TooltipTarget

func (TooltipTarget) Values added in v1.59.0

func (TooltipTarget) Values() []TooltipTarget

Values returns all known values for TooltipTarget. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TooltipTitleType added in v1.28.0

type TooltipTitleType string
const (
	TooltipTitleTypeNone         TooltipTitleType = "NONE"
	TooltipTitleTypePrimaryValue TooltipTitleType = "PRIMARY_VALUE"
)

Enum values for TooltipTitleType

func (TooltipTitleType) Values added in v1.28.0

Values returns all known values for TooltipTitleType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopBottomComputationType added in v1.28.0

type TopBottomComputationType string
const (
	TopBottomComputationTypeTop    TopBottomComputationType = "TOP"
	TopBottomComputationTypeBottom TopBottomComputationType = "BOTTOM"
)

Enum values for TopBottomComputationType

func (TopBottomComputationType) Values added in v1.28.0

Values returns all known values for TopBottomComputationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopBottomFilter added in v1.28.0

type TopBottomFilter struct {

	// The aggregation and sort configuration of the top bottom filter.
	//
	// This member is required.
	AggregationSortConfigurations []AggregationSortConfiguration

	// The column that the filter is applied to.
	//
	// This member is required.
	Column *ColumnIdentifier

	// An identifier that uniquely identifies a filter within a dashboard, analysis,
	// or template.
	//
	// This member is required.
	FilterId *string

	// The default configurations for the associated controls. This applies only for
	// filters that are scoped to multiple sheets.
	DefaultFilterControlConfiguration *DefaultFilterControlConfiguration

	// The number of items to include in the top bottom filter results.
	Limit *int32

	// The parameter whose value should be used for the filter value.
	ParameterName *string

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TimeGranularity
	// contains filtered or unexported fields
}

A TopBottomFilter filters values that are at the top or the bottom.

type TopBottomMoversComputation added in v1.28.0

type TopBottomMoversComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The computation type. Choose from the following options:
	//   - TOP: Top movers computation.
	//   - BOTTOM: Bottom movers computation.
	//
	// This member is required.
	Type TopBottomComputationType

	// The category field that is used in a computation.
	Category *DimensionField

	// The mover size setup of the top and bottom movers computation.
	MoverSize *int32

	// The name of a computation.
	Name *string

	// The sort order setup of the top and bottom movers computation.
	SortOrder TopBottomSortOrder

	// The time field that is used in a computation.
	Time *DimensionField

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The top movers and bottom movers computation setup.

type TopBottomRankedComputation added in v1.28.0

type TopBottomRankedComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The computation type. Choose one of the following options:
	//   - TOP: A top ranked computation.
	//   - BOTTOM: A bottom ranked computation.
	//
	// This member is required.
	Type TopBottomComputationType

	// The category field that is used in a computation.
	Category *DimensionField

	// The name of a computation.
	Name *string

	// The result size of a top and bottom ranked computation.
	ResultSize *int32

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The top ranked and bottom ranked computation configuration.

type TopBottomSortOrder added in v1.28.0

type TopBottomSortOrder string
const (
	TopBottomSortOrderPercentDifference  TopBottomSortOrder = "PERCENT_DIFFERENCE"
	TopBottomSortOrderAbsoluteDifference TopBottomSortOrder = "ABSOLUTE_DIFFERENCE"
)

Enum values for TopBottomSortOrder

func (TopBottomSortOrder) Values added in v1.28.0

Values returns all known values for TopBottomSortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopicCalculatedField added in v1.35.0

type TopicCalculatedField struct {

	// The calculated field name.
	//
	// This member is required.
	CalculatedFieldName *string

	// The calculated field expression.
	//
	// This member is required.
	Expression *string

	// The default aggregation. Valid values for this structure are SUM , MAX , MIN ,
	// COUNT , DISTINCT_COUNT , and AVERAGE .
	Aggregation DefaultAggregation

	// The list of aggregation types that are allowed for the calculated field. Valid
	// values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM
	// , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
	AllowedAggregations []AuthorSpecifiedAggregation

	// The calculated field description.
	CalculatedFieldDescription *string

	// The other names or aliases for the calculated field.
	CalculatedFieldSynonyms []string

	// The other names or aliases for the calculated field cell value.
	CellValueSynonyms []CellValueSynonym

	// The column data role for a calculated field. Valid values for this structure
	// are DIMENSION and MEASURE .
	ColumnDataRole ColumnDataRole

	// The order in which data is displayed for the calculated field when it's used in
	// a comparative context.
	ComparativeOrder *ComparativeOrder

	// The default formatting definition.
	DefaultFormatting *DefaultFormatting

	// A Boolean value that indicates if a calculated field is visible in the
	// autocomplete.
	DisableIndexing *bool

	// A boolean value that indicates if a calculated field is included in the topic.
	IsIncludedInTopic bool

	// A Boolean value that indicates whether to never aggregate calculated field in
	// filters.
	NeverAggregateInFilter bool

	// The non additive for the table style target.
	NonAdditive *bool

	// The list of aggregation types that are not allowed for the calculated field.
	// Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN
	// , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
	NotAllowedAggregations []AuthorSpecifiedAggregation

	// The semantic type.
	SemanticType *SemanticType

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TopicTimeGranularity
	// contains filtered or unexported fields
}

A structure that represents a calculated field.

type TopicCategoryFilter added in v1.35.0

type TopicCategoryFilter struct {

	// The category filter function. Valid values for this structure are EXACT and
	// CONTAINS .
	CategoryFilterFunction CategoryFilterFunction

	// The category filter type. This element is used to specify whether a filter is a
	// simple category filter or an inverse category filter.
	CategoryFilterType CategoryFilterType

	// The constant used in a category filter.
	Constant *TopicCategoryFilterConstant

	// A Boolean value that indicates if the filter is inverse.
	Inverse bool
	// contains filtered or unexported fields
}

A structure that represents a category filter.

type TopicCategoryFilterConstant added in v1.35.0

type TopicCategoryFilterConstant struct {

	// A collective constant used in a category filter. This element is used to
	// specify a list of values for the constant.
	CollectiveConstant *CollectiveConstant

	// The type of category filter constant. This element is used to specify whether a
	// constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .
	ConstantType ConstantType

	// A singular constant used in a category filter. This element is used to specify
	// a single value for the constant.
	SingularConstant *string
	// contains filtered or unexported fields
}

A constant used in a category filter.

type TopicColumn added in v1.35.0

type TopicColumn struct {

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

	// The type of aggregation that is performed on the column data when it's queried.
	Aggregation DefaultAggregation

	// The list of aggregation types that are allowed for the column. Valid values for
	// this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE ,
	// STDEV , STDEVP , VAR , VARP , and PERCENTILE .
	AllowedAggregations []AuthorSpecifiedAggregation

	// The other names or aliases for the column cell value.
	CellValueSynonyms []CellValueSynonym

	// The role of the column in the data. Valid values are DIMENSION and MEASURE .
	ColumnDataRole ColumnDataRole

	// A description of the column and its contents.
	ColumnDescription *string

	// A user-friendly name for the column.
	ColumnFriendlyName *string

	// The other names or aliases for the column.
	ColumnSynonyms []string

	// The order in which data is displayed for the column when it's used in a
	// comparative context.
	ComparativeOrder *ComparativeOrder

	// The default formatting used for values in the column.
	DefaultFormatting *DefaultFormatting

	// A Boolean value that indicates whether the column shows in the autocomplete
	// functionality.
	DisableIndexing *bool

	// A Boolean value that indicates whether the column is included in the query
	// results.
	IsIncludedInTopic bool

	// A Boolean value that indicates whether to aggregate the column data when it's
	// used in a filter context.
	NeverAggregateInFilter bool

	// The non additive value for the column.
	NonAdditive *bool

	// The list of aggregation types that are not allowed for the column. Valid values
	// for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM ,
	// AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
	NotAllowedAggregations []AuthorSpecifiedAggregation

	// The semantic type of data contained in the column.
	SemanticType *SemanticType

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TopicTimeGranularity
	// contains filtered or unexported fields
}

Represents a column in a dataset.

type TopicDateRangeFilter added in v1.35.0

type TopicDateRangeFilter struct {

	// The constant used in a date range filter.
	Constant *TopicRangeFilterConstant

	// A Boolean value that indicates whether the date range filter should include the
	// boundary values. If set to true, the filter includes the start and end dates. If
	// set to false, the filter excludes them.
	Inclusive bool
	// contains filtered or unexported fields
}

A filter used to restrict data based on a range of dates or times.

type TopicDetails added in v1.35.0

type TopicDetails struct {

	// The data sets that the topic is associated with.
	DataSets []DatasetMetadata

	// The description of the topic.
	Description *string

	// The name of the topic.
	Name *string

	// The user experience version of a topic.
	UserExperienceVersion TopicUserExperienceVersion
	// contains filtered or unexported fields
}

A structure that describes the details of a topic, such as its name, description, and associated data sets.

type TopicFilter added in v1.35.0

type TopicFilter struct {

	// The name of the filter.
	//
	// This member is required.
	FilterName *string

	// The name of the field that the filter operates on.
	//
	// This member is required.
	OperandFieldName *string

	// The category filter that is associated with this filter.
	CategoryFilter *TopicCategoryFilter

	// The date range filter.
	DateRangeFilter *TopicDateRangeFilter

	// The class of the filter. Valid values for this structure are
	// ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .
	FilterClass FilterClass

	// A description of the filter used to select items for a topic.
	FilterDescription *string

	// The other names or aliases for the filter.
	FilterSynonyms []string

	// The type of the filter. Valid values for this structure are CATEGORY_FILTER ,
	// NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and
	// RELATIVE_DATE_FILTER .
	FilterType NamedFilterType

	// The numeric equality filter.
	NumericEqualityFilter *TopicNumericEqualityFilter

	// The numeric range filter.
	NumericRangeFilter *TopicNumericRangeFilter

	// The relative date filter.
	RelativeDateFilter *TopicRelativeDateFilter
	// contains filtered or unexported fields
}

A structure that represents a filter used to select items for a topic.

type TopicNamedEntity added in v1.35.0

type TopicNamedEntity struct {

	// The name of the named entity.
	//
	// This member is required.
	EntityName *string

	// The definition of a named entity.
	Definition []NamedEntityDefinition

	// The description of the named entity.
	EntityDescription *string

	// The other names or aliases for the named entity.
	EntitySynonyms []string

	// The type of named entity that a topic represents.
	SemanticEntityType *SemanticEntityType
	// contains filtered or unexported fields
}

A structure that represents a named entity.

type TopicNumericEqualityFilter added in v1.35.0

type TopicNumericEqualityFilter struct {

	// An aggregation function that specifies how to calculate the value of a numeric
	// field for a topic. Valid values for this structure are NO_AGGREGATION , SUM ,
	// AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR ,
	// and VARP .
	Aggregation NamedFilterAggType

	// The constant used in a numeric equality filter.
	Constant *TopicSingularFilterConstant
	// contains filtered or unexported fields
}

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

type TopicNumericRangeFilter added in v1.35.0

type TopicNumericRangeFilter struct {

	// An aggregation function that specifies how to calculate the value of a numeric
	// field for a topic, Valid values for this structure are NO_AGGREGATION , SUM ,
	// AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR ,
	// and VARP .
	Aggregation NamedFilterAggType

	// The constant used in a numeric range filter.
	Constant *TopicRangeFilterConstant

	// A Boolean value that indicates whether the endpoints of the numeric range are
	// included in the filter. If set to true, topics whose numeric field value is
	// equal to the endpoint values will be included in the filter. If set to false,
	// topics whose numeric field value is equal to the endpoint values will be
	// excluded from the filter.
	Inclusive bool
	// contains filtered or unexported fields
}

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

type TopicNumericSeparatorSymbol added in v1.35.0

type TopicNumericSeparatorSymbol string
const (
	TopicNumericSeparatorSymbolComma TopicNumericSeparatorSymbol = "COMMA"
	TopicNumericSeparatorSymbolDot   TopicNumericSeparatorSymbol = "DOT"
)

Enum values for TopicNumericSeparatorSymbol

func (TopicNumericSeparatorSymbol) Values added in v1.35.0

Values returns all known values for TopicNumericSeparatorSymbol. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopicRangeFilterConstant added in v1.35.0

type TopicRangeFilterConstant struct {

	// The data type of the constant value that is used in a range filter. Valid
	// values for this structure are RANGE .
	ConstantType ConstantType

	// The value of the constant that is used to specify the endpoints of a range
	// filter.
	RangeConstant *RangeConstant
	// contains filtered or unexported fields
}

A constant value that is used in a range filter to specify the endpoints of the range.

type TopicRefreshDetails added in v1.35.0

type TopicRefreshDetails struct {

	// The Amazon Resource Name (ARN) of the topic refresh.
	RefreshArn *string

	// The ID of the refresh, which occurs as a result of topic creation or topic
	// update.
	RefreshId *string

	// The status of the refresh job that indicates whether the job is still running,
	// completed successfully, or failed.
	RefreshStatus TopicRefreshStatus
	// contains filtered or unexported fields
}

The details about the refresh of a topic.

type TopicRefreshSchedule added in v1.35.0

type TopicRefreshSchedule struct {

	// A Boolean value that controls whether to schedule runs at the same schedule
	// that is specified in SPICE dataset.
	//
	// This member is required.
	BasedOnSpiceSchedule bool

	// A Boolean value that controls whether to schedule is enabled.
	//
	// This member is required.
	IsEnabled *bool

	// The time of day when the refresh should run, for example, Monday-Sunday.
	RepeatAt *string

	// The starting date and time for the refresh schedule.
	StartingAt *time.Time

	// The timezone that you want the refresh schedule to use.
	Timezone *string

	// The type of refresh schedule. Valid values for this structure are HOURLY , DAILY
	// , WEEKLY , and MONTHLY .
	TopicScheduleType TopicScheduleType
	// contains filtered or unexported fields
}

A structure that represents a topic refresh schedule.

type TopicRefreshScheduleSummary added in v1.35.0

type TopicRefreshScheduleSummary struct {

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

	// The ID of the dataset.
	DatasetId *string

	// The name of the dataset.
	DatasetName *string

	// The definition of a refresh schedule.
	RefreshSchedule *TopicRefreshSchedule
	// contains filtered or unexported fields
}

A summary of the refresh schedule details for a dataset.

type TopicRefreshStatus added in v1.35.0

type TopicRefreshStatus string
const (
	TopicRefreshStatusInitialized TopicRefreshStatus = "INITIALIZED"
	TopicRefreshStatusRunning     TopicRefreshStatus = "RUNNING"
	TopicRefreshStatusFailed      TopicRefreshStatus = "FAILED"
	TopicRefreshStatusCompleted   TopicRefreshStatus = "COMPLETED"
	TopicRefreshStatusCancelled   TopicRefreshStatus = "CANCELLED"
)

Enum values for TopicRefreshStatus

func (TopicRefreshStatus) Values added in v1.35.0

Values returns all known values for TopicRefreshStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopicRelativeDateFilter added in v1.35.0

type TopicRelativeDateFilter struct {

	// The constant used in a relative date filter.
	Constant *TopicSingularFilterConstant

	// The function to be used in a relative date filter to determine the range of
	// dates to include in the results. Valid values for this structure are BEFORE ,
	// AFTER , and BETWEEN .
	RelativeDateFilterFunction TopicRelativeDateFilterFunction

	// The level of time precision that is used to aggregate DateTime values.
	TimeGranularity TopicTimeGranularity
	// contains filtered or unexported fields
}

A structure that represents a relative date filter.

type TopicRelativeDateFilterFunction added in v1.35.0

type TopicRelativeDateFilterFunction string
const (
	TopicRelativeDateFilterFunctionPrevious TopicRelativeDateFilterFunction = "PREVIOUS"
	TopicRelativeDateFilterFunctionThis     TopicRelativeDateFilterFunction = "THIS"
	TopicRelativeDateFilterFunctionLast     TopicRelativeDateFilterFunction = "LAST"
	TopicRelativeDateFilterFunctionNext     TopicRelativeDateFilterFunction = "NEXT"
	TopicRelativeDateFilterFunctionNow      TopicRelativeDateFilterFunction = "NOW"
)

Enum values for TopicRelativeDateFilterFunction

func (TopicRelativeDateFilterFunction) Values added in v1.35.0

Values returns all known values for TopicRelativeDateFilterFunction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopicScheduleType added in v1.35.0

type TopicScheduleType string
const (
	TopicScheduleTypeHourly  TopicScheduleType = "HOURLY"
	TopicScheduleTypeDaily   TopicScheduleType = "DAILY"
	TopicScheduleTypeWeekly  TopicScheduleType = "WEEKLY"
	TopicScheduleTypeMonthly TopicScheduleType = "MONTHLY"
)

Enum values for TopicScheduleType

func (TopicScheduleType) Values added in v1.35.0

Values returns all known values for TopicScheduleType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopicSingularFilterConstant added in v1.35.0

type TopicSingularFilterConstant struct {

	// The type of the singular filter constant. Valid values for this structure are
	// SINGULAR .
	ConstantType ConstantType

	// The value of the singular filter constant.
	SingularConstant *string
	// contains filtered or unexported fields
}

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

type TopicSummary added in v1.35.0

type TopicSummary struct {

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

	// The name of the topic.
	Name *string

	// The ID for the topic. This ID is unique per Amazon Web Services Region for each
	// Amazon Web Services account.
	TopicId *string
	// contains filtered or unexported fields
}

A topic summary.

type TopicTimeGranularity added in v1.35.0

type TopicTimeGranularity string
const (
	TopicTimeGranularitySecond  TopicTimeGranularity = "SECOND"
	TopicTimeGranularityMinute  TopicTimeGranularity = "MINUTE"
	TopicTimeGranularityHour    TopicTimeGranularity = "HOUR"
	TopicTimeGranularityDay     TopicTimeGranularity = "DAY"
	TopicTimeGranularityWeek    TopicTimeGranularity = "WEEK"
	TopicTimeGranularityMonth   TopicTimeGranularity = "MONTH"
	TopicTimeGranularityQuarter TopicTimeGranularity = "QUARTER"
	TopicTimeGranularityYear    TopicTimeGranularity = "YEAR"
)

Enum values for TopicTimeGranularity

func (TopicTimeGranularity) Values added in v1.35.0

Values returns all known values for TopicTimeGranularity. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TopicUserExperienceVersion added in v1.55.0

type TopicUserExperienceVersion string
const (
	TopicUserExperienceVersionLegacy              TopicUserExperienceVersion = "LEGACY"
	TopicUserExperienceVersionNewReaderExperience TopicUserExperienceVersion = "NEW_READER_EXPERIENCE"
)

Enum values for TopicUserExperienceVersion

func (TopicUserExperienceVersion) Values added in v1.55.0

Values returns all known values for TopicUserExperienceVersion. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TotalAggregationComputation added in v1.28.0

type TotalAggregationComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The name of a computation.
	Name *string

	// The value field that is used in a computation.
	Value *MeasureField
	// contains filtered or unexported fields
}

The total aggregation computation configuration.

type TotalAggregationFunction added in v1.46.0

type TotalAggregationFunction struct {

	// A built in aggregation function for total values.
	SimpleTotalAggregationFunction SimpleTotalAggregationFunction
	// contains filtered or unexported fields
}

An aggregation function that aggregates the total values of a measure.

type TotalAggregationOption added in v1.46.0

type TotalAggregationOption struct {

	// The field id that's associated with the total aggregation option.
	//
	// This member is required.
	FieldId *string

	// The total aggregation function that you want to set for a specified field id.
	//
	// This member is required.
	TotalAggregationFunction *TotalAggregationFunction
	// contains filtered or unexported fields
}

The total aggregation settings map of a field id.

type TotalOptions added in v1.28.0

type TotalOptions struct {

	// The custom label string for the total cells.
	CustomLabel *string

	// The placement (start, end) for the total cells.
	Placement TableTotalsPlacement

	// The scroll status (pinned, scrolled) for the total cells.
	ScrollStatus TableTotalsScrollStatus

	// The total aggregation settings for each value field.
	TotalAggregationOptions []TotalAggregationOption

	// Cell styling options for the total cells.
	TotalCellStyle *TableCellStyle

	// The visibility configuration for the total cells.
	TotalsVisibility Visibility
	// contains filtered or unexported fields
}

The total options for a table visual.

type TransformOperation

type TransformOperation interface {
	// contains filtered or unexported methods
}

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.

The following types satisfy this interface:

TransformOperationMemberCastColumnTypeOperation
TransformOperationMemberCreateColumnsOperation
TransformOperationMemberFilterOperation
TransformOperationMemberOverrideDatasetParameterOperation
TransformOperationMemberProjectOperation
TransformOperationMemberRenameColumnOperation
TransformOperationMemberTagColumnOperation
TransformOperationMemberUntagColumnOperation
Example (OutputUsage)
package main

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

func main() {
	var union types.TransformOperation
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TransformOperationMemberCastColumnTypeOperation:
		_ = v.Value // Value is types.CastColumnTypeOperation

	case *types.TransformOperationMemberCreateColumnsOperation:
		_ = v.Value // Value is types.CreateColumnsOperation

	case *types.TransformOperationMemberFilterOperation:
		_ = v.Value // Value is types.FilterOperation

	case *types.TransformOperationMemberOverrideDatasetParameterOperation:
		_ = v.Value // Value is types.OverrideDatasetParameterOperation

	case *types.TransformOperationMemberProjectOperation:
		_ = v.Value // Value is types.ProjectOperation

	case *types.TransformOperationMemberRenameColumnOperation:
		_ = v.Value // Value is types.RenameColumnOperation

	case *types.TransformOperationMemberTagColumnOperation:
		_ = v.Value // Value is types.TagColumnOperation

	case *types.TransformOperationMemberUntagColumnOperation:
		_ = v.Value // Value is types.UntagColumnOperation

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type TransformOperationMemberCastColumnTypeOperation added in v0.31.0

type TransformOperationMemberCastColumnTypeOperation struct {
	Value CastColumnTypeOperation
	// contains filtered or unexported fields
}

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

type TransformOperationMemberCreateColumnsOperation added in v0.31.0

type TransformOperationMemberCreateColumnsOperation struct {
	Value CreateColumnsOperation
	// contains filtered or unexported fields
}

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

type TransformOperationMemberFilterOperation added in v0.31.0

type TransformOperationMemberFilterOperation struct {
	Value FilterOperation
	// contains filtered or unexported fields
}

An operation that filters rows based on some condition.

type TransformOperationMemberOverrideDatasetParameterOperation added in v1.35.0

type TransformOperationMemberOverrideDatasetParameterOperation struct {
	Value OverrideDatasetParameterOperation
	// contains filtered or unexported fields
}

A transform operation that overrides the dataset parameter values that are defined in another dataset.

type TransformOperationMemberProjectOperation added in v0.31.0

type TransformOperationMemberProjectOperation struct {
	Value ProjectOperation
	// contains filtered or unexported fields
}

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

type TransformOperationMemberRenameColumnOperation added in v0.31.0

type TransformOperationMemberRenameColumnOperation struct {
	Value RenameColumnOperation
	// contains filtered or unexported fields
}

An operation that renames a column.

type TransformOperationMemberTagColumnOperation added in v0.31.0

type TransformOperationMemberTagColumnOperation struct {
	Value TagColumnOperation
	// contains filtered or unexported fields
}

An operation that tags a column with additional information.

type TransformOperationMemberUntagColumnOperation added in v1.10.0

type TransformOperationMemberUntagColumnOperation struct {
	Value UntagColumnOperation
	// contains filtered or unexported fields
}

A transform operation that removes tags associated with a column.

type TreeMapAggregatedFieldWells added in v1.28.0

type TreeMapAggregatedFieldWells struct {

	// The color field well of a tree map. Values are grouped by aggregations based on
	// group by fields.
	Colors []MeasureField

	// The group by field well of a tree map. Values are grouped based on group by
	// fields.
	Groups []DimensionField

	// The size field well of a tree map. Values are aggregated based on group by
	// fields.
	Sizes []MeasureField
	// contains filtered or unexported fields
}

Aggregated field wells of a tree map.

type TreeMapConfiguration added in v1.28.0

type TreeMapConfiguration struct {

	// The label options (label text, label visibility) for the colors displayed in a
	// tree map.
	ColorLabelOptions *ChartAxisLabelOptions

	// The color options (gradient color, point of divergence) of a tree map.
	ColorScale *ColorScale

	// The options that determine if visual data labels are displayed.
	DataLabels *DataLabelOptions

	// The field wells of the visual.
	FieldWells *TreeMapFieldWells

	// The label options (label text, label visibility) of the groups that are
	// displayed in a tree map.
	GroupLabelOptions *ChartAxisLabelOptions

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend display setup of the visual.
	Legend *LegendOptions

	// The label options (label text, label visibility) of the sizes that are
	// displayed in a tree map.
	SizeLabelOptions *ChartAxisLabelOptions

	// The sort configuration of a tree map.
	SortConfiguration *TreeMapSortConfiguration

	// The tooltip display setup of the visual.
	Tooltip *TooltipOptions
	// contains filtered or unexported fields
}

The configuration of a tree map.

type TreeMapFieldWells added in v1.28.0

type TreeMapFieldWells struct {

	// The aggregated field wells of a tree map.
	TreeMapAggregatedFieldWells *TreeMapAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a tree map. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type TreeMapSortConfiguration added in v1.28.0

type TreeMapSortConfiguration struct {

	// The limit on the number of groups that are displayed.
	TreeMapGroupItemsLimitConfiguration *ItemsLimitConfiguration

	// The sort configuration of group by fields.
	TreeMapSort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a tree map.

type TreeMapVisual added in v1.28.0

type TreeMapVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *TreeMapConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A tree map. For more information, see Using tree maps (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the Amazon QuickSight User Guide.

type TrendArrowOptions added in v1.28.0

type TrendArrowOptions struct {

	// The visibility of the trend arrows.
	Visibility Visibility
	// contains filtered or unexported fields
}

The options that determine the presentation of trend arrows in a KPI visual.

type TrinoParameters added in v1.46.0

type TrinoParameters struct {

	// The catalog name for the Trino data source.
	//
	// This member is required.
	Catalog *string

	// The host name of the Trino data source.
	//
	// This member is required.
	Host *string

	// The port for the Trino data source.
	//
	// This member is required.
	Port *int32
	// contains filtered or unexported fields
}

The parameters that are required to connect to a Trino data source.

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
	// contains filtered or unexported fields
}

The parameters for Twitter.

type Typography added in v1.28.0

type Typography struct {

	// Determines the list of font families.
	FontFamilies []Font
	// contains filtered or unexported fields
}

Determines the typography options.

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
	// contains filtered or unexported fields
}

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

type URLTargetConfiguration added in v1.28.0

type URLTargetConfiguration string
const (
	URLTargetConfigurationNewTab    URLTargetConfiguration = "NEW_TAB"
	URLTargetConfigurationNewWindow URLTargetConfiguration = "NEW_WINDOW"
	URLTargetConfigurationSameTab   URLTargetConfiguration = "SAME_TAB"
)

Enum values for URLTargetConfiguration

func (URLTargetConfiguration) Values added in v1.28.0

Values returns all known values for URLTargetConfiguration. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UnaggregatedField added in v1.28.0

type UnaggregatedField struct {

	// The column that is used in the UnaggregatedField .
	//
	// This member is required.
	Column *ColumnIdentifier

	// The custom field ID.
	//
	// This member is required.
	FieldId *string

	// The format configuration of the field.
	FormatConfiguration *FormatConfiguration
	// contains filtered or unexported fields
}

The unaggregated field for a table.

type UndefinedSpecifiedValueType added in v1.35.0

type UndefinedSpecifiedValueType string
const (
	UndefinedSpecifiedValueTypeLeast UndefinedSpecifiedValueType = "LEAST"
	UndefinedSpecifiedValueTypeMost  UndefinedSpecifiedValueType = "MOST"
)

Enum values for UndefinedSpecifiedValueType

func (UndefinedSpecifiedValueType) Values added in v1.35.0

Values returns all known values for UndefinedSpecifiedValueType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UniqueValuesComputation added in v1.28.0

type UniqueValuesComputation struct {

	// The ID for a computation.
	//
	// This member is required.
	ComputationId *string

	// The category field that is used in a computation.
	Category *DimensionField

	// The name of a computation.
	Name *string
	// contains filtered or unexported fields
}

The unique values computation configuration.

type UnknownUnionMember added in v0.31.0

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UnsupportedPricingPlanException added in v0.31.0

type UnsupportedPricingPlanException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on the Manage Amazon QuickSight page. After capacity pricing is added, you can use the GetDashboardEmbedUrl (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html) API operation with the --identity-type ANONYMOUS option.

func (*UnsupportedPricingPlanException) Error added in v0.31.0

func (*UnsupportedPricingPlanException) ErrorCode added in v0.31.0

func (e *UnsupportedPricingPlanException) ErrorCode() string

func (*UnsupportedPricingPlanException) ErrorFault added in v0.31.0

func (*UnsupportedPricingPlanException) ErrorMessage added in v0.31.0

func (e *UnsupportedPricingPlanException) ErrorMessage() string

type UnsupportedUserEditionException

type UnsupportedUserEditionException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

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 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 UntagColumnOperation added in v1.10.0

type UntagColumnOperation struct {

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

	// The column tags to remove from this column.
	//
	// This member is required.
	TagNames []ColumnTagName
	// contains filtered or unexported fields
}

A transform operation that removes tags associated with a column.

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
	// contains filtered or unexported fields
}

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 supported external login provider that provides identity to let the
	// user federate into Amazon QuickSight with an associated IAM role. The type can
	// be one of the following.
	//   - COGNITO : Amazon Cognito. The provider URL is
	//   cognito-identity.amazonaws.com.
	//   - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
	ExternalLoginFederationProviderType *string

	// The URL of the external login provider.
	ExternalLoginFederationProviderUrl *string

	// The identity ID for the user in the external login provider.
	ExternalLoginId *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 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. This value is required if you are registering a user that
	// will be managed in Amazon QuickSight. In the output, the value for UserName is
	// N/A when the value for IdentityType is IAM and the corresponding IAM user is
	// deleted.
	UserName *string
	// contains filtered or unexported fields
}

A registered user of Amazon QuickSight.

type UserRole

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

Enum values for UserRole

func (UserRole) Values added in v0.29.0

func (UserRole) Values() []UserRole

Values returns all known values for UserRole. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VPCConnection added in v1.35.0

type VPCConnection struct {

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

	// The availability status of the VPC connection.
	AvailabilityStatus VPCConnectionAvailabilityStatus

	// The time that the VPC connection was created.
	CreatedTime *time.Time

	// A list of IP addresses of DNS resolver endpoints for the VPC connection.
	DnsResolvers []string

	// The time that the VPC connection was last updated.
	LastUpdatedTime *time.Time

	// The display name for the VPC connection.
	Name *string

	// A list of network interfaces.
	NetworkInterfaces []NetworkInterface

	// The ARN of the IAM role associated with the VPC connection.
	RoleArn *string

	// The Amazon EC2 security group IDs associated with the VPC connection.
	SecurityGroupIds []string

	// The status of the VPC connection.
	Status VPCConnectionResourceStatus

	// The ID of the VPC connection that you're creating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	VPCConnectionId *string

	// The Amazon EC2 VPC ID associated with the VPC connection.
	VPCId *string
	// contains filtered or unexported fields
}

The structure of a VPC connection.

type VPCConnectionAvailabilityStatus added in v1.35.0

type VPCConnectionAvailabilityStatus string
const (
	VPCConnectionAvailabilityStatusAvailable          VPCConnectionAvailabilityStatus = "AVAILABLE"
	VPCConnectionAvailabilityStatusUnavailable        VPCConnectionAvailabilityStatus = "UNAVAILABLE"
	VPCConnectionAvailabilityStatusPartiallyAvailable VPCConnectionAvailabilityStatus = "PARTIALLY_AVAILABLE"
)

Enum values for VPCConnectionAvailabilityStatus

func (VPCConnectionAvailabilityStatus) Values added in v1.35.0

Values returns all known values for VPCConnectionAvailabilityStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VPCConnectionResourceStatus added in v1.35.0

type VPCConnectionResourceStatus string
const (
	VPCConnectionResourceStatusCreationInProgress VPCConnectionResourceStatus = "CREATION_IN_PROGRESS"
	VPCConnectionResourceStatusCreationSuccessful VPCConnectionResourceStatus = "CREATION_SUCCESSFUL"
	VPCConnectionResourceStatusCreationFailed     VPCConnectionResourceStatus = "CREATION_FAILED"
	VPCConnectionResourceStatusUpdateInProgress   VPCConnectionResourceStatus = "UPDATE_IN_PROGRESS"
	VPCConnectionResourceStatusUpdateSuccessful   VPCConnectionResourceStatus = "UPDATE_SUCCESSFUL"
	VPCConnectionResourceStatusUpdateFailed       VPCConnectionResourceStatus = "UPDATE_FAILED"
	VPCConnectionResourceStatusDeletionInProgress VPCConnectionResourceStatus = "DELETION_IN_PROGRESS"
	VPCConnectionResourceStatusDeletionFailed     VPCConnectionResourceStatus = "DELETION_FAILED"
	VPCConnectionResourceStatusDeleted            VPCConnectionResourceStatus = "DELETED"
)

Enum values for VPCConnectionResourceStatus

func (VPCConnectionResourceStatus) Values added in v1.35.0

Values returns all known values for VPCConnectionResourceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VPCConnectionSummary added in v1.35.0

type VPCConnectionSummary struct {

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

	// The availability status of the VPC connection.
	AvailabilityStatus VPCConnectionAvailabilityStatus

	// The time that the VPC connection was created.
	CreatedTime *time.Time

	// A list of IP addresses of DNS resolver endpoints for the VPC connection.
	DnsResolvers []string

	// The time that the VPC connection was last updated.
	LastUpdatedTime *time.Time

	// The display name for the VPC connection.
	Name *string

	// A list of network interfaces.
	NetworkInterfaces []NetworkInterface

	// The ARN of the IAM role associated with the VPC connection.
	RoleArn *string

	// The Amazon EC2 security group IDs associated with the VPC connection.
	SecurityGroupIds []string

	// The status of the VPC connection.
	Status VPCConnectionResourceStatus

	// The ID of the VPC connection that you're creating. This ID is a unique
	// identifier for each Amazon Web Services Region in an Amazon Web Services
	// account.
	VPCConnectionId *string

	// The Amazon EC2 VPC ID associated with the VPC connection.
	VPCId *string
	// contains filtered or unexported fields
}

The summary metadata that describes a VPC connection.

type ValidationStrategy added in v1.45.0

type ValidationStrategy struct {

	// The mode of validation for the asset to be created or updated. When you set
	// this value to STRICT , strict validation for every error is enforced. When you
	// set this value to LENIENT , validation is skipped for specific UI errors.
	//
	// This member is required.
	Mode ValidationStrategyMode
	// contains filtered or unexported fields
}

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT , validation is skipped for specific errors.

type ValidationStrategyMode added in v1.45.0

type ValidationStrategyMode string
const (
	ValidationStrategyModeStrict  ValidationStrategyMode = "STRICT"
	ValidationStrategyModeLenient ValidationStrategyMode = "LENIENT"
)

Enum values for ValidationStrategyMode

func (ValidationStrategyMode) Values added in v1.45.0

Values returns all known values for ValidationStrategyMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ValueWhenUnsetOption added in v1.28.0

type ValueWhenUnsetOption string
const (
	ValueWhenUnsetOptionRecommendedValue ValueWhenUnsetOption = "RECOMMENDED_VALUE"
	ValueWhenUnsetOptionNull             ValueWhenUnsetOption = "NULL"
)

Enum values for ValueWhenUnsetOption

func (ValueWhenUnsetOption) Values added in v1.28.0

Values returns all known values for ValueWhenUnsetOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VerticalTextAlignment added in v1.28.0

type VerticalTextAlignment string
const (
	VerticalTextAlignmentTop    VerticalTextAlignment = "TOP"
	VerticalTextAlignmentMiddle VerticalTextAlignment = "MIDDLE"
	VerticalTextAlignmentBottom VerticalTextAlignment = "BOTTOM"
	VerticalTextAlignmentAuto   VerticalTextAlignment = "AUTO"
)

Enum values for VerticalTextAlignment

func (VerticalTextAlignment) Values added in v1.28.0

Values returns all known values for VerticalTextAlignment. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Visibility added in v1.28.0

type Visibility string
const (
	VisibilityHidden  Visibility = "HIDDEN"
	VisibilityVisible Visibility = "VISIBLE"
)

Enum values for Visibility

func (Visibility) Values added in v1.28.0

func (Visibility) Values() []Visibility

Values returns all known values for Visibility. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VisibleRangeOptions added in v1.28.0

type VisibleRangeOptions struct {

	// The percent range in the visible range.
	PercentRange *PercentVisibleRange
	// contains filtered or unexported fields
}

The range options for the data zoom scroll bar.

type Visual added in v1.28.0

type Visual struct {

	// A bar chart. For more information, see Using bar charts (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html)
	// in the Amazon QuickSight User Guide.
	BarChartVisual *BarChartVisual

	// A box plot. For more information, see Using box plots (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html)
	// in the Amazon QuickSight User Guide.
	BoxPlotVisual *BoxPlotVisual

	// A combo chart. For more information, see Using combo charts (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html)
	// in the Amazon QuickSight User Guide.
	ComboChartVisual *ComboChartVisual

	// A visual that contains custom content. For more information, see Using custom
	// visual content (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html)
	// in the Amazon QuickSight User Guide.
	CustomContentVisual *CustomContentVisual

	// An empty visual.
	EmptyVisual *EmptyVisual

	// A filled map. For more information, see Creating filled maps (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html)
	// in the Amazon QuickSight User Guide.
	FilledMapVisual *FilledMapVisual

	// A funnel chart. For more information, see Using funnel charts (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html)
	// in the Amazon QuickSight User Guide.
	FunnelChartVisual *FunnelChartVisual

	// A gauge chart. For more information, see Using gauge charts (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html)
	// in the Amazon QuickSight User Guide.
	GaugeChartVisual *GaugeChartVisual

	// A geospatial map or a points on map visual. For more information, see Creating
	// point maps (https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html)
	// in the Amazon QuickSight User Guide.
	GeospatialMapVisual *GeospatialMapVisual

	// A heat map. For more information, see Using heat maps (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html)
	// in the Amazon QuickSight User Guide.
	HeatMapVisual *HeatMapVisual

	// A histogram. For more information, see Using histograms (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html)
	// in the Amazon QuickSight User Guide.
	HistogramVisual *HistogramVisual

	// An insight visual. For more information, see Working with insights (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html)
	// in the Amazon QuickSight User Guide.
	InsightVisual *InsightVisual

	// A key performance indicator (KPI). For more information, see Using KPIs (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html)
	// in the Amazon QuickSight User Guide.
	KPIVisual *KPIVisual

	// A line chart. For more information, see Using line charts (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html)
	// in the Amazon QuickSight User Guide.
	LineChartVisual *LineChartVisual

	// A pie or donut chart. For more information, see Using pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html)
	// in the Amazon QuickSight User Guide.
	PieChartVisual *PieChartVisual

	// A pivot table. For more information, see Using pivot tables (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html)
	// in the Amazon QuickSight User Guide.
	PivotTableVisual *PivotTableVisual

	// A radar chart visual. For more information, see Using radar charts (https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html)
	// in the Amazon QuickSight User Guide.
	RadarChartVisual *RadarChartVisual

	// A sankey diagram. For more information, see Using Sankey diagrams (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html)
	// in the Amazon QuickSight User Guide.
	SankeyDiagramVisual *SankeyDiagramVisual

	// A scatter plot. For more information, see Using scatter plots (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html)
	// in the Amazon QuickSight User Guide.
	ScatterPlotVisual *ScatterPlotVisual

	// A table visual. For more information, see Using tables as visuals (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html)
	// in the Amazon QuickSight User Guide.
	TableVisual *TableVisual

	// A tree map. For more information, see Using tree maps (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html)
	// in the Amazon QuickSight User Guide.
	TreeMapVisual *TreeMapVisual

	// A waterfall chart. For more information, see Using waterfall charts (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html)
	// in the Amazon QuickSight User Guide.
	WaterfallVisual *WaterfallVisual

	// A word cloud. For more information, see Using word clouds (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html)
	// in the Amazon QuickSight User Guide.
	WordCloudVisual *WordCloudVisual
	// contains filtered or unexported fields
}

A visual displayed on a sheet in an analysis, dashboard, or template. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type VisualAxisSortOption added in v1.31.0

type VisualAxisSortOption struct {

	// The availaiblity status of a visual's axis sort options.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The axis sort options for a visual.

type VisualCustomAction added in v1.28.0

type VisualCustomAction struct {

	// A list of VisualCustomActionOperations . This is a union type structure. For
	// this structure to be valid, only one of the attributes can be defined.
	//
	// This member is required.
	ActionOperations []VisualCustomActionOperation

	// The ID of the VisualCustomAction .
	//
	// This member is required.
	CustomActionId *string

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

	// The trigger of the VisualCustomAction . Valid values are defined as follows:
	//   - DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a
	//   data point.
	//   - DATA_POINT_MENU : Initiates a custom action by right pointer click from the
	//   menu.
	//
	// This member is required.
	Trigger VisualCustomActionTrigger

	// The status of the VisualCustomAction .
	Status WidgetStatus
	// contains filtered or unexported fields
}

A custom action defined on a visual.

type VisualCustomActionOperation added in v1.28.0

type VisualCustomActionOperation struct {

	// The filter operation that filters data included in a visual or in an entire
	// sheet.
	FilterOperation *CustomActionFilterOperation

	// The navigation operation that navigates between different sheets in the same
	// analysis.
	NavigationOperation *CustomActionNavigationOperation

	// The set parameter operation that sets parameters in custom action.
	SetParametersOperation *CustomActionSetParametersOperation

	// The URL operation that opens a link to another webpage.
	URLOperation *CustomActionURLOperation
	// contains filtered or unexported fields
}

The operation that is defined by the custom action. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type VisualCustomActionTrigger added in v1.28.0

type VisualCustomActionTrigger string
const (
	VisualCustomActionTriggerDataPointClick VisualCustomActionTrigger = "DATA_POINT_CLICK"
	VisualCustomActionTriggerDataPointMenu  VisualCustomActionTrigger = "DATA_POINT_MENU"
)

Enum values for VisualCustomActionTrigger

func (VisualCustomActionTrigger) Values added in v1.28.0

Values returns all known values for VisualCustomActionTrigger. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VisualInteractionOptions added in v1.56.0

type VisualInteractionOptions struct {

	// The context menu options for a visual.
	ContextMenuOption *ContextMenuOption

	// The on-visual menu options for a visual.
	VisualMenuOption *VisualMenuOption
	// contains filtered or unexported fields
}

The general visual interactions setup for visual publish options

type VisualMenuOption added in v1.31.0

type VisualMenuOption struct {

	// The availaiblity status of a visual's menu options.
	AvailabilityStatus DashboardBehavior
	// contains filtered or unexported fields
}

The menu options for a visual.

type VisualPalette added in v1.28.0

type VisualPalette struct {

	// The chart color options for the visual palette.
	ChartColor *string

	// The color map options for the visual palette.
	ColorMap []DataPathColor
	// contains filtered or unexported fields
}

The visual display options for the visual palette.

type VisualSubtitleLabelOptions added in v1.28.0

type VisualSubtitleLabelOptions struct {

	// The long text format of the subtitle label, such as plain text or rich text.
	FormatText *LongFormatText

	// The visibility of the subtitle label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The subtitle label options for a visual.

type VisualTitleLabelOptions added in v1.28.0

type VisualTitleLabelOptions struct {

	// The short text format of the title label, such as plain text or rich text.
	FormatText *ShortFormatText

	// The visibility of the title label.
	Visibility Visibility
	// contains filtered or unexported fields
}

The title label options for a visual.

type VpcConnectionProperties

type VpcConnectionProperties struct {

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

VPC connection properties.

type WaterfallChartAggregatedFieldWells added in v1.28.0

type WaterfallChartAggregatedFieldWells struct {

	// The breakdown field wells of a waterfall visual.
	Breakdowns []DimensionField

	// The category field wells of a waterfall visual.
	Categories []DimensionField

	// The value field wells of a waterfall visual.
	Values []MeasureField
	// contains filtered or unexported fields
}

The field well configuration of a waterfall visual.

type WaterfallChartColorConfiguration added in v1.56.0

type WaterfallChartColorConfiguration struct {

	// The color configuration for individual groups within a waterfall visual.
	GroupColorConfiguration *WaterfallChartGroupColorConfiguration
	// contains filtered or unexported fields
}

The color configuration of a waterfall visual.

type WaterfallChartConfiguration added in v1.28.0

type WaterfallChartConfiguration struct {

	// The options that determine the presentation of the category axis.
	CategoryAxisDisplayOptions *AxisDisplayOptions

	// The options that determine the presentation of the category axis label.
	CategoryAxisLabelOptions *ChartAxisLabelOptions

	// The color configuration of a waterfall visual.
	ColorConfiguration *WaterfallChartColorConfiguration

	// The data label configuration of a waterfall visual.
	DataLabels *DataLabelOptions

	// The field well configuration of a waterfall visual.
	FieldWells *WaterfallChartFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The legend configuration of a waterfall visual.
	Legend *LegendOptions

	// The options that determine the presentation of the y-axis.
	PrimaryYAxisDisplayOptions *AxisDisplayOptions

	// The options that determine the presentation of the y-axis label.
	PrimaryYAxisLabelOptions *ChartAxisLabelOptions

	// The sort configuration of a waterfall visual.
	SortConfiguration *WaterfallChartSortConfiguration

	// The visual palette configuration of a waterfall visual.
	VisualPalette *VisualPalette

	// The options that determine the presentation of a waterfall visual.
	WaterfallChartOptions *WaterfallChartOptions
	// contains filtered or unexported fields
}

The configuration for a waterfall visual.

type WaterfallChartFieldWells added in v1.28.0

type WaterfallChartFieldWells struct {

	// The field well configuration of a waterfall visual.
	WaterfallChartAggregatedFieldWells *WaterfallChartAggregatedFieldWells
	// contains filtered or unexported fields
}

The field well configuration of a waterfall visual.

type WaterfallChartGroupColorConfiguration added in v1.56.0

type WaterfallChartGroupColorConfiguration struct {

	// Defines the color for the negative bars of a waterfall chart.
	NegativeBarColor *string

	// Defines the color for the positive bars of a waterfall chart.
	PositiveBarColor *string

	// Defines the color for the total bars of a waterfall chart.
	TotalBarColor *string
	// contains filtered or unexported fields
}

The color configuration for individual groups within a waterfall visual.

type WaterfallChartOptions added in v1.28.0

type WaterfallChartOptions struct {

	// This option determines the total bar label of a waterfall visual.
	TotalBarLabel *string
	// contains filtered or unexported fields
}

The options that determine the presentation of a waterfall visual.

type WaterfallChartSortConfiguration added in v1.28.0

type WaterfallChartSortConfiguration struct {

	// The limit on the number of bar groups that are displayed.
	BreakdownItemsLimit *ItemsLimitConfiguration

	// The sort configuration of the category fields.
	CategorySort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a waterfall visual.

type WaterfallVisual added in v1.28.0

type WaterfallVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers.
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration for a waterfall visual.
	ChartConfiguration *WaterfallChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A waterfall chart. For more information, see Using waterfall charts (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the Amazon QuickSight User Guide.

type WhatIfPointScenario added in v1.28.0

type WhatIfPointScenario struct {

	// The date that you need the forecast results for.
	//
	// This member is required.
	Date *time.Time

	// The target value that you want to meet for the provided date.
	//
	// This member is required.
	Value float64
	// contains filtered or unexported fields
}

Provides the forecast to meet the target for a particular date.

type WhatIfRangeScenario added in v1.28.0

type WhatIfRangeScenario struct {

	// The end date in the date range that you need the forecast results for.
	//
	// This member is required.
	EndDate *time.Time

	// The start date in the date range that you need the forecast results for.
	//
	// This member is required.
	StartDate *time.Time

	// The target value that you want to meet for the provided date range.
	//
	// This member is required.
	Value float64
	// contains filtered or unexported fields
}

Provides the forecast to meet the target for a particular date range.

type WidgetStatus added in v1.28.0

type WidgetStatus string
const (
	WidgetStatusEnabled  WidgetStatus = "ENABLED"
	WidgetStatusDisabled WidgetStatus = "DISABLED"
)

Enum values for WidgetStatus

func (WidgetStatus) Values added in v1.28.0

func (WidgetStatus) Values() []WidgetStatus

Values returns all known values for WidgetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WordCloudAggregatedFieldWells added in v1.28.0

type WordCloudAggregatedFieldWells struct {

	// The group by field well of a word cloud. Values are grouped by group by fields.
	GroupBy []DimensionField

	// The size field well of a word cloud. Values are aggregated based on group by
	// fields.
	Size []MeasureField
	// contains filtered or unexported fields
}

The aggregated field wells of a word cloud.

type WordCloudChartConfiguration added in v1.28.0

type WordCloudChartConfiguration struct {

	// The label options (label text, label visibility, and sort icon visibility) for
	// the word cloud category.
	CategoryLabelOptions *ChartAxisLabelOptions

	// The field wells of the visual.
	FieldWells *WordCloudFieldWells

	// The general visual interactions setup for a visual.
	Interactions *VisualInteractionOptions

	// The sort configuration of a word cloud visual.
	SortConfiguration *WordCloudSortConfiguration

	// The options for a word cloud visual.
	WordCloudOptions *WordCloudOptions
	// contains filtered or unexported fields
}

The configuration of a word cloud visual.

type WordCloudCloudLayout added in v1.28.0

type WordCloudCloudLayout string
const (
	WordCloudCloudLayoutFluid  WordCloudCloudLayout = "FLUID"
	WordCloudCloudLayoutNormal WordCloudCloudLayout = "NORMAL"
)

Enum values for WordCloudCloudLayout

func (WordCloudCloudLayout) Values added in v1.28.0

Values returns all known values for WordCloudCloudLayout. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WordCloudFieldWells added in v1.28.0

type WordCloudFieldWells struct {

	// The aggregated field wells of a word cloud.
	WordCloudAggregatedFieldWells *WordCloudAggregatedFieldWells
	// contains filtered or unexported fields
}

The field wells of a word cloud visual. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

type WordCloudOptions added in v1.28.0

type WordCloudOptions struct {

	// The cloud layout options (fluid, normal) of a word cloud.
	CloudLayout WordCloudCloudLayout

	// The length limit of each word from 1-100.
	MaximumStringLength *int32

	// The word casing options (lower_case, existing_case) for the words in a word
	// cloud.
	WordCasing WordCloudWordCasing

	// The word orientation options (horizontal, horizontal_and_vertical) for the
	// words in a word cloud.
	WordOrientation WordCloudWordOrientation

	// The word padding options (none, small, medium, large) for the words in a word
	// cloud.
	WordPadding WordCloudWordPadding

	// The word scaling options (emphasize, normal) for the words in a word cloud.
	WordScaling WordCloudWordScaling
	// contains filtered or unexported fields
}

The word cloud options for a word cloud visual.

type WordCloudSortConfiguration added in v1.28.0

type WordCloudSortConfiguration struct {

	// The limit on the number of groups that are displayed in a word cloud.
	CategoryItemsLimit *ItemsLimitConfiguration

	// The sort configuration of group by fields.
	CategorySort []FieldSortOptions
	// contains filtered or unexported fields
}

The sort configuration of a word cloud visual.

type WordCloudVisual added in v1.28.0

type WordCloudVisual struct {

	// The unique identifier of a visual. This identifier must be unique within the
	// context of a dashboard, template, or analysis. Two dashboards, analyses, or
	// templates can have visuals with the same identifiers..
	//
	// This member is required.
	VisualId *string

	// The list of custom actions that are configured for a visual.
	Actions []VisualCustomAction

	// The configuration settings of the visual.
	ChartConfiguration *WordCloudChartConfiguration

	// The column hierarchy that is used during drill-downs and drill-ups.
	ColumnHierarchies []ColumnHierarchy

	// The subtitle that is displayed on the visual.
	Subtitle *VisualSubtitleLabelOptions

	// The title that is displayed on the visual.
	Title *VisualTitleLabelOptions
	// contains filtered or unexported fields
}

A word cloud. For more information, see Using word clouds (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the Amazon QuickSight User Guide.

type WordCloudWordCasing added in v1.28.0

type WordCloudWordCasing string
const (
	WordCloudWordCasingLowerCase    WordCloudWordCasing = "LOWER_CASE"
	WordCloudWordCasingExistingCase WordCloudWordCasing = "EXISTING_CASE"
)

Enum values for WordCloudWordCasing

func (WordCloudWordCasing) Values added in v1.28.0

Values returns all known values for WordCloudWordCasing. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WordCloudWordOrientation added in v1.28.0

type WordCloudWordOrientation string
const (
	WordCloudWordOrientationHorizontal            WordCloudWordOrientation = "HORIZONTAL"
	WordCloudWordOrientationHorizontalAndVertical WordCloudWordOrientation = "HORIZONTAL_AND_VERTICAL"
)

Enum values for WordCloudWordOrientation

func (WordCloudWordOrientation) Values added in v1.28.0

Values returns all known values for WordCloudWordOrientation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WordCloudWordPadding added in v1.28.0

type WordCloudWordPadding string
const (
	WordCloudWordPaddingNone   WordCloudWordPadding = "NONE"
	WordCloudWordPaddingSmall  WordCloudWordPadding = "SMALL"
	WordCloudWordPaddingMedium WordCloudWordPadding = "MEDIUM"
	WordCloudWordPaddingLarge  WordCloudWordPadding = "LARGE"
)

Enum values for WordCloudWordPadding

func (WordCloudWordPadding) Values added in v1.28.0

Values returns all known values for WordCloudWordPadding. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WordCloudWordScaling added in v1.28.0

type WordCloudWordScaling string
const (
	WordCloudWordScalingEmphasize WordCloudWordScaling = "EMPHASIZE"
	WordCloudWordScalingNormal    WordCloudWordScaling = "NORMAL"
)

Enum values for WordCloudWordScaling

func (WordCloudWordScaling) Values added in v1.28.0

Values returns all known values for WordCloudWordScaling. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type YAxisOptions added in v1.54.0

type YAxisOptions struct {

	// The Y axis type to be used in the chart. If you choose PRIMARY_Y_AXIS , the
	// primary Y Axis is located on the leftmost vertical axis of the chart.
	//
	// This member is required.
	YAxis SingleYAxisOption
	// contains filtered or unexported fields
}

The options that are available for a single Y axis in a chart.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL