String requestId
The Amazon Web Services request ID for this request.
String accountName
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.
String edition
The edition of your Amazon QuickSight account.
String notificationEmail
The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
String authenticationType
The way that your Amazon QuickSight account is authenticated.
String accountSubscriptionStatus
The status of your account subscription.
String accountName
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.
String edition
The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
String defaultNamespace
The default Amazon QuickSight namespace for your Amazon Web Services account.
String notificationEmail
The main notification email for your Amazon QuickSight subscription.
Boolean publicSharingEnabled
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.
Boolean terminationProtectionEnabled
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.
String availabilityStatus
Availability status.
NumericalAggregationFunction numericalAggregationFunction
Aggregation for numerical values.
String categoricalAggregationFunction
Aggregation for categorical values.
COUNT
: Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT
: Aggregate by the total number of distinct values.
String dateAggregationFunction
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.
ColumnIdentifier column
The column that determines the sort order of aggregated values.
String sortDirection
The sort direction of values.
ASC
: Sort in ascending order.
DESC
: Sort in descending order.
AggregationFunction aggregationFunction
The function that aggregates the values in Column
.
String domain
The OpenSearch domain.
String domain
The OpenSearch domain.
String analysisId
The ID of the analysis.
String arn
The Amazon Resource Name (ARN) of the analysis.
String name
The descriptive name of the analysis.
String status
Status associated with the analysis.
List<E> errors
Errors associated with the analysis.
List<E> dataSetArns
The ARNs of the datasets of the analysis.
String themeArn
The ARN of the theme of the analysis.
Date createdTime
The time that the analysis was created.
Date lastUpdatedTime
The time that the analysis was last updated.
List<E> sheets
A list of the associated sheets with the unique identifier and name of each sheet.
DefaultNewSheetConfiguration defaultNewSheetConfiguration
The configuration for default new sheet settings.
List<E> dataSetIdentifierDeclarations
An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
List<E> sheets
An array of sheet definitions for an analysis. Each SheetDefinition
provides detailed information
about a sheet within this analysis.
List<E> calculatedFields
An array of calculated field definitions for the analysis.
List<E> parameterDeclarations
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 in the Amazon QuickSight User Guide.
List<E> filterGroups
Filter definitions for an analysis.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
List<E> columnConfigurations
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.
AnalysisDefaults analysisDefaults
String operator
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
.
String name
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.
String value
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"
.
AnalysisSourceTemplate sourceTemplate
The source template for the source entity of the analysis.
String arn
The Amazon Resource Name (ARN) for the analysis.
String analysisId
The ID of the analysis. This ID displays in the URL.
String name
The name of the analysis. This name is displayed in the Amazon QuickSight console.
String status
The last known status for the analysis.
Date createdTime
The time that the analysis was created.
Date lastUpdatedTime
The time that the analysis was last updated.
String initialDashboardId
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
.
DashboardVisualId initialDashboardVisualId
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
.
AnonymousUserDashboardEmbeddingConfiguration dashboard
The type of embedding experience. In this case, Amazon QuickSight dashboards.
AnonymousUserDashboardVisualEmbeddingConfiguration dashboardVisual
The type of embedding experience. In this case, Amazon QuickSight visuals.
AnonymousUserQSearchBarEmbeddingConfiguration qSearchBar
The Q search bar that you want to use for anonymous user embedding.
String initialTopicId
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
.
ArcAxisDisplayRange range
The arc axis range of a GaugeChartVisual
.
Integer reserveRange
The reserved range of the arc axis.
String arcThickness
The arc thickness of a GaugeChartVisual
.
String workGroup
The workgroup that Amazon Athena uses.
String roleArn
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.
String dataSetName
Dataset name.
NumericAxisOptions numericAxisOptions
The options for an axis with a numeric field.
DateAxisOptions dateAxisOptions
The options for an axis with a date field.
AxisTickLabelOptions tickLabelOptions
The tick label options of an axis.
String axisLineVisibility
Determines whether or not the axis line is visible.
String gridLineVisibility
Determines whether or not the grid line is visible.
AxisDataOptions dataOptions
The data options for an axis.
ScrollBarOptions scrollbarOptions
The scroll bar options for an axis.
String axisOffset
The offset value that determines the starting placement of the axis within a visual's bounds.
AxisDisplayMinMaxRange minMax
The minimum and maximum setup of an axis display range.
AxisDisplayDataDrivenRange dataDriven
The data-driven setup of an axis display range.
FontConfiguration fontConfiguration
The font configuration of the axis label.
String customLabel
The text for the axis label.
AxisLabelReferenceOptions applyTo
The options that indicate which field the label belongs to.
String fieldId
The field that the axis label is targeted to.
ColumnIdentifier column
The column that the axis label is targeted to.
Double base
The base setup of a logarithmic axis scale.
AxisLinearScale linear
The linear axis scale setup.
AxisLogarithmicScale logarithmic
The logarithmic axis scale setup.
LabelOptions labelOptions
Determines whether or not the axis ticks are visible.
Double rotationAngle
The rotation angle of the axis tick labels.
List<E> category
The category (y-axis) field well of a bar chart.
List<E> values
The value field wells of a bar chart. Values are aggregated by category.
List<E> colors
The color (group/color) field well of a bar chart.
List<E> smallMultiples
The small multiples field well of a bar chart.
BarChartFieldWells fieldWells
The field wells of the visual.
BarChartSortConfiguration sortConfiguration
The sort configuration of a BarChartVisual
.
String orientation
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.
String barsArrangement
Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
VisualPalette visualPalette
The palette (chart color) display setup of the visual.
SmallMultiplesOptions smallMultiplesOptions
The small multiples setup for the visual.
AxisDisplayOptions categoryAxis
The label display options (grid line, range, scale, axis step) for bar chart category.
ChartAxisLabelOptions categoryLabelOptions
The label options (label text, label visibility and sort icon visibility) for a bar chart.
AxisDisplayOptions valueAxis
The label display options (grid line, range, scale, axis step) for a bar chart value.
ChartAxisLabelOptions valueLabelOptions
The label options (label text, label visibility and sort icon visibility) for a bar chart value.
ChartAxisLabelOptions colorLabelOptions
The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
LegendOptions legend
The legend display setup of the visual.
DataLabelOptions dataLabels
The options that determine if visual data labels are displayed.
TooltipOptions tooltip
The tooltip display setup of the visual.
List<E> referenceLines
The reference line setup of the visual.
List<E> contributionAnalysisDefaults
The contribution analysis (anomaly configuration) setup of the visual.
BarChartAggregatedFieldWells barChartAggregatedFieldWells
The aggregated field wells of a bar chart.
List<E> categorySort
The sort configuration of category fields.
ItemsLimitConfiguration categoryItemsLimit
The limit on the number of categories displayed in a bar chart.
List<E> colorSort
The sort configuration of color fields in a bar chart.
ItemsLimitConfiguration colorItemsLimit
The limit on the number of values displayed in a bar chart.
List<E> smallMultiplesSort
The sort configuration of the small multiples field.
ItemsLimitConfiguration smallMultiplesLimitConfiguration
The limit on the number of small multiples panels that are displayed.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
BarChartConfiguration chartConfiguration
The configuration settings of the visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
Integer value
The options that determine the bin count value.
String sectionId
The unique identifier of a body section.
BodySectionContent content
The configuration of content in a body section.
SectionStyle style
The style options of a body section.
SectionPageBreakConfiguration pageBreakConfiguration
The configuration of a page break for a section.
SectionLayoutConfiguration layout
The layout configuration of a body section.
Boolean show
The option to enable display of borders for visuals.
BoxPlotFieldWells fieldWells
The field wells of the visual.
BoxPlotSortConfiguration sortConfiguration
The sort configuration of a BoxPlotVisual
.
BoxPlotOptions boxPlotOptions
The box plot chart options for a box plot visual
AxisDisplayOptions categoryAxis
The label display options (grid line, range, scale, axis step) of a box plot category.
ChartAxisLabelOptions categoryLabelOptions
The label options (label text, label visibility and sort Icon visibility) of a box plot category.
AxisDisplayOptions primaryYAxisDisplayOptions
The label display options (grid line, range, scale, axis step) of a box plot category.
ChartAxisLabelOptions primaryYAxisLabelOptions
The label options (label text, label visibility and sort icon visibility) of a box plot value.
LegendOptions legend
TooltipOptions tooltip
The tooltip display setup of the visual.
List<E> referenceLines
The reference line setup of the visual.
VisualPalette visualPalette
The palette (chart color) display setup of the visual.
BoxPlotAggregatedFieldWells boxPlotAggregatedFieldWells
The aggregated field wells of a box plot.
BoxPlotStyleOptions styleOptions
The style options of the box plot.
String outlierVisibility
Determines the visibility of the outlier in a box plot.
String allDataPointsVisibility
Determines the visibility of all data points of the box plot.
List<E> categorySort
The sort configuration of a group by fields.
PaginationConfiguration paginationConfiguration
The pagination configuration of a table visual or box plot.
String fillStyle
The fill styles (solid, transparent) of the box plot.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
BoxPlotChartConfiguration chartConfiguration
The configuration settings of the visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
String columnName
Column name.
String columnId
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.
String expression
An expression that defines the calculated column.
String sourceSheetControlId
The source sheet control ID of a CascadingControlSource
.
ColumnIdentifier columnToMatch
The column identifier that determines which column to look up for the source sheet control.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the CategoricalDimensionField
.
String hierarchyId
The custom hierarchy ID.
StringFormatConfiguration formatConfiguration
The format configuration of the field.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the CategoricalMeasureField
.
String aggregationFunction
The aggregation function of the measure field.
StringFormatConfiguration formatConfiguration
The format configuration of the field.
ColumnIdentifier column
The column that the filter is applied to.
List<E> categoryValues
A list of the string inputs that are the values of the category drill down filter.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
CategoryFilterConfiguration configuration
The configuration for a CategoryFilter
.
FilterListConfiguration filterListConfiguration
A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.
CustomFilterListConfiguration customFilterListConfiguration
A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.
CustomFilterConfiguration customFilterConfiguration
A custom filter that filters based on a single value. This filter can be partially matched.
String visibility
The visibility of an axis label on a chart. Choose one of the following options:
VISIBLE
: Shows the axis.
HIDDEN
: Hides the axis.
String sortIconVisibility
The visibility configuration of the sort icon on a chart's axis label.
List<E> axisLabelOptions
The label options for a chart axis.
SimpleClusterMarker simpleClusterMarker
The simple cluster marker of the cluster marker.
ClusterMarker clusterMarker
The cluster marker that is a part of the cluster marker configuration
ColumnIdentifier column
The column.
FormatConfiguration formatConfiguration
The format configuration of a column.
String role
The role of the column.
String text
The text of a description for a column.
GeoSpatialColumnGroup geoSpatialColumnGroup
Geospatial column group that denotes a hierarchy.
String name
The name of the column group's column schema.
ExplicitHierarchy explicitHierarchy
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.
DateTimeHierarchy dateTimeHierarchy
The option that determines the hierarchy of any DateTime
fields.
PredefinedHierarchy predefinedHierarchy
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.
ColumnIdentifier sortBy
String direction
The sort direction.
AggregationFunction aggregationFunction
The aggregation function that is defined in the column sort.
String columnGeographicRole
A geospatial role for a column.
ColumnDescription columnDescription
A description for a column.
ColumnIdentifier column
The target column of the tooltip item.
String label
The label of the tooltip item.
String visibility
The visibility of the tooltip item.
AggregationFunction aggregation
The aggregation function of the column tooltip item.
List<E> category
The aggregated category field wells of a combo chart.
List<E> barValues
The aggregated BarValues
field well of a combo chart.
List<E> colors
The aggregated colors field well of a combo chart.
List<E> lineValues
The aggregated LineValues
field well of a combo chart.
ComboChartFieldWells fieldWells
The field wells of the visual.
ComboChartSortConfiguration sortConfiguration
The sort configuration of a ComboChartVisual
.
String barsArrangement
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.
AxisDisplayOptions categoryAxis
The category axis of a combo chart.
ChartAxisLabelOptions categoryLabelOptions
The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
AxisDisplayOptions primaryYAxisDisplayOptions
The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
ChartAxisLabelOptions primaryYAxisLabelOptions
The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
AxisDisplayOptions secondaryYAxisDisplayOptions
The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
ChartAxisLabelOptions secondaryYAxisLabelOptions
The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
ChartAxisLabelOptions colorLabelOptions
The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
LegendOptions legend
The legend display setup of the visual.
DataLabelOptions barDataLabels
The options that determine if visual data labels are displayed.
The data label options for a bar in a combo chart.
DataLabelOptions lineDataLabels
The options that determine if visual data labels are displayed.
The data label options for a line in a combo chart.
TooltipOptions tooltip
The legend display setup of the visual.
List<E> referenceLines
The reference line setup of the visual.
VisualPalette visualPalette
The palette (chart color) display setup of the visual.
ComboChartAggregatedFieldWells comboChartAggregatedFieldWells
The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.
List<E> categorySort
The sort configuration of the category field well in a combo chart.
ItemsLimitConfiguration categoryItemsLimit
The item limit configuration for the category field well of a combo chart.
List<E> colorSort
The sort configuration of the color field well in a combo chart.
ItemsLimitConfiguration colorItemsLimit
The item limit configuration of the color field well in a combo chart.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
ComboChartConfiguration chartConfiguration
The configuration settings of the visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
String comparisonMethod
The method of the comparison. Choose from the following options:
DIFFERENCE
PERCENT_DIFFERENCE
PERCENT
ComparisonFormatConfiguration comparisonFormat
The format of the comparison.
NumberDisplayFormatConfiguration numberDisplayFormatConfiguration
The number display format.
PercentageDisplayFormatConfiguration percentageDisplayFormatConfiguration
The percentage display format.
TopBottomRankedComputation topBottomRanked
The top ranked and bottom ranked computation configuration.
TopBottomMoversComputation topBottomMovers
The top movers and bottom movers computation configuration.
TotalAggregationComputation totalAggregation
The total aggregation computation configuration.
MaximumMinimumComputation maximumMinimum
The maximum and minimum computation configuration.
MetricComparisonComputation metricComparison
The metric comparison computation configuration.
PeriodOverPeriodComputation periodOverPeriod
The period over period computation configuration.
PeriodToDateComputation periodToDate
The period to DataSetIdentifier
computation configuration.
GrowthRateComputation growthRate
The growth rate computation configuration.
UniqueValuesComputation uniqueValues
The unique values computation configuration.
ForecastComputation forecast
The forecast computation configuration.
String requestId
ConditionalFormattingSolidColor solid
Formatting configuration for solid color.
ConditionalFormattingGradientColor gradient
Formatting configuration for gradient color.
String expression
The expression that determines the condition of the icon set.
ConditionalFormattingCustomIconOptions iconOptions
Custom icon options for an icon set.
String color
Determines the color of the icon.
ConditionalFormattingIconDisplayConfiguration displayConfiguration
Determines the icon display configuration.
String expression
The expression that determines the formatting configuration for gradient color.
GradientColor color
Determines the color.
ConditionalFormattingIconSet iconSet
Formatting configuration for icon set.
ConditionalFormattingCustomIconCondition customCondition
Determines the custom condition for an icon set.
String iconDisplayOption
Determines the icon display configuration.
String requestId
The Amazon Web Services request ID for this request.
String awsAccountId
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
String namespace
The Amazon QuickSight namespace that you want to add customizations to.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization
to the midnight theme:
"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }
. Or, you can
add a custom theme by specifying
"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }
.
List<E> tags
A list of the tags that you want to attach to this resource.
String arn
The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.
String awsAccountId
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
String namespace
The namespace associated with the customization you're creating.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String edition
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from
ENTERPRISE
or ENTERPRISE_AND_Q
.
If you choose ENTERPRISE_AND_Q
, the following parameters are required:
FirstName
LastName
EmailAddress
ContactNumber
String authenticationMethod
The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for
this parameter are IAM_AND_QUICKSIGHT
, IAM_ONLY
, and ACTIVE_DIRECTORY
.
If you choose ACTIVE_DIRECTORY
, provide an ActiveDirectoryName
and an
AdminGroup
associated with your Active Directory.
String awsAccountId
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
String accountName
The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears
only when users sign in. You can't change AccountName
value after the Amazon QuickSight account is
created.
String notificationEmail
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
String activeDirectoryName
The name of your Active Directory. This field is required if ACTIVE_DIRECTORY
is the selected
authentication method of the new Amazon QuickSight account.
String realm
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required
if ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account.
String directoryId
The ID of the Active Directory that is associated with your Amazon QuickSight account.
List<E> adminGroup
The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY
is
the selected authentication method of the new Amazon QuickSight account. For more information about using Active
Directory in Amazon QuickSight, see Using Active Directory with
Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
List<E> authorGroup
The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
List<E> readerGroup
The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
String firstName
The first name of the author of the Amazon QuickSight account to use for future communications. This field is
required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
String lastName
The last name of the author of the Amazon QuickSight account to use for future communications. This field is
required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
String emailAddress
The email address of the author of the Amazon QuickSight account to use for future communications. This field is
required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
String contactNumber
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This
field is required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
SignupResponse signupResponse
A SignupResponse
object that returns information about a newly created Amazon QuickSight account.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account where you are creating an analysis.
String analysisId
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
String name
A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.
Parameters parameters
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
List<E> permissions
A structure that describes the principals and the resource-level permissions on an analysis. You can use the
Permissions
structure to grant permissions by providing a list of Identity and Access Management
(IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions
.
AnalysisSourceEntity sourceEntity
A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
String themeArn
The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
AnalysisDefinition definition
The definition of an analysis.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
String arn
The ARN for the analysis.
String analysisId
The ID of the analysis.
String creationStatus
The status of the creation of the analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account where you want to create the dashboard.
String dashboardId
The ID for the dashboard, also added to the IAM policy.
String name
The display name of the dashboard.
Parameters parameters
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
List<E> permissions
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
DashboardSourceEntity sourceEntity
The entity that you are using as a source when you create the dashboard. In SourceEntity
, you
specify the type of object you're using as source. You can only create a dashboard from a template, so you use a
SourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the
analysis to a template by using the
CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template.
The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon
QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets
for the placeholders listed in the original. The schema in each dataset must match its placeholder.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
String versionDescription
A description for the first version of the dashboard being created.
DashboardPublishOptions dashboardPublishOptions
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either
ENABLED
or DISABLED
. When this is set to DISABLED
, Amazon QuickSight
disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This
option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either
ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when
this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either
COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
String themeArn
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
DashboardVersionDefinition definition
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
String arn
The ARN of the dashboard.
String versionArn
The ARN of the dashboard, including the version number of the first version that is created.
String dashboardId
The ID for the dashboard.
String creationStatus
The status of the dashboard creation request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
String dataSetId
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
The display name for the dataset.
Map<K,V> physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Map<K,V> logicalTableMap
Configures the combination and transformation of the data from the physical tables.
String importMode
Indicates whether you want to import the data into SPICE.
List<E> columnGroups
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Map<K,V> fieldFolders
The folder that contains fields and nested subfolders for your dataset.
List<E> permissions
A list of resource permissions on the dataset.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the data that you want to create.
RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
List<E> columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
DataSetUsageConfiguration dataSetUsageConfiguration
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String ingestionArn
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String ingestionId
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSourceId
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
A display name for the data source.
String type
The type of the data source. To return a list of all data sources, use ListDataSources
.
Use AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service.
DataSourceParameters dataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
DataSourceCredentials credentials
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
List<E> permissions
A list of resource permissions on the data source.
VpcConnectionProperties vpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
String arn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String creationStatus
The status of creating the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
String folderId
The ID of the folder.
String memberId
The ID of the asset (the dashboard, analysis, or dataset).
String memberType
The type of the member, including DASHBOARD
, ANALYSIS
, and DATASET
.
Integer status
The HTTP status of the request.
FolderMember folderMember
Information about the member in the folder.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account where you want to create the folder.
String folderId
The ID of the folder.
String name
The name of the folder.
String folderType
The type of folder. By default, folderType
is SHARED
.
String parentFolderArn
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn
can be null. An empty parentFolderArn
creates a root-level folder.
List<E> permissions
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions
.
List<E> tags
Tags for the folder.
String memberName
The name of the user that you want to add to the group membership.
String groupName
The name of the group that you want to add the user to.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace that you want the user to be a part of.
GroupMember groupMember
The group member.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String groupName
A name for the group that you want to create.
String description
A description for the group that you want to create.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace that you want the group to be a part of.
String awsAccountId
The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
String assignmentName
The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.
String assignmentStatus
The status of the assignment. Possible values are as follows:
ENABLED
- Anything specified in this assignment is used when creating the data source.
DISABLED
- This assignment isn't used when creating the data source.
DRAFT
- This assignment is an unfinished draft and isn't used when creating the data source.
String policyArn
The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon QuickSight users, groups, or both that you want to assign the policy to.
String namespace
The namespace that contains the assignment.
String assignmentName
The name of the assignment. This name must be unique within the Amazon Web Services account.
String assignmentId
The ID for the assignment.
String assignmentStatus
The status of the assignment. Possible values are as follows:
ENABLED
- Anything specified in this assignment is used when creating the data source.
DISABLED
- This assignment isn't used when creating the data source.
DRAFT
- This assignment is an unfinished draft and isn't used when creating the data source.
String policyArn
The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) for the data ingestion.
String ingestionId
An ID for the ingestion.
String ingestionStatus
The ingestion status.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
String namespace
The name that you want to use to describe the new namespace.
String identityStore
Specifies the type of your user identity directory. Currently, this supports users with an identity type of
QUICKSIGHT
.
List<E> tags
The tags that you want to associate with the namespace that you're creating.
String arn
The ARN of the Amazon QuickSight namespace you created.
String name
The name of the new namespace that you created.
String capacityRegion
The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
String creationStatus
The status of the creation of the namespace. This is an asynchronous process. A status of CREATED
means that your namespace is ready to use. If an error occurs, it indicates if the process is
retryable
or non-retryable
. In the case of a non-retryable error, refer to the error
message for follow-up tasks.
String identityStore
Specifies the type of your user identity directory. Currently, this supports users with an identity type of
QUICKSIGHT
.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the template that you creating an alias for.
String templateId
An ID for the template.
String aliasName
The name that you want to give to the template alias that you're creating. Don't start the alias name with the
$
character. Alias names that start with $
are reserved by Amazon QuickSight.
Long templateVersionNumber
The version number of the template.
TemplateAlias templateAlias
Information about the template alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String templateId
An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.
String name
A display name for the template.
List<E> permissions
A list of resource permissions to be set on the template.
TemplateSourceEntity sourceEntity
The entity that you are using as a source when you create the template. In SourceEntity
, you specify
the type of object you're using as source: SourceTemplate
for a template or
SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For
SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the
ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and
any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must
match its placeholder.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
String versionDescription
A description of the current template version being created. This API operation creates the first version of the
template. Every time UpdateTemplate
is called, a new version is created. Each version of the
template maintains a description of the version in the VersionDescription
field.
TemplateVersionDefinition definition
The definition of a template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
String arn
The ARN for the template.
String versionArn
The ARN for the template, including the version information of the first version.
String templateId
The ID of the template.
String creationStatus
The template creation status.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme for the new theme alias.
String themeId
An ID for the theme alias.
String aliasName
The name that you want to give to the theme alias that you are creating. The alias name can't begin with a
$
. Alias names that start with $
are reserved by Amazon QuickSight.
Long themeVersionNumber
The version number of the theme.
ThemeAlias themeAlias
Information about the theme alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account where you want to store the new theme.
String themeId
An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
String name
A display name for the theme.
String baseThemeId
The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes
defined by Amazon QuickSight. For a list of the starting themes, use ListThemes
or choose
Themes from within an analysis.
String versionDescription
A description of the first version of the theme that you're creating. Every time UpdateTheme
is
called, a new version is created. Each version of the theme has a description of the version in the
VersionDescription
field.
ThemeConfiguration configuration
The theme configuration, which contains the theme display properties.
List<E> permissions
A valid grouping of resource permissions to apply to the new theme.
List<E> tags
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
String arn
The Amazon Resource Name (ARN) for the theme.
String versionArn
The Amazon Resource Name (ARN) for the new theme.
String themeId
The ID of the theme.
String creationStatus
The theme creation status.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String username
User name.
String password
Password.
List<E> alternateDataSourceParameters
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.
String prefix
Determines the prefix value of the currency format.
String suffix
Determines the suffix value of the currency format.
NumericSeparatorConfiguration separatorConfiguration
The options that determine the numeric separator configuration.
String symbol
Determines the symbol for the currency format.
DecimalPlacesConfiguration decimalPlacesConfiguration
The option that determines the decimal places configuration.
String numberScale
Determines the number scale value for the currency format.
NegativeValueConfiguration negativeValueConfiguration
The options that determine the negative value configuration.
NullValueFormatConfiguration nullValueFormatConfiguration
The options that determine the null value format configuration.
FilterOperationSelectedFieldsConfiguration selectedFieldsConfiguration
The configuration that chooses the fields to be filtered.
FilterOperationTargetVisualsConfiguration targetVisualsConfiguration
The configuration that chooses the target visuals to be filtered.
LocalNavigationConfiguration localNavigationConfiguration
The configuration that chooses the navigation target.
String uRLTemplate
THe URL link of the CustomActionURLOperation
.
String uRLTarget
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.
String contentUrl
The input URL that links to the custom content that you want in the custom visual.
String contentType
The content type of the custom content visual. You can use this to have the visual render as an image.
String imageScaling
The sizing options for the size of the custom content visual. This structure is required when the
ContentType
of the visual is 'IMAGE'
.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
CustomContentConfiguration chartConfiguration
The configuration of a CustomContentVisual
.
List<E> actions
The list of custom actions that are configured for a visual.
String dataSetIdentifier
The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
String matchOperator
The match operator that is used to determine if a filter should be applied.
String categoryValue
The category value for the filter.
This field is mutually exclusive to ParameterName
.
String selectAllOptions
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
String parameterName
The parameter whose value should be used for the filter value.
This field is mutually exclusive to CategoryValue
.
String nullOption
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.
String matchOperator
The match operator that is used to determine if a filter should be applied.
List<E> categoryValues
The list of category values for the filter.
String selectAllOptions
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
String nullOption
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.
String narrative
The string input of custom narrative.
List<E> stringValues
A list of string-type parameter values.
List<E> integerValues
A list of integer-type parameter values.
List<E> decimalValues
A list of decimal-type parameter values.
List<E> dateTimeValues
A list of datetime-type parameter values.
Boolean includeNullValue
Includes the null value in custom action parameter values.
CustomParameterValues customValues
String dashboardId
Dashboard ID.
String arn
The Amazon Resource Name (ARN) of the resource.
String name
A display name for the dashboard.
DashboardVersion version
Version.
Date createdTime
The time that this dashboard was created.
Date lastPublishedTime
The last time that this dashboard was published.
Date lastUpdatedTime
The last time that this dashboard was updated.
AdHocFilteringOption adHocFilteringOption
Ad hoc (one-time) filtering option.
ExportToCSVOption exportToCSVOption
Export to .csv option.
SheetControlsOption sheetControlsOption
Sheet controls option.
DashboardVisualPublishOptions visualPublishOptions
String operator
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
.
String name
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.
String value
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"
.
DashboardSourceTemplate sourceTemplate
Source template.
String arn
The Amazon Resource Name (ARN) of the resource.
String dashboardId
Dashboard ID.
String name
A display name for the dashboard.
Date createdTime
The time that this dashboard was created.
Date lastUpdatedTime
The last time that this dashboard was updated.
Long publishedVersionNumber
Published version number.
Date lastPublishedTime
The last time that this dashboard was published.
Date createdTime
The time that this dashboard version was created.
List<E> errors
Errors associated with this dashboard version.
Long versionNumber
Version number for this version of the dashboard.
String status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the resource.
String sourceEntityArn
Source entity ARN.
List<E> dataSetArns
The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
String description
Description.
String themeArn
The ARN of the theme associated with a version of the dashboard.
List<E> sheets
A list of the associated sheets with the unique identifier and name of each sheet.
List<E> dataSetIdentifierDeclarations
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.
List<E> sheets
An array of sheet definitions for a dashboard.
List<E> calculatedFields
An array of calculated field definitions for the dashboard.
List<E> parameterDeclarations
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 in the Amazon QuickSight User Guide.
List<E> filterGroups
The filter definitions for a dashboard.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
List<E> columnConfigurations
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.
AnalysisDefaults analysisDefaults
String arn
The Amazon Resource Name (ARN) of the resource.
Date createdTime
The time that this dashboard version was created.
Long versionNumber
Version number.
String status
The HTTP status of the request.
String sourceEntityArn
Source entity ARN.
String description
Description.
String dashboardId
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.
String sheetId
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.
String visualId
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.
ExportHiddenFieldsOption exportHiddenFieldsOption
List<E> colors
The hexadecimal codes for the colors.
List<E> minMaxGradient
The minimum and maximum hexadecimal codes that describe a color gradient.
String emptyFillColor
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
String fieldId
The field ID of the field that you are setting the axis binding to.
String fieldValue
The field value of the field that you are setting the axis binding to.
String axisBinding
The axis that you are binding the field to.
LineChartSeriesSettings settings
The options that determine the presentation of line series associated to the field.
String visibility
Determines the visibility of the data labels.
String categoryLabelVisibility
Determines the visibility of the category field labels.
String measureLabelVisibility
Determines the visibility of the measure field labels.
List<E> dataLabelTypes
The option that determines the data label type.
String position
Determines the position of the data labels.
String labelContent
Determines the content of the data labels.
FontConfiguration labelFontConfiguration
Determines the font configuration of the data labels.
String labelColor
Determines the color of the data labels.
String overlap
Determines whether overlap is enabled or disabled for the data labels.
FieldLabelType fieldLabelType
Determines the label configuration for the entire field.
DataPathLabelType dataPathLabelType
The option that specifies individual data values for labels.
RangeEndsLabelType rangeEndsLabelType
Determines the label configuration for range end value in a visual.
MinimumLabelType minimumLabelType
Determines the label configuration for the minimum value in a visual.
MaximumLabelType maximumLabelType
Determines the label configuration for the maximum value in a visual.
DataPathValue element
The element that the color needs to be applied to.
String color
The color that needs to be applied to the element.
String timeGranularity
The time granularity of the field that the color needs to be applied to.
String arn
The Amazon Resource Name (ARN) of the resource.
String dataSetId
The ID of the dataset.
String name
A display name for the dataset.
Date createdTime
The time that this dataset was created.
Date lastUpdatedTime
The last time that this dataset was updated.
Map<K,V> physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Map<K,V> logicalTableMap
Configures the combination and transformation of the data from the physical tables.
List<E> outputColumns
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
String importMode
A value that indicates whether you want to import the data into SPICE.
Long consumedSpiceCapacityInBytes
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
List<E> columnGroups
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Map<K,V> fieldFolders
The folder that contains fields and nested subfolders for your dataset.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the dataset.
RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.
List<E> columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.
DataSetUsageConfiguration dataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
String placeholder
Placeholder.
DataSetSchema dataSetSchema
Dataset schema.
List<E> columnGroupSchemaList
A structure containing the list of column group schemas.
String operator
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
.
String name
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.
String value
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"
.
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID of the dataset.
String name
A display name for the dataset.
Date createdTime
The time that this dataset was created.
Date lastUpdatedTime
The last time that this dataset was updated.
String importMode
A value that indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the dataset.
Boolean rowLevelPermissionTagConfigurationApplied
Whether or not the row level permission tags are applied.
Boolean columnLevelPermissionRulesApplied
A value that indicates if the dataset has column level permission configured.
Boolean disableUseAsDirectQuerySource
An option that controls whether a child dataset of a direct query can use this dataset as a source.
Boolean disableUseAsImportedSource
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
String arn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
A display name for the data source.
String type
The type of the data source. This type indicates which database engine the data source connects to.
String status
The HTTP status of the request.
Date createdTime
The time that this data source was created.
Date lastUpdatedTime
The last time that this data source was updated.
DataSourceParameters dataSourceParameters
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.
List<E> alternateDataSourceParameters
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.
VpcConnectionProperties vpcConnectionProperties
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.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DataSourceErrorInfo errorInfo
Error information from the last update or the creation of the data source.
String secretArn
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
CredentialPair credentialPair
Credential pair. For more information, see
CredentialPair
.
String copySourceArn
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.
String secretArn
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
AmazonElasticsearchParameters amazonElasticsearchParameters
The parameters for OpenSearch.
AthenaParameters athenaParameters
The parameters for Amazon Athena.
AuroraParameters auroraParameters
The parameters for Amazon Aurora MySQL.
AuroraPostgreSqlParameters auroraPostgreSqlParameters
The parameters for Amazon Aurora.
AwsIotAnalyticsParameters awsIotAnalyticsParameters
The parameters for IoT Analytics.
JiraParameters jiraParameters
The parameters for Jira.
MariaDbParameters mariaDbParameters
The parameters for MariaDB.
MySqlParameters mySqlParameters
The parameters for MySQL.
OracleParameters oracleParameters
The parameters for Oracle.
PostgreSqlParameters postgreSqlParameters
The parameters for PostgreSQL.
PrestoParameters prestoParameters
The parameters for Presto.
RdsParameters rdsParameters
The parameters for Amazon RDS.
RedshiftParameters redshiftParameters
The parameters for Amazon Redshift.
S3Parameters s3Parameters
The parameters for S3.
ServiceNowParameters serviceNowParameters
The parameters for ServiceNow.
SnowflakeParameters snowflakeParameters
The parameters for Snowflake.
SparkParameters sparkParameters
The parameters for Spark.
SqlServerParameters sqlServerParameters
The parameters for SQL Server.
TeradataParameters teradataParameters
The parameters for Teradata.
TwitterParameters twitterParameters
The parameters for Twitter.
AmazonOpenSearchParameters amazonOpenSearchParameters
The parameters for OpenSearch.
ExasolParameters exasolParameters
The parameters for Exasol.
DatabricksParameters databricksParameters
The required parameters that are needed to connect to a Databricks data source.
String operator
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
.
String name
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.
String value
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"
.
String arn
The arn of the datasource.
String dataSourceId
The unique ID of the data source.
String name
The name of the data source.
String type
The type of the data source.
Date createdTime
The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
Date lastUpdatedTime
The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
String missingDateVisibility
Determines whether or not missing dates are displayed.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the DateDimensionField
.
String dateGranularity
The date granularity of the DateDimensionField
. Choose one of the following options:
YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
String hierarchyId
The custom hierarchy ID.
DateTimeFormatConfiguration formatConfiguration
The format configuration of the field.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the DateMeasureField
.
String aggregationFunction
The aggregation function of the measure field.
DateTimeFormatConfiguration formatConfiguration
The format configuration of the field.
DynamicDefaultValue dynamicValue
The dynamic value of the DataTimeDefaultValues
. Different defaults are displayed according to users,
groups, and values mapping.
List<E> staticValues
The static values of the DataTimeDefaultValues
.
RollingDateConfiguration rollingDate
The rolling date of the DataTimeDefaultValues
. The date is determined from the dataset based on
input expression.
String dateTimeFormat
Determines the DateTime
format.
NullValueFormatConfiguration nullValueFormatConfiguration
The options that determine the null value format configuration.
NumericFormatConfiguration numericFormatConfiguration
The formatting configuration for numeric DateTime
fields.
String name
The name of the parameter that is being declared.
DateTimeDefaultValues defaultValues
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
String timeGranularity
The level of time precision that is used to aggregate DateTime
values.
DateTimeValueWhenUnsetConfiguration valueWhenUnset
The configuration that defines the default value of a DateTime
parameter when a value has not been
set.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
String dateTimeFormat
Customize how dates are formatted in controls.
DynamicDefaultValue dynamicValue
The dynamic value of the DecimalDefaultValues
. Different defaults are displayed according to users,
groups, and values mapping.
List<E> staticValues
The static values of the DecimalDefaultValues
.
String parameterValueType
The value type determines whether the parameter is a single-value or multi-value parameter.
String name
The name of the parameter that is being declared.
DecimalDefaultValues defaultValues
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
DecimalValueWhenUnsetConfiguration valueWhenUnset
The configuration that defines the default value of a Decimal
parameter when a value has not been
set.
Long decimalPlaces
The values of the decimal places.
FreeFormLayoutCanvasSizeOptions canvasSizeOptions
Determines the screen canvas size options for a free-form layout.
GridLayoutCanvasSizeOptions canvasSizeOptions
Determines the screen canvas size options for a grid layout.
DefaultGridLayoutConfiguration grid
The options that determine the default settings for a grid layout configuration.
DefaultFreeFormLayoutConfiguration freeForm
The options that determine the default settings of a free-form layout configuration.
DefaultInteractiveLayoutConfiguration interactiveLayoutConfiguration
The options that determine the default settings for interactive layout configuration.
DefaultPaginatedLayoutConfiguration paginatedLayoutConfiguration
The options that determine the default settings for a paginated layout configuration.
String sheetContentType
The option that determines the sheet content type.
DefaultSectionBasedLayoutConfiguration sectionBased
The options that determine the default settings for a section-based layout configuration.
SectionBasedLayoutCanvasSizeOptions canvasSizeOptions
Determines the screen canvas size options for a section-based layout.
String awsAccountId
The Amazon Web Services account ID of the account that you want to delete.
String awsAccountId
The ID of the Amazon Web Services account where you want to delete an analysis.
String analysisId
The ID of the analysis that you're deleting.
Long recoveryWindowInDays
A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't
use this parameter with the ForceDeleteWithoutRecovery
option in the same API call. The default
value is 30.
Boolean forceDeleteWithoutRecovery
This option defaults to the value NoForceDeleteWithoutRecovery
. To immediately delete the analysis,
add the ForceDeleteWithoutRecovery
option. You can't restore an analysis after it's deleted.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the deleted analysis.
String analysisId
The ID of the deleted analysis.
Date deletionTime
The date and time that the analysis is scheduled to be deleted.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
String dashboardId
The ID for the dashboard.
Long versionNumber
The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the data source that you deleted.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
String folderId
The Folder ID.
String memberId
The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
String memberType
The type of the member, including DASHBOARD
, ANALYSIS
, and DATASET
String memberName
The name of the user that you want to delete from the group membership.
String groupName
The name of the group that you want to delete the user from.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want to remove a user from.
String groupName
The name of the group that you want to delete.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want to delete.
String awsAccountId
The ID of the Amazon Web Services account that contains the item to delete.
String templateId
The ID for the template that the specified alias is for.
String aliasName
The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You
can specify the alias name, or specify the latest version of the template by providing the keyword
$LATEST
in the AliasName
parameter.
Integer status
The HTTP status of the request.
String templateId
An ID for the template associated with the deletion.
String aliasName
The name for the template alias.
String arn
The Amazon Resource Name (ARN) of the template you want to delete.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the template that you're deleting.
String templateId
An ID for the template you want to delete.
Long versionNumber
Specifies the version of the template that you want to delete. If you don't provide a version number,
DeleteTemplate
deletes all versions of the template.
String aliasName
The name for the theme alias.
String arn
The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String themeId
An ID for the theme associated with the deletion.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme that you're deleting.
String themeId
An ID for the theme that you want to delete.
Long versionNumber
The version of the theme that you want to delete.
Note: If you don't provide a version number, you're using this call to DeleteTheme
to delete
all versions of the theme.
String principalId
The principal ID of the user.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String userName
The name of the user that you want to delete.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.
String namespace
The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.
Boolean resolved
The Resolved
flag works with the other parameters to determine which view of Amazon QuickSight
customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight
uses to identify which customizations to apply to the console. Omit this flag, or set it to
no-resolved
, to reveal customizations that are configured at different levels.
String arn
The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.
String awsAccountId
The ID for the Amazon Web Services account that you're describing.
String namespace
The Amazon QuickSight namespace that you're describing.
AccountCustomization accountCustomization
The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the settings that you want to list.
AccountSettings accountSettings
The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.
In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID associated with your Amazon QuickSight account.
AccountInfo accountInfo
A structure that contains the following 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.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String analysisId
The ID of the analysis described.
String name
The descriptive name of the analysis.
List<E> errors
Errors associated with the analysis.
String resourceStatus
Status associated with the analysis.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
String themeArn
The ARN of the theme of the analysis.
AnalysisDefinition definition
The definition of an analysis.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
String analysisId
The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
String analysisId
The ID of the analysis whose permissions you're describing.
String analysisArn
The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
List<E> permissions
A structure that describes the principals and the resource-level permissions on an analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
String dashboardId
The ID for the dashboard.
Long versionNumber
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
String aliasName
The alias name.
String dashboardId
The ID of the dashboard described.
List<E> errors
Errors associated with this dashboard version.
String name
The display name of the dashboard.
String resourceStatus
Status associated with the dashboard version.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
String themeArn
The ARN of the theme of the dashboard.
DashboardVersionDefinition definition
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String dashboardId
The ID for the dashboard.
String dashboardArn
The Amazon Resource Name (ARN) of the dashboard.
List<E> permissions
A structure that contains the permissions for the dashboard.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
LinkSharingConfiguration linkSharingConfiguration
A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
String dashboardId
The ID for the dashboard.
Long versionNumber
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
String aliasName
The alias name.
String dataSetArn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
List<E> permissions
A list of resource permissions on the dataset.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String dataSourceArn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
List<E> permissions
A list of resource permissions on the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
DataSource dataSource
The information on the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
Integer status
The HTTP status of the request.
String folderId
The ID of the folder.
String arn
The Amazon Resource Name (ARN) for the folder.
List<E> permissions
Information about the permissions on the folder.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String folderId
The ID of the folder.
String arn
The Amazon Resource Name (ARN) of the folder.
List<E> permissions
Information about the permissions for the folder.
String requestId
The Amazon Web Services request ID for this operation.
String memberName
The user name of the user that you want to search for.
String groupName
The name of the group that you want to search.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace that includes the group you are searching within.
GroupMember groupMember
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String groupName
The name of the group that you want to describe.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want described.
IAMPolicyAssignment iAMPolicyAssignment
Information describing the IAM policy assignment.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the IP rules.
String awsAccountId
The ID of the Amazon Web Services account that contains the IP rules.
Map<K,V> ipRestrictionRuleMap
A map that describes the IP rules with CIDR range and description.
Boolean enabled
A value that specifies whether IP rules are turned on.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
NamespaceInfoV2 namespace
The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon
Web Services Region, creation status, and identity store. DescribeNamespace
also works for
namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the
namespace error types and messages associated with the creation process.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the template alias that you're describing.
String templateId
The ID for the template.
String aliasName
The name of the template alias that you want to describe. If you name a specific alias, you describe the version
that the alias points to. You can specify the latest version of the template by providing the keyword
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply
to templates.
TemplateAlias templateAlias
Information about the template alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
String templateId
The ID of the template that you're describing.
Long versionNumber
The version number of the template.
String aliasName
The alias of the template that you want to describe. If you name a specific alias, you describe the version that
the alias points to. You can specify the latest version of the template by providing the keyword
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply
to templates.
String name
The descriptive name of the template.
String templateId
The ID of the template described.
List<E> errors
Errors associated with the template version.
String resourceStatus
Status associated with the template.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
String themeArn
The ARN of the theme of the template.
TemplateVersionDefinition definition
The definition of the template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String templateId
The ID for the template.
String templateArn
The Amazon Resource Name (ARN) of the template.
List<E> permissions
A list of resource permissions to be set on the template.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the template that you're describing.
String templateId
The ID for the template.
Long versionNumber
(Optional) The number for the version to describe. If a VersionNumber
parameter value isn't
provided, the latest version of the template is described.
String aliasName
The alias of the template that you want to describe. If you name a specific alias, you describe the version that
the alias points to. You can specify the latest version of the template by providing the keyword
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply
to templates.
ThemeAlias themeAlias
Information about the theme alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String themeId
The ID for the theme.
String themeArn
The Amazon Resource Name (ARN) of the theme.
List<E> permissions
A list of resource permissions set on the theme.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme that you're describing.
String themeId
The ID for the theme.
Long versionNumber
The version number for the version to describe. If a VersionNumber
parameter value isn't provided,
the latest version of the theme is described.
String aliasName
The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the
alias points to. You can specify the latest version of the theme by providing the keyword $LATEST
in
the AliasName
parameter. The keyword $PUBLISHED
doesn't apply to themes.
String userName
The name of the user that you want to describe.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
CustomValuesConfiguration customValuesConfiguration
The configuration of custom values for destination parameter in
DestinationParameterValueConfiguration
.
String selectAllValueOptions
The configuration that selects all options.
String sourceParameterName
The source parameter name of the destination parameter.
String sourceField
The source field ID of the destination parameter.
NumericalDimensionField numericalDimensionField
The dimension type field with numerical type columns.
CategoricalDimensionField categoricalDimensionField
The dimension type field with categorical type columns.
DateDimensionField dateDimensionField
The dimension type field with date type columns.
String requestId
The Amazon Web Services request ID for this request.
String labelVisibility
Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called
'Show total'
.
ArcOptions arcOptions
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
DonutCenterOptions donutCenterOptions
The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.
NumericEqualityDrillDownFilter numericEqualityFilter
The numeric equality type drill down filter. This filter is used for number type columns.
CategoryDrillDownFilter categoryFilter
The category type drill down filter. This filter is used for string type columns.
TimeRangeDrillDownFilter timeRangeFilter
The time range drill down filter. This filter is used for date time columns.
ListControlSelectAllOptions selectAllOptions
The configuration of the Select all
options in a dropdown control.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
ColumnIdentifier userNameColumn
The column that contains the username.
ColumnIdentifier groupNameColumn
The column that contains the group name.
ColumnIdentifier defaultValueColumn
The column that contains the default value of each user or group.
String visualId
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.
String dataSetIdentifier
The data set that is used in the empty visual. Every visual requires a dataset to render.
List<E> actions
The list of custom actions that are configured for a visual.
String path
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
String availabilityStatus
String availabilityStatus
Availability status.
String aggregationVisibility
The visibility of Show aggregations
.
String tooltipTitleType
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.
List<E> tooltipFields
The fields configuration in the tooltip.
String fieldId
The field ID of the field for which you are setting the axis binding.
String axisBinding
The axis that you are binding the field to.
LineChartSeriesSettings settings
The options that determine the presentation of line series associated to the field.
FieldSort fieldSort
The sort configuration for a field in a field well.
ColumnSort columnSort
The sort configuration for a column that is not used in a field well.
FilledMapShapeConditionalFormatting shape
The conditional formatting that determines the shape of the filled map.
FilledMapFieldWells fieldWells
The field wells of the visual.
FilledMapSortConfiguration sortConfiguration
The sort configuration of a FilledMapVisual
.
LegendOptions legend
The legend display setup of the visual.
TooltipOptions tooltip
The tooltip display setup of the visual.
GeospatialWindowOptions windowOptions
The window options of the filled map visual.
GeospatialMapStyleOptions mapStyleOptions
The map style options of the filled map visual.
FilledMapAggregatedFieldWells filledMapAggregatedFieldWells
The aggregated field well of the filled map.
String fieldId
The field ID of the filled map shape.
ShapeConditionalFormat format
The conditional formatting that determines the background color of a filled map's shape.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
FilledMapConfiguration chartConfiguration
The configuration settings of the visual.
FilledMapConditionalFormatting conditionalFormatting
The conditional formatting of a FilledMapVisual
.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
List<E> actions
The list of custom actions that are configured for a visual.
CategoryFilter categoryFilter
A CategoryFilter
filters text values.
For more information, see Adding text filters in the Amazon QuickSight User Guide.
NumericRangeFilter numericRangeFilter
A NumericRangeFilter
filters numeric values that are either inside or outside a given numeric range.
NumericEqualityFilter numericEqualityFilter
A NumericEqualityFilter
filters numeric values that equal or do not equal a given numeric value.
TimeEqualityFilter timeEqualityFilter
A TimeEqualityFilter
filters date-time values that equal or do not equal a given date/time value.
TimeRangeFilter timeRangeFilter
A TimeRangeFilter
filters date-time values that are either inside or outside a given date/time
range.
RelativeDatesFilter relativeDatesFilter
A RelativeDatesFilter
filters date values that are relative to a given date.
TopBottomFilter topBottomFilter
A TopBottomFilter
filters data to the top or bottom values for a given column.
FilterDateTimePickerControl dateTimePicker
A control from a date filter that is used to specify date and time.
FilterListControl list
A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.
FilterDropDownControl dropdown
A control to display a dropdown list with buttons that are used to select a single value.
FilterTextFieldControl textField
A control to display a text box that is used to enter a single entry.
FilterTextAreaControl textArea
A control to display a text box that is used to enter multiple entries.
FilterSliderControl slider
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
FilterRelativeDateTimeControl relativeDateTime
A control from a date filter that is used to specify the relative date.
String filterControlId
The ID of the FilterDateTimePickerControl
.
String title
The title of the FilterDateTimePickerControl
.
String sourceFilterId
The source filter ID of the FilterDateTimePickerControl
.
DateTimePickerControlDisplayOptions displayOptions
The display options of a control.
String type
The date time picker type of a FilterDateTimePickerControl
. 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.
String filterControlId
The ID of the FilterDropDownControl
.
String title
The title of the FilterDropDownControl
.
String sourceFilterId
The source filter ID of the FilterDropDownControl
.
DropDownControlDisplayOptions displayOptions
The display options of the FilterDropDownControl
.
String type
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.
FilterSelectableValues selectableValues
A list of selectable values that are used in a control.
CascadingControlConfiguration cascadingControlConfiguration
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.
String filterGroupId
The value that uniquely identifies a FilterGroup
within a dashboard, template, or analysis.
List<E> filters
The list of filters that are present in a FilterGroup
.
FilterScopeConfiguration scopeConfiguration
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.
String status
The status of the FilterGroup
.
String crossDataset
The filter new feature which can apply filter group to all data sets. Choose one of the following options:
ALL_DATASETS
SINGLE_DATASET
String matchOperator
The match operator that is used to determine if a filter should be applied.
List<E> categoryValues
The list of category values for the filter.
String selectAllOptions
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
String filterControlId
The ID of the FilterListControl
.
String title
The title of the FilterListControl
.
String sourceFilterId
The source filter ID of the FilterListControl
.
ListControlDisplayOptions displayOptions
The display options of a control.
String type
The type of 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.
FilterSelectableValues selectableValues
A list of selectable values that are used in a control.
CascadingControlConfiguration cascadingControlConfiguration
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.
String conditionExpression
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
List<E> selectedFields
Chooses the fields that are filtered in CustomActionFilterOperation
.
String selectedFieldOptions
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.
SameSheetTargetVisualConfiguration sameSheetTargetVisualConfiguration
The configuration of the same-sheet target visuals that you want to be filtered.
String filterControlId
The ID of the FilterTextAreaControl
.
String title
The title of the FilterTextAreaControl
.
String sourceFilterId
The source filter ID of the FilterTextAreaControl
.
RelativeDateTimeControlDisplayOptions displayOptions
The display options of a control.
SelectedSheetsFilterScopeConfiguration selectedSheets
The configuration for applying a filter to specific sheets.
String filterControlId
The ID of the FilterSliderControl
.
String title
The title of the FilterSliderControl
.
String sourceFilterId
The source filter ID of the FilterSliderControl
.
SliderControlDisplayOptions displayOptions
The display options of a control.
String type
The type of 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.
Double maximumValue
The smaller value that is displayed at the left of the slider.
Double minimumValue
The larger value that is displayed at the right of the slider.
Double stepSize
The number of increments that the slider bar is divided into.
String filterControlId
The ID of the FilterTextAreaControl
.
String title
The title of the FilterTextAreaControl
.
String sourceFilterId
The source filter ID of the FilterTextAreaControl
.
String delimiter
The delimiter that is used to separate the lines in text.
TextAreaControlDisplayOptions displayOptions
The display options of a control.
String filterControlId
The ID of the FilterTextFieldControl
.
String title
The title of the FilterTextFieldControl
.
String sourceFilterId
The source filter ID of the FilterTextFieldControl
.
TextFieldControlDisplayOptions displayOptions
The display options of a control.
String folderId
The ID of the folder.
String arn
The Amazon Resource Name (ARN) for the folder.
String name
A display name for the folder.
String folderType
The type of folder it is.
List<E> folderPath
An array of ancestor ARN strings for the folder.
Date createdTime
The time that the folder was created.
Date lastUpdatedTime
The time that the folder was last updated.
String operator
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
.
String name
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.
String value
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"
.
String arn
The Amazon Resource Name (ARN) of the folder.
String folderId
The ID of the folder.
String name
The display name of the folder.
String folderType
The type of folder.
Date createdTime
The time that the folder was created.
Date lastUpdatedTime
The time that the folder was last updated.
String fontFamily
Determines the font family settings.
FontSize fontSize
The option that determines the text display size.
String fontDecoration
Determines the appearance of decorative lines on the text.
String fontColor
Determines the color of the text.
FontWeight fontWeight
The option that determines the text display weight, or boldness.
String fontStyle
Determines the text display face that is inherited by the given font family.
String relative
The lexical name for the text size, proportional to its surrounding context.
String name
The lexical name for the level of boldness of the text display.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
MeasureField value
The value field that is used in a computation.
Integer periodsForward
The periods forward setup of a forecast computation.
Integer periodsBackward
The periods backward setup of a forecast computation.
Double upperBoundary
The upper boundary setup of a forecast computation.
Double lowerBoundary
The lower boundary setup of a forecast computation.
Integer predictionInterval
The prediction interval setup of a forecast computation.
String seasonality
The seasonality setup of a forecast computation. Choose one of the following options:
AUTOMATIC
CUSTOM
: Checks the custom seasonality value.
Integer customSeasonalityValue
The custom seasonality value setup of a forecast computation.
TimeBasedForecastProperties forecastProperties
The forecast properties setup of a forecast in the line chart.
ForecastScenario scenario
The forecast scenario of a forecast in the line chart.
WhatIfPointScenario whatIfPointScenario
The what-if analysis forecast setup with the target date.
WhatIfRangeScenario whatIfRangeScenario
The what-if analysis forecast setup with the date range.
StringFormatConfiguration stringFormatConfiguration
Formatting configuration for string fields.
NumberFormatConfiguration numberFormatConfiguration
Formatting configuration for number fields.
DateTimeFormatConfiguration dateTimeFormatConfiguration
Formatting configuration for DateTime
fields.
FreeFormLayoutScreenCanvasSizeOptions screenCanvasSizeOptions
The options that determine the sizing of the canvas used in a free-form layout.
List<E> elements
The elements that are included in a free-form layout.
FreeFormLayoutCanvasSizeOptions canvasSizeOptions
String elementId
A unique identifier for an element within a free-form layout.
String elementType
The type of element.
String xAxisLocation
The x-axis coordinate of the element.
String yAxisLocation
The y-axis coordinate of the element.
String width
The width of an element within a free-form layout.
String height
The height of an element within a free-form layout.
String visibility
The visibility of an element within a free-form layout.
List<E> renderingRules
The rendering rules that determine when an element should be displayed within a free-form layout.
FreeFormLayoutElementBorderStyle borderStyle
The border style configuration of a free-form layout element.
FreeFormLayoutElementBorderStyle selectedBorderStyle
The border style configuration of a free-form layout element. This border style is used when the element is selected.
FreeFormLayoutElementBackgroundStyle backgroundStyle
The background style configuration of a free-form layout element.
LoadingAnimation loadingAnimation
The loading animation configuration of a free-form layout element.
String optimizedViewPortWidth
The width that the view port will be optimized for when the layout renders.
FunnelChartFieldWells fieldWells
The field well configuration of a FunnelChartVisual
.
FunnelChartSortConfiguration sortConfiguration
The sort configuration of a FunnelChartVisual
.
ChartAxisLabelOptions categoryLabelOptions
The label options of the categories that are displayed in a FunnelChartVisual
.
ChartAxisLabelOptions valueLabelOptions
The label options for the values that are displayed in a FunnelChartVisual
.
TooltipOptions tooltip
The tooltip configuration of a FunnelChartVisual
.
FunnelChartDataLabelOptions dataLabelOptions
The options that determine the presentation of the data labels.
VisualPalette visualPalette
The visual palette configuration of a FunnelChartVisual
.
String visibility
The visibility option that determines if data labels are displayed.
String categoryLabelVisibility
The visibility of the category labels within the data labels.
String measureLabelVisibility
The visibility of the measure labels within the data labels.
String position
Determines the positioning of the data label relative to a section of the funnel.
FontConfiguration labelFontConfiguration
The font configuration for the data labels.
Only the FontSize
attribute of the font configuration is used for data labels.
String labelColor
The color of the data label text.
String measureDataLabelStyle
Determines the style of the metric labels.
FunnelChartAggregatedFieldWells funnelChartAggregatedFieldWells
The field well configuration of a FunnelChartVisual
.
List<E> categorySort
The sort configuration of the category fields.
ItemsLimitConfiguration categoryItemsLimit
The limit on the number of categories displayed.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
FunnelChartConfiguration chartConfiguration
The configuration of a FunnelChartVisual
.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
ConditionalFormattingColor foregroundColor
The conditional formatting of the arc foreground color.
GaugeChartPrimaryValueConditionalFormatting primaryValue
The conditional formatting for the primary value of a GaugeChartVisual
.
GaugeChartArcConditionalFormatting arc
The options that determine the presentation of the arc of a GaugeChartVisual
.
GaugeChartFieldWells fieldWells
The field well configuration of a GaugeChartVisual
.
GaugeChartOptions gaugeChartOptions
The options that determine the presentation of the GaugeChartVisual
.
DataLabelOptions dataLabels
The data label configuration of a GaugeChartVisual
.
TooltipOptions tooltipOptions
The tooltip configuration of a GaugeChartVisual
.
VisualPalette visualPalette
The visual palette configuration of a GaugeChartVisual
.
String primaryValueDisplayType
The options that determine the primary value display type.
ComparisonConfiguration comparison
The comparison configuration of a GaugeChartVisual
.
ArcAxisConfiguration arcAxis
The arc axis configuration of a GaugeChartVisual
.
ArcConfiguration arc
The arc configuration of a GaugeChartVisual
.
FontConfiguration primaryValueFontConfiguration
The options that determine the primary value font configuration.
ConditionalFormattingColor textColor
The conditional formatting of the primary value text color.
ConditionalFormattingIcon icon
The conditional formatting of the primary value icon.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
GaugeChartConfiguration chartConfiguration
The configuration of a GaugeChartVisual
.
GaugeChartConditionalFormatting conditionalFormatting
The conditional formatting of a GaugeChartVisual
.
List<E> actions
The list of custom actions that are configured for a visual.
String awsAccountId
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
String namespace
The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon
QuickSight custom namespace, set this to default
.
List<E> sessionTags
The session tags used for row-level security. Before you use this parameter, make sure that you have configured
the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration
parameter so that session
tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
List<E> authorizedResourceArns
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during
the lifetime of the session. If you choose Dashboard
embedding experience, pass the list of
dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25
dashboard ARNs in each API call.
AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration
The configuration of the experience that you are embedding.
List<E> allowedDomains
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example,
https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
String embedUrl
The embed URL for the dashboard.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String anonymousUserArn
The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
String awsAccountId
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
String userArn
The Amazon Resource Name for the registered user.
RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration
The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
List<E> allowedDomains
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example,
https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
Double north
The latitude of the north bound of the geospatial coordinate bounds.
Double south
The latitude of the south bound of the geospatial coordinate bounds.
Double west
The longitude of the west bound of the geospatial coordinate bounds.
Double east
The longitude of the east bound of the geospatial coordinate bounds.
GeospatialMapFieldWells fieldWells
The field wells of the visual.
LegendOptions legend
The legend display setup of the visual.
TooltipOptions tooltip
The tooltip display setup of the visual.
GeospatialWindowOptions windowOptions
The window options of the geospatial map.
GeospatialMapStyleOptions mapStyleOptions
The map style options of the geospatial map.
GeospatialPointStyleOptions pointStyleOptions
The point style options of the geospatial map.
VisualPalette visualPalette
GeospatialMapAggregatedFieldWells geospatialMapAggregatedFieldWells
The aggregated field well for a geospatial map.
String baseMapStyle
The base map style of the geospatial map.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
GeospatialMapConfiguration chartConfiguration
The configuration settings of the visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
List<E> actions
The list of custom actions that are configured for a visual.
String selectedPointStyle
The selected point styles (point, cluster) of the geospatial map.
ClusterMarkerConfiguration clusterMarkerConfiguration
The cluster marker configuration of the geospatial point style.
GeospatialCoordinateBounds bounds
The bounds options (north, south, west, east) of the geospatial window options.
String mapZoomMode
The map zoom modes (manual, auto) of the geospatial window options.
String awsAccountId
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
String dashboardId
The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
String identityType
The authentication method that the user uses to sign in.
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
Boolean undoRedoDisabled
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
Boolean resetDisabled
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
Boolean statePersistenceEnabled
Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the
parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses
while viewing the dashboard. If this is set to TRUE
, the settings are the same when the subscriber
reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set
to FALSE, the state of the user session is not persisted. The default is FALSE
.
String userArn
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
identity type. You
can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one
of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
String namespace
The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom
namespace, set Namespace = default
.
List<E> additionalDashboardIds
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
IdentityType
parameter must be set to ANONYMOUS
because other identity types
authenticate as Amazon QuickSight or IAM users. For example, if you set "
--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS
", the session can
access all three dashboards.
String embedUrl
A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5
minutes. The API operation provides the URL with an auth_code
value that enables one (and only one)
sign-on to a user session that is valid for 10 hours.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
String entryPoint
The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId
- where DashboardId
is the actual ID key from the
Amazon QuickSight console URL of the dashboard
/analyses/AnalysisId
- where AnalysisId
is the actual ID key from the Amazon
QuickSight console URL of the analysis
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
String userArn
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
identity type. You
can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to
be authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
String embedUrl
A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This
URL is valid for 5 minutes. The API operation provides the URL with an auth_code
value that enables
one (and only one) sign-on to a user session that is valid for 10 hours.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
TableBorderOptions uniformBorder
Determines the options for uniform border.
TableSideBorderOptions sideSpecificBorder
Determines the options for side specific border.
GridLayoutScreenCanvasSizeOptions screenCanvasSizeOptions
The options that determine the sizing of the canvas used in a grid layout.
List<E> elements
The elements that are included in a grid layout.
GridLayoutCanvasSizeOptions canvasSizeOptions
String elementId
A unique identifier for an element within a grid layout.
String elementType
The type of element.
Integer columnIndex
The column index for the upper left corner of an element.
Integer columnSpan
The width of a grid element expressed as a number of grid columns.
Integer rowIndex
The row index for the upper left corner of an element.
Integer rowSpan
The height of a grid element expressed as a number of grid rows.
String resizeOption
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
.
String optimizedViewPortWidth
The width that the view port will be optimized for when the layout renders.
String operator
The comparison operator that you want to use as a filter, for example "Operator": "StartsWith"
.
Currently, the only supported operator is StartsWith
.
String name
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
.
String value
The value of the named item, in this case GROUP_NAME
, that you want to use as a filter.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
MeasureField value
The value field that is used in a computation.
Integer periodSize
The period size setup of a growth rate computation.
Boolean show
This Boolean value controls whether to display a gutter space between sheet tiles.
String sectionId
The unique identifier of the header or footer section.
SectionLayoutConfiguration layout
The layout configuration of the header or footer section.
SectionStyle style
The style options of a header or footer section.
HeatMapFieldWells fieldWells
The field wells of the visual.
HeatMapSortConfiguration sortConfiguration
The sort configuration of a heat map.
ChartAxisLabelOptions rowLabelOptions
The label options of the row that is displayed in a heat map
.
ChartAxisLabelOptions columnLabelOptions
The label options of the column that is displayed in a heat map.
ColorScale colorScale
The color options (gradient color, point of divergence) in a heat map.
LegendOptions legend
The legend display setup of the visual.
DataLabelOptions dataLabels
The options that determine if visual data labels are displayed.
TooltipOptions tooltip
The tooltip display setup of the visual.
HeatMapAggregatedFieldWells heatMapAggregatedFieldWells
The aggregated field wells of a heat map.
List<E> heatMapRowSort
The field sort configuration of the rows fields.
List<E> heatMapColumnSort
The column sort configuration for heat map for columns that aren't a part of a field well.
ItemsLimitConfiguration heatMapRowItemsLimitConfiguration
The limit on the number of rows that are displayed in a heat map.
ItemsLimitConfiguration heatMapColumnItemsLimitConfiguration
The limit on the number of columns that are displayed in a heat map.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
HeatMapConfiguration chartConfiguration
The configuration of a heat map.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
List<E> actions
The list of custom actions that are configured for a visual.
String selectedBinType
The options that determine the selected bin type.
BinCountOptions binCount
The options that determine the bin count of a histogram.
BinWidthOptions binWidth
The options that determine the bin width of a histogram.
Double startValue
The options that determine the bin start value.
HistogramFieldWells fieldWells
The field well configuration of a histogram.
AxisDisplayOptions xAxisDisplayOptions
The options that determine the presentation of the x-axis.
ChartAxisLabelOptions xAxisLabelOptions
The options that determine the presentation of the x-axis label.
AxisDisplayOptions yAxisDisplayOptions
The options that determine the presentation of the y-axis.
HistogramBinOptions binOptions
The options that determine the presentation of histogram bins.
DataLabelOptions dataLabels
The data label configuration of a histogram.
TooltipOptions tooltip
The tooltip configuration of a histogram.
VisualPalette visualPalette
The visual palette configuration of a histogram.
HistogramAggregatedFieldWells histogramAggregatedFieldWells
The field well configuration of a histogram.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
HistogramConfiguration chartConfiguration
The configuration for a HistogramVisual
.
List<E> actions
The list of custom actions that are configured for a visual.
String awsAccountId
The Amazon Web Services account ID.
String assignmentId
Assignment ID.
String assignmentName
Assignment name.
String policyArn
The Amazon Resource Name (ARN) for the IAM policy.
Map<K,V> identities
Identities.
String assignmentStatus
Assignment status.
String requestId
The Amazon Web Services request ID for this request.
String arn
The Amazon Resource Name (ARN) of the resource.
String ingestionId
Ingestion ID.
String ingestionStatus
Ingestion status.
ErrorInfo errorInfo
Error information for this ingestion.
RowInfo rowInfo
QueueInfo queueInfo
Date createdTime
The time that this ingestion started.
Long ingestionTimeInSeconds
The time that this ingestion took, measured in seconds.
Long ingestionSizeInBytes
The size of the data ingested, in bytes.
String requestSource
Event source for this ingestion.
String requestType
Type of this ingestion.
List<E> computations
The computations configurations of the insight visual
CustomNarrativeOptions customNarrative
The custom narrative of the insight visual.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
InsightConfiguration insightConfiguration
The configuration of an insight visual.
List<E> actions
The list of custom actions that are configured for a visual.
String dataSetIdentifier
The dataset that is used in the insight visual.
DynamicDefaultValue dynamicValue
The dynamic value of the IntegerDefaultValues
. Different defaults are displayed according to users,
groups, and values mapping.
List<E> staticValues
The static values of the IntegerDefaultValues
.
String parameterValueType
The value type determines whether the parameter is a single-value or multi-value parameter.
String name
The name of the parameter that is being declared.
IntegerDefaultValues defaultValues
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
IntegerValueWhenUnsetConfiguration valueWhenUnset
A parameter declaration for the Integer
data type.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String siteBaseUrl
The base URL of the Jira site.
String leftOperand
The operand on the left side of a join.
String rightOperand
The operand on the right side of a join.
JoinKeyProperties leftJoinKeyProperties
Join key properties of the left operand.
JoinKeyProperties rightJoinKeyProperties
Join key properties of the right operand.
String type
The type of join that it is.
String onClause
The join instructions provided in the ON
clause of a join.
Boolean uniqueKey
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.
KPIPrimaryValueConditionalFormatting primaryValue
The conditional formatting for the primary value of a KPI visual.
KPIProgressBarConditionalFormatting progressBar
The conditional formatting for the progress bar of a KPI visual.
KPIFieldWells fieldWells
The field well configuration of a KPI visual.
KPISortConfiguration sortConfiguration
The sort configuration of a KPI visual.
KPIOptions kPIOptions
The options that determine the presentation of a KPI visual.
ProgressBarOptions progressBar
The options that determine the presentation of the progress bar of a KPI visual.
TrendArrowOptions trendArrows
The options that determine the presentation of trend arrows in a KPI visual.
SecondaryValueOptions secondaryValue
The options that determine the presentation of the secondary value of a KPI visual.
ComparisonConfiguration comparison
The comparison configuration of a KPI visual.
String primaryValueDisplayType
The options that determine the primary value display type.
FontConfiguration primaryValueFontConfiguration
The options that determine the primary value font configuration.
FontConfiguration secondaryValueFontConfiguration
The options that determine the secondary value font configuration.
ConditionalFormattingColor textColor
The conditional formatting of the primary value's text color.
ConditionalFormattingIcon icon
The conditional formatting of the primary value's icon.
ConditionalFormattingColor foregroundColor
The conditional formatting of the progress bar's foreground color.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
KPIConfiguration chartConfiguration
The configuration of a KPI visual.
KPIConditionalFormatting conditionalFormatting
The conditional formatting of a KPI visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
String visibility
Determines whether or not the label is visible.
FontConfiguration fontConfiguration
The font configuration of the label.
String customLabel
The text for the label.
LayoutConfiguration configuration
The configuration that determines what the type of layout for a sheet.
GridLayoutConfiguration gridLayout
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
.
FreeFormLayoutConfiguration freeFormLayout
A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
SectionBasedLayoutConfiguration sectionBasedLayout
A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
String visibility
Determines whether or not the legend is visible.
LabelOptions title
The custom title for the legend.
String position
The positions for the legend. Choose one of the following options:
AUTO
RIGHT
BOTTOM
LEFT
String width
The width of the legend. If this value is omitted, a default width is used when rendering.
String height
The height of the legend. If this value is omitted, a default height is used when rendering.
List<E> category
The category field wells of a line chart. Values are grouped by category fields.
List<E> values
The value field wells of a line chart. Values are aggregated based on categories.
List<E> colors
The color field wells of a line chart. Values are grouped by category fields.
List<E> smallMultiples
The small multiples field well of a line chart.
LineChartFieldWells fieldWells
The field well configuration of a line chart.
LineChartSortConfiguration sortConfiguration
The sort configuration of a line chart.
List<E> forecastConfigurations
The forecast configuration of a line chart.
String type
Determines the type of the line chart.
SmallMultiplesOptions smallMultiplesOptions
The small multiples setup for the visual.
AxisDisplayOptions xAxisDisplayOptions
The options that determine the presentation of the x-axis.
ChartAxisLabelOptions xAxisLabelOptions
The options that determine the presentation of the x-axis label.
LineSeriesAxisDisplayOptions primaryYAxisDisplayOptions
The series axis configuration of a line chart.
ChartAxisLabelOptions primaryYAxisLabelOptions
The options that determine the presentation of the y-axis label.
LineSeriesAxisDisplayOptions secondaryYAxisDisplayOptions
The series axis configuration of a line chart.
ChartAxisLabelOptions secondaryYAxisLabelOptions
The options that determine the presentation of the secondary y-axis label.
LineChartDefaultSeriesSettings defaultSeriesSettings
The options that determine the default presentation of all line series in LineChartVisual
.
List<E> series
The series item configuration of a line chart.
LegendOptions legend
The legend configuration of a line chart.
DataLabelOptions dataLabels
The data label configuration of a line chart.
List<E> referenceLines
The reference lines configuration of a line chart.
TooltipOptions tooltip
The tooltip configuration of a line chart.
List<E> contributionAnalysisDefaults
The default configuration of a line chart's contribution analysis.
VisualPalette visualPalette
The visual palette configuration of a line chart.
String axisBinding
The axis to which you are binding all line series to.
LineChartLineStyleSettings lineStyleSettings
Line styles options for all line series in the visual.
LineChartMarkerStyleSettings markerStyleSettings
Marker styles options for all line series in the visual.
LineChartAggregatedFieldWells lineChartAggregatedFieldWells
The field well configuration of a line chart.
String lineVisibility
Configuration option that determines whether to show the line for the series.
String lineInterpolation
Interpolation style for line series.
LINEAR
: Show as default, linear style.
SMOOTH
: Show as a smooth curve.
STEPPED
: Show steps in line.
String lineStyle
Line style for line series.
SOLID
: Show as a solid line.
DOTTED
: Show as a dotted line.
DASHED
: Show as a dashed line.
String lineWidth
Width that determines the line thickness.
String markerVisibility
Configuration option that determines whether to show the markers in the series.
String markerShape
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.
String markerSize
Size of marker in the series.
String markerColor
Color of marker in the series.
LineChartLineStyleSettings lineStyleSettings
Line styles options for a line series in LineChartVisual
.
LineChartMarkerStyleSettings markerStyleSettings
Marker styles options for a line series in LineChartVisual
.
List<E> categorySort
The sort configuration of the category fields.
ItemsLimitConfiguration categoryItemsLimitConfiguration
The limit on the number of categories that are displayed in a line chart.
ItemsLimitConfiguration colorItemsLimitConfiguration
The limit on the number of lines that are displayed in a line chart.
List<E> smallMultiplesSort
The sort configuration of the small multiples field.
ItemsLimitConfiguration smallMultiplesLimitConfiguration
The limit on the number of small multiples panels that are displayed.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
LineChartConfiguration chartConfiguration
The configuration of a line chart.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
AxisDisplayOptions axisOptions
The options that determine the presentation of the line series axis.
List<E> missingDataConfigurations
The configuration options that determine how missing data is treated during the rendering of a line chart.
List<E> analysisSummaryList
Metadata describing each of the analyses that are listed.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
ListControlSearchOptions searchOptions
The configuration of the search options in a list control.
ListControlSelectAllOptions selectAllOptions
The configuration of the Select all
options in a list control.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
String visibility
The visibility configuration of the search options in a list control.
String visibility
The visibility configuration of the Select all
options in a list control.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboards that you're listing.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dashboardSummaryList
A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
String dashboardId
The ID for the dashboard.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dashboardVersionSummaryList
A structure that contains information about each version of the dashboard.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
List<E> dataSetSummaries
The list of dataset summaries.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
String folderId
The ID of the folder.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
Integer status
The HTTP status of the request.
List<E> folderMemberList
A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
List<E> folderSummaryList
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
String groupName
The name of the group that you want to see a membership list of.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want a list of users from.
List<E> groupMemberList
The list of the members of the group.
String nextToken
A pagination token that can be used in a subsequent request.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return.
String namespace
The namespace that you want a list of groups from.
String awsAccountId
The ID of the Amazon Web Services account that contains the assignments.
String userName
The name of the user.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
String namespace
The namespace of the assignment.
List<E> activeAssignments
The active assignments for this user.
String requestId
The Amazon Web Services request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains these IAM policy assignments.
String assignmentStatus
The status of the assignments.
String namespace
The namespace for the assignments.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> iAMPolicyAssignments
Information describing the IAM policy assignments.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String dataSetId
The ID of the dataset used in the ingestion.
String nextToken
The token for the next set of results, or null if there are no more results.
String awsAccountId
The Amazon Web Services account ID.
Integer maxResults
The maximum number of results to be returned per request.
String awsAccountId
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
String nextToken
A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the
response body of a previous ListNameSpaces
API call if there is more data that can be returned. To
receive the data, make another ListNamespaces
API call with the returned token to retrieve the next
page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces
API call with an
expired token, you will receive a HTTP 400 InvalidNextTokenException
error.
Integer maxResults
The maximum number of results to return.
List<E> namespaces
The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.
String nextToken
A unique pagination token that can be used in a subsequent request. Receiving NextToken
in your
response inticates that there is more data that can be returned. To receive the data, make another
ListNamespaces
API call with the returned token to retrieve the next page of data. Each token is
valid for 24 hours. If you try to make a ListNamespaces
API call with an expired token, you will
receive a HTTP 400 InvalidNextTokenException
error.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
String awsAccountId
The ID of the Amazon Web Services account that contains the template aliases that you're listing.
String templateId
The ID for the template.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> templateAliasList
A structure containing the list of the template's aliases.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
String awsAccountId
The ID of the Amazon Web Services account that contains the templates that you're listing.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> templateSummaryList
A structure containing information about the templates in the list.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the templates that you're listing.
String templateId
The ID for the template.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> templateVersionSummaryList
A structure containing a list of all the versions of the specified template.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
String themeId
The ID for the theme.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> themeAliasList
A structure containing the list of the theme's aliases.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
String awsAccountId
The ID of the Amazon Web Services account that contains the themes that you're listing.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
String type
The type of themes that you want to list. Valid options include the following:
ALL (default)
- Display all existing themes.
CUSTOM
- Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT
- Display only the starting themes defined by Amazon QuickSight.
List<E> themeSummaryList
Information about the themes in the list.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the themes that you're listing.
String themeId
The ID for the theme.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> themeVersionSummaryList
A structure containing a list of all the versions of the specified theme.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String userName
The Amazon QuickSight user name that you want to list group memberships for.
String awsAccountId
The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String namespace
The namespace. Currently, you should set this to default
.
String visibility
The visibility configuration of LoadingAnimation
.
String targetSheetId
The sheet that is targeted for navigation in the same analysis.
String alias
A display name for the logical table.
List<E> dataTransforms
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
LogicalTableSource source
Source of this logical table.
JoinInstruction joinInstruction
Specifies the result of a join of two logical tables.
String physicalTableId
Physical table ID.
String dataSetArn
The Amazon Resource Number (ARN) of the parent dataset.
Boolean show
This Boolean value controls whether to display sheet margins.
String visibility
The visibility of the maximum label.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
MeasureField value
The value field that is used in a computation.
String type
The type of computation. Choose one of the following options:
MAXIMUM: A maximum computation.
MINIMUM: A minimum computation.
NumericalMeasureField numericalMeasureField
The measure type field with numerical type columns.
CategoricalMeasureField categoricalMeasureField
The measure type field with categorical type columns.
DateMeasureField dateMeasureField
The measure type field with date type columns.
CalculatedMeasureField calculatedMeasureField
The calculated measure field only used in pivot tables.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
MeasureField fromValue
The field that is used in a metric comparison from value setup.
MeasureField targetValue
The field that is used in a metric comparison to value setup.
String visibility
The visibility of the minimum label.
String treatmentOption
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.
String name
The name of the error.
String arn
The namespace ARN.
String capacityRegion
The namespace Amazon Web Services Region.
String creationStatus
The creation status of a namespace that is not yet completely created.
String identityStore
The identity store used for the namespace.
NamespaceError namespaceError
An error that occurred when the namespace was created.
String displayMode
Determines the display mode of the negative value configuration.
String nullString
Determines the null string of null values.
String prefix
Determines the prefix value of the number format.
String suffix
Determines the suffix value of the number format.
NumericSeparatorConfiguration separatorConfiguration
The options that determine the numeric separator configuration.
DecimalPlacesConfiguration decimalPlacesConfiguration
The option that determines the decimal places configuration.
String numberScale
Determines the number scale value of the number format.
NegativeValueConfiguration negativeValueConfiguration
The options that determine the negative value configuration.
NullValueFormatConfiguration nullValueFormatConfiguration
The options that determine the null value format configuration.
NumericFormatConfiguration formatConfiguration
The options that determine the numeric format configuration.
String simpleNumericalAggregation
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.
PercentileAggregation percentileAggregation
An aggregation based on the percentile of values in a dimension or measure.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the NumericalDimensionField
.
String hierarchyId
The custom hierarchy ID.
NumberFormatConfiguration formatConfiguration
The format configuration of the field.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the NumericalMeasureField
.
NumericalAggregationFunction aggregationFunction
The aggregation function of the measure field.
NumberFormatConfiguration formatConfiguration
The format configuration of the field.
AxisScale scale
The scale setup of a numeric axis.
AxisDisplayRange range
The range setup of a numeric axis.
ColumnIdentifier column
The column that the filter is applied to.
Double value
The value of the double input numeric drill down filter.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
Double value
The input value.
String selectAllOptions
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
String matchOperator
The match operator that is used to determine if a filter should be applied.
AggregationFunction aggregationFunction
The aggregation function of the filter.
String parameterName
The parameter whose value should be used for the filter value.
String nullOption
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.
NumberDisplayFormatConfiguration numberDisplayFormatConfiguration
The options that determine the number display format configuration.
CurrencyDisplayFormatConfiguration currencyDisplayFormatConfiguration
The options that determine the currency display format configuration.
PercentageDisplayFormatConfiguration percentageDisplayFormatConfiguration
The options that determine the percentage display format configuration.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
Boolean includeMinimum
Determines whether the minimum value in the filter value range should be included in the filtered results.
Boolean includeMaximum
Determines whether the maximum value in the filter value range should be included in the filtered results.
NumericRangeFilterValue rangeMinimum
The minimum value for the filter value range.
NumericRangeFilterValue rangeMaximum
The maximum value for the filter value range.
String selectAllOptions
Select all of the values. Null is not the assigned value of select all.
FILTER_ALL_VALUES
AggregationFunction aggregationFunction
The aggregation function of the filter.
String nullOption
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.
String decimalSeparator
Determines the decimal separator.
ThousandSeparatorOptions thousandsSeparator
The options that determine the thousands separator configuration.
PanelTitleOptions title
Configures the title display within each small multiples panel.
String borderVisibility
Determines whether or not each panel displays a border.
String borderThickness
Sets the line thickness of panel borders.
String borderStyle
Sets the line style of panel borders.
String borderColor
Sets the line color of panel borders.
String gutterVisibility
Determines whether or not negative space between sibling panels is rendered.
String gutterSpacing
Sets the total amount of negative space to display between sibling panels.
String backgroundVisibility
Determines whether or not a background for each small multiples panel is rendered.
String backgroundColor
Sets the background color for each panel.
String visibility
Determines whether or not panel titles are displayed.
FontConfiguration fontConfiguration
String horizontalTextAlignment
Sets the horizontal text alignment of the title within each panel.
ParameterDateTimePickerControl dateTimePicker
A control from a date parameter that specifies date and time.
ParameterListControl list
A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
ParameterDropDownControl dropdown
A control to display a dropdown list with buttons that are used to select a single value.
ParameterTextFieldControl textField
A control to display a text box that is used to enter a single entry.
ParameterTextAreaControl textArea
A control to display a text box that is used to enter multiple entries.
ParameterSliderControl slider
A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
String parameterControlId
The ID of the ParameterDateTimePickerControl
.
String title
The title of the ParameterDateTimePickerControl
.
String sourceParameterName
The name of the ParameterDateTimePickerControl
.
DateTimePickerControlDisplayOptions displayOptions
The display options of a control.
StringParameterDeclaration stringParameterDeclaration
A parameter declaration for the String
data type.
DecimalParameterDeclaration decimalParameterDeclaration
A parameter declaration for the Decimal
data type.
IntegerParameterDeclaration integerParameterDeclaration
A parameter declaration for the Integer
data type.
DateTimeParameterDeclaration dateTimeParameterDeclaration
A parameter declaration for the DateTime
data type.
String parameterControlId
The ID of the ParameterDropDownControl
.
String title
The title of the ParameterDropDownControl
.
String sourceParameterName
The source parameter name of the ParameterDropDownControl
.
DropDownControlDisplayOptions displayOptions
The display options of a control.
String type
The type parameter name of the ParameterDropDownControl
.
ParameterSelectableValues selectableValues
A list of selectable values that are used in a control.
CascadingControlConfiguration cascadingControlConfiguration
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.
String parameterControlId
The ID of the ParameterListControl
.
String title
The title of the ParameterListControl
.
String sourceParameterName
The source parameter name of the ParameterListControl
.
ListControlDisplayOptions displayOptions
The display options of a control.
String type
The type of ParameterListControl
.
ParameterSelectableValues selectableValues
A list of selectable values that are used in a control.
CascadingControlConfiguration cascadingControlConfiguration
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.
List<E> stringParameters
The parameters that have a data type of string.
List<E> integerParameters
The parameters that have a data type of integer.
List<E> decimalParameters
The parameters that have a data type of decimal.
List<E> dateTimeParameters
The parameters that have a data type of date-time.
List<E> values
The values that are used in ParameterSelectableValues
.
ColumnIdentifier linkToDataSetColumn
The column identifier that fetches values from the data set.
String parameterControlId
The ID of the ParameterSliderControl
.
String title
The title of the ParameterSliderControl
.
String sourceParameterName
The source parameter name of the ParameterSliderControl
.
SliderControlDisplayOptions displayOptions
The display options of a control.
Double maximumValue
The smaller value that is displayed at the left of the slider.
Double minimumValue
The larger value that is displayed at the right of the slider.
Double stepSize
The number of increments that the slider bar is divided into.
String parameterControlId
The ID of the ParameterTextAreaControl
.
String title
The title of the ParameterTextAreaControl
.
String sourceParameterName
The source parameter name of the ParameterTextAreaControl
.
String delimiter
The delimiter that is used to separate the lines in text.
TextAreaControlDisplayOptions displayOptions
The display options of a control.
String parameterControlId
The ID of the ParameterTextFieldControl
.
String title
The title of the ParameterTextFieldControl
.
String sourceParameterName
The source parameter name of the ParameterTextFieldControl
.
TextFieldControlDisplayOptions displayOptions
The display options of a control.
String prefix
Determines the prefix value of the percentage format.
String suffix
Determines the suffix value of the percentage format.
NumericSeparatorConfiguration separatorConfiguration
The options that determine the numeric separator configuration.
DecimalPlacesConfiguration decimalPlacesConfiguration
The option that determines the decimal places configuration.
NegativeValueConfiguration negativeValueConfiguration
The options that determine the negative value configuration.
NullValueFormatConfiguration nullValueFormatConfiguration
The options that determine the null value format configuration.
Double percentileValue
The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
MeasureField value
The value field that is used in a computation.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
MeasureField value
The value field that is used in a computation.
String periodTimeGranularity
The time granularity setup of period to date computation. Choose from the following options:
YEAR: Year to date.
MONTH: Month to date.
RelationalTable relationalTable
A physical table type for relational data sources.
CustomSql customSql
A physical table type built from the results of the custom SQL query.
S3Source s3Source
A physical table type for as S3 data source.
PieChartFieldWells fieldWells
The field wells of the visual.
PieChartSortConfiguration sortConfiguration
The sort configuration of a pie chart.
DonutOptions donutOptions
The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.
SmallMultiplesOptions smallMultiplesOptions
The small multiples setup for the visual.
ChartAxisLabelOptions categoryLabelOptions
The label options of the group/color that is displayed in a pie chart.
ChartAxisLabelOptions valueLabelOptions
The label options for the value that is displayed in a pie chart.
LegendOptions legend
The legend display setup of the visual.
DataLabelOptions dataLabels
The options that determine if visual data labels are displayed.
TooltipOptions tooltip
The tooltip display setup of the visual.
VisualPalette visualPalette
The palette (chart color) display setup of the visual.
List<E> contributionAnalysisDefaults
The contribution analysis (anomaly configuration) setup of the visual.
PieChartAggregatedFieldWells pieChartAggregatedFieldWells
The field well configuration of a pie chart.
List<E> categorySort
The sort configuration of the category fields.
ItemsLimitConfiguration categoryItemsLimit
The limit on the number of categories that are displayed in a pie chart.
List<E> smallMultiplesSort
The sort configuration of the small multiples field.
ItemsLimitConfiguration smallMultiplesLimitConfiguration
The limit on the number of small multiples panels that are displayed.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
PieChartConfiguration chartConfiguration
The configuration of a pie chart.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
String fieldId
The field ID for the field sort options.
PivotTableSortBy sortBy
The sort by field for the field sort options.
List<E> rows
The rows field well for a pivot table. Values are grouped by rows fields.
List<E> columns
The columns field well for a pivot table. Values are grouped by columns fields.
List<E> values
The values field well for a pivot table. Values are aggregated based on rows and columns fields.
String fieldId
The field ID of the cell for conditional formatting.
TextConditionalFormat textFormat
The text format of the cell for conditional formatting.
PivotTableConditionalFormattingScope scope
The scope of the cell for conditional formatting.
PivotTableCellConditionalFormatting cell
The cell conditional formatting option for a pivot table.
String role
The role (field, field total, grand total) of the cell for conditional formatting.
PivotTableFieldWells fieldWells
The field wells of the visual.
PivotTableSortConfiguration sortConfiguration
The sort configuration for a PivotTableVisual
.
PivotTableOptions tableOptions
The table options for a pivot table visual.
PivotTableTotalOptions totalOptions
The total options for a pivot table visual.
PivotTableFieldOptions fieldOptions
The field options for a pivot table visual.
PivotTablePaginatedReportOptions paginatedReportOptions
The paginated report options for a pivot table visual.
String fieldId
The field ID of the subtotal options.
PivotTableAggregatedFieldWells pivotTableAggregatedFieldWells
The aggregated field well for the pivot table.
String metricPlacement
The metric placement (row, column) options.
String singleMetricVisibility
The visibility of the single metric options.
String columnNamesVisibility
The visibility of the column names.
String toggleButtonsVisibility
Determines the visibility of the pivot table.
TableCellStyle columnHeaderStyle
The table cell style of the column header.
TableCellStyle rowHeaderStyle
The table cell style of the row headers.
TableCellStyle cellStyle
The table cell style of cells.
TableCellStyle rowFieldNamesStyle
The table cell style of row field names.
RowAlternateColorOptions rowAlternateColorOptions
The row alternate color options (widget status, row alternate colors).
FieldSort field
The field sort (field id, direction) for the pivot table sort by options.
ColumnSort column
The column sort (field id, direction) for the pivot table sort by options.
DataPathSort dataPath
The data path sort (data path value, direction) for the pivot table sort by options.
SubtotalOptions rowSubtotalOptions
The row subtotal options.
SubtotalOptions columnSubtotalOptions
The column subtotal options.
PivotTotalOptions rowTotalOptions
The row total options.
PivotTotalOptions columnTotalOptions
The column total options.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
PivotTableConfiguration chartConfiguration
The configuration settings of the visual.
PivotTableConditionalFormatting conditionalFormatting
The conditional formatting for a PivotTableVisual
.
List<E> actions
The list of custom actions that are configured for a visual.
String totalsVisibility
The visibility configuration for the total cells.
String placement
The placement (start, end) for the total cells.
String scrollStatus
The scroll status (pinned, scrolled) for the total cells.
String customLabel
The custom label string for the total cells.
TableCellStyle totalCellStyle
The cell styling options for the total cells.
TableCellStyle valueCellStyle
The cell styling options for the totals of value cells.
TableCellStyle metricHeaderCellStyle
The cell styling options for the total of header cells.
String requestId
The Amazon Web Services request ID for this request.
String visibility
The visibility of the progress bar.
String requestId
The Amazon Web Services request ID for this request.
String visibility
The visibility of the range ends label.
String status
The status of the reference line. Choose one of the following options:
ENABLE
DISABLE
ReferenceLineDataConfiguration dataConfiguration
The data configuration of the reference line.
ReferenceLineStyleConfiguration styleConfiguration
The style configuration of the reference line.
ReferenceLineLabelConfiguration labelConfiguration
The label configuration of the reference line.
String customLabel
The string text of the custom label.
ReferenceLineStaticDataConfiguration staticConfiguration
The static data configuration of the reference line data configuration.
ReferenceLineDynamicDataConfiguration dynamicConfiguration
The dynamic configuration of the reference line data configuration.
String axisBinding
The axis binding type of the reference line. Choose one of the following options:
PrimaryY
SecondaryY
ColumnIdentifier column
The column that the dynamic data targets.
AggregationFunction measureAggregationFunction
The aggregation function that is used in the dynamic data.
NumericalAggregationFunction calculation
The calculation that is used in the dynamic data.
ReferenceLineValueLabelConfiguration valueLabelConfiguration
The value label configuration of the label in a reference line.
ReferenceLineCustomLabelConfiguration customLabelConfiguration
The custom label configuration of the label in a reference line.
FontConfiguration fontConfiguration
The font configuration of the label in a reference line.
String fontColor
The font color configuration of the label in a reference line.
String horizontalPosition
The horizontal position configuration of the label in a reference line. Choose one of the following options:
LEFT
CENTER
RIGHT
String verticalPosition
The vertical position configuration of the label in a reference line. Choose one of the following options:
ABOVE
BELOW
Double value
The double input of the static data.
String relativePosition
The relative position of the value label. Choose one of the following options:
BEFORE_CUSTOM_LABEL
AFTER_CUSTOM_LABEL
NumericFormatConfiguration formatConfiguration
The format configuration of the value label.
String initialDashboardId
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.
DashboardVisualId initialDashboardVisualId
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
.
RegisteredUserDashboardEmbeddingConfiguration dashboard
The configuration details for providing a dashboard embedding experience.
RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole
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 in the Amazon QuickSight User Guide.
Use
GenerateEmbedUrlForRegisteredUser
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
API operation. Use the
RegisterUser
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:
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.
RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual
The type of embedding experience. In this case, Amazon QuickSight visuals.
String initialTopicId
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.
String initialPath
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.
String identityType
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
IAM
: A user whose identity maps to an existing IAM user or role.
QUICKSIGHT
: A user whose identity is owned and managed internally by Amazon QuickSight.
String email
The email address of the user that you want to register.
String userRole
The Amazon QuickSight role for the user. The user role can be one of the following:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER
: This role isn't currently available for use.
RESTRICTED_AUTHOR
: This role isn't currently available for use.
String iamArn
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
String sessionName
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need
to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon
QuickSight user. You can register multiple users using the same IAM role if each user has a different session
name. For more information on assuming IAM roles, see assume-role
in
the CLI Reference.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String userName
The Amazon QuickSight user name that you want to create for the user you are registering.
String customPermissionsName
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use
UpdateUser
instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the
profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the
RegisterUser
API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
String externalLoginFederationProviderType
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the
COGNITO
provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed
when the external provider is custom.
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use
the CustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
String customFederationProviderUrl
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon
QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when
ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
String externalLoginId
The identity ID for a user in the external login provider.
User user
The user's user name.
String userInvitationUrl
The URL the user visits to complete registration and provide a password. This is returned only for users with an
identity type of QUICKSIGHT
.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String dataSourceArn
The Amazon Resource Name (ARN) for the data source.
String catalog
The catalog associated with a table.
String schema
The schema name. This name applies to certain relational database engines.
String name
The name of the relational table.
List<E> inputColumns
The column schema of the table.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
AnchorDateConfiguration anchorDateConfiguration
The date configuration of the filter.
String minimumGranularity
The minimum granularity (period granularity) of the relative dates filter.
String timeGranularity
The level of time precision that is used to aggregate DateTime
values.
String relativeDateType
The range date type of the filter. Choose one of the options below:
PREVIOUS
THIS
LAST
NOW
NEXT
Integer relativeDateValue
The date value of the filter.
String parameterName
The parameter whose value should be used for the filter value.
String nullOption
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.
ExcludePeriodConfiguration excludePeriodConfiguration
The configuration for the exclude period of the filter.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
String dateTimeFormat
Customize how dates are formatted in controls.
String principal
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.)
List<E> actions
The IAM action to grant or revoke permissions on.
String namespace
The namespace associated with the dataset that contains permissions for RLS.
String arn
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
String permissionPolicy
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is included
for backward compatibility only.
String formatVersion
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.
String status
The status of the row-level security permission dataset. If enabled, the status is ENABLED
. If
disabled, the status is DISABLED
.
String tagKey
The unique key for a tag.
String columnName
The column name that a tag key is assigned to.
String tagMultiValueDelimiter
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.
String matchAllValue
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.
ManifestFileLocation manifestFileLocation
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
String dataSourceArn
The Amazon Resource Name (ARN) for the data source.
UploadSettings uploadSettings
Information about the format for the S3 source file or files.
List<E> inputColumns
A physical table type for an S3 data source.
For files that aren't JSON, only STRING
data types are supported in input columns.
List<E> targetVisuals
A list of the target visual IDs that are located in the same sheet of the analysis.
String targetVisualOptions
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.
SankeyDiagramFieldWells fieldWells
The field well configuration of a sankey diagram.
SankeyDiagramSortConfiguration sortConfiguration
The sort configuration of a sankey diagram.
DataLabelOptions dataLabels
The data label configuration of a sankey diagram.
SankeyDiagramAggregatedFieldWells sankeyDiagramAggregatedFieldWells
The field well configuration of a sankey diagram.
List<E> weightSort
The sort configuration of the weight fields.
ItemsLimitConfiguration sourceItemsLimit
The limit on the number of source nodes that are displayed in a sankey diagram.
ItemsLimitConfiguration destinationItemsLimit
The limit on the number of destination nodes that are displayed in a sankey diagram.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
SankeyDiagramChartConfiguration chartConfiguration
The configuration of a sankey diagram.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> xAxis
The x-axis field well of a scatter plot.
The x-axis is aggregated by category.
List<E> yAxis
The y-axis field well of a scatter plot.
The y-axis is aggregated by category.
List<E> category
The category field well of a scatter plot.
List<E> size
The size field well of a scatter plot.
ScatterPlotFieldWells fieldWells
The field wells of the visual.
ChartAxisLabelOptions xAxisLabelOptions
The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
AxisDisplayOptions xAxisDisplayOptions
The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
ChartAxisLabelOptions yAxisLabelOptions
The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
AxisDisplayOptions yAxisDisplayOptions
The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
LegendOptions legend
The legend display setup of the visual.
DataLabelOptions dataLabels
The options that determine if visual data labels are displayed.
TooltipOptions tooltip
The legend display setup of the visual.
VisualPalette visualPalette
The palette (chart color) display setup of the visual.
ScatterPlotCategoricallyAggregatedFieldWells scatterPlotCategoricallyAggregatedFieldWells
The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.
ScatterPlotUnaggregatedFieldWells scatterPlotUnaggregatedFieldWells
The unaggregated field wells of a scatter plot. Scatter plots without a category field well have unaggregated field wells. The x and y-axes of these scatter plots are unaggregated.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
ScatterPlotConfiguration chartConfiguration
The configuration settings of the visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
String visibility
The visibility of the data zoom scroll bar.
VisibleRangeOptions visibleRange
The visibility range for the data zoom scroll bar.
String awsAccountId
The ID of the Amazon Web Services account that contains the analyses that you're searching for.
List<E> filters
The structure for the search filters that you want to apply to your search.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return.
List<E> analysisSummaryList
Metadata describing the analyses that you searched for.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
List<E> filters
The filters to apply to the search. Currently, you can search only by user name, for example,
"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dashboardSummaryList
The list of dashboards owned by the user specified in Filters
in your request.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
List<E> filters
The filters to apply to the search.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dataSetSummaries
A DataSetSummaries
object that returns a summary of a dataset.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
List<E> filters
The filters to apply to the search.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dataSourceSummaries
A DataSourceSummaries
object that returns a summary of a data source.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
List<E> filters
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]
.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
Integer status
The HTTP status of the request.
List<E> folderSummaryList
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String namespace
The namespace that you want to search.
List<E> filters
The structure for the search filters that you want to apply to your search.
List<E> groupList
A list of groups in a specified namespace that match the filters you set in your SearchGroups
request.
String nextToken
A pagination token that can be used in a subsequent request.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String visibility
Determines the visibility of the secondary value.
String status
The option that enables or disables a page break at the end of a section.
SectionBasedLayoutPaperCanvasSizeOptions paperCanvasSizeOptions
The options for a paper canvas of a section-based layout.
List<E> headerSections
A list of header section configurations.
List<E> bodySections
A list of body section configurations.
List<E> footerSections
A list of footer section configurations.
SectionBasedLayoutCanvasSizeOptions canvasSizeOptions
The options for the canvas of a section-based layout.
String paperSize
The paper size that is used to define canvas dimensions.
String paperOrientation
The paper orientation that is used to define canvas dimensions. Choose one of the following options:
PORTRAIT
LANDSCAPE
Spacing paperMargin
Defines the spacing between the canvas content and the top, bottom, left, and right edges.
FreeFormSectionLayoutConfiguration freeFormLayout
The free-form layout configuration of a section.
SectionAfterPageBreak after
The configuration of a page break after a section.
FieldSeriesItem fieldSeriesItem
The field series item configuration of a line chart.
DataFieldSeriesItem dataFieldSeriesItem
The data field series item configuration of a line chart.
String siteBaseUrl
URL of the base site.
String requestId
The Amazon Web Services request ID for this request.
String destinationParameterName
The destination parameter name of the SetParameterValueConfiguration
.
DestinationParameterValueConfiguration value
ConditionalFormattingColor backgroundColor
The conditional formatting for the shape background color of a filled map visual.
SheetControlLayoutConfiguration configuration
The configuration that determines the elements and canvas size options of sheet control.
GridLayoutConfiguration gridLayout
The configuration that determines the elements and canvas size options of sheet control.
String visibilityState
Visibility state.
String sheetId
The unique identifier of a sheet.
String title
The title of the sheet.
String description
A description of the sheet.
String name
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
List<E> parameterControls
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
List<E> filterControls
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
List<E> visuals
A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
List<E> textBoxes
The text boxes that are on a sheet.
List<E> layouts
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
List<E> sheetControlLayouts
The control layouts of the sheet.
String contentType
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.
String visibility
Determines whether or not the overrides are visible. Choose one of the following options:
VISIBLE
HIDDEN
String expression
The expression of the rendering rules of a sheet.
SheetElementConfigurationOverrides configurationOverrides
The override configuration of the rendering rules of a sheet.
TileStyle tile
The display options for tiles.
TileLayoutStyle tileLayout
The layout options for tiles.
String sheetTextBoxId
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.
String content
The content that is displayed in the text box.
Boolean iAMUser
A Boolean that is TRUE
if the Amazon QuickSight uses IAM as an authentication method.
String userLoginName
The user login name for your Amazon QuickSight account.
String accountName
The name of your Amazon QuickSight account.
String directoryType
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
.
String color
The color of the simple cluster marker.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
Long maxVisibleRows
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.
Long maxVisibleColumns
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.
PanelConfiguration panelConfiguration
Configures the display options for each small multiples panel.
Boolean disableSsl
A Boolean option to control whether SSL should be disabled.
DynamicDefaultValue dynamicValue
The dynamic value of the StringDefaultValues
. Different defaults displayed according to users,
groups, and values mapping.
List<E> staticValues
The static values of the DecimalDefaultValues
.
NullValueFormatConfiguration nullValueFormatConfiguration
The options that determine the null value format configuration.
NumericFormatConfiguration numericFormatConfiguration
The formatting configuration for numeric strings.
String parameterValueType
The value type determines whether the parameter is a single-value or multi-value parameter.
String name
The name of the parameter that is being declared.
StringDefaultValues defaultValues
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
StringValueWhenUnsetConfiguration valueWhenUnset
The configuration that defines the default value of a String
parameter when a value has not been
set.
String totalsVisibility
The visibility configuration for the subtotal cells.
String customLabel
The custom label string for the subtotal cells.
String fieldLevel
The field level (all, custom, last) for the subtotal cells.
List<E> fieldLevelOptions
The optional configuration of subtotal cells.
TableCellStyle totalCellStyle
The cell styling options for the subtotal cells.
TableCellStyle valueCellStyle
The cell styling options for the subtotals of value cells.
TableCellStyle metricHeaderCellStyle
The cell styling options for the subtotals of header cells.
String fieldId
The field ID of the cell for conditional formatting.
TextConditionalFormat textFormat
The text format of the cell for conditional formatting.
String tableCellImageScalingConfiguration
The cell scaling configuration of the sizing options for the table image configuration.
String visibility
The visibility of the table cells.
FontConfiguration fontConfiguration
The font configuration of the table cells.
String textWrap
The text wrap (none, wrap) for the table cells.
String horizontalTextAlignment
The horizontal text alignment (left, center, right, auto) for the table cells.
String verticalTextAlignment
The vertical text alignment (top, middle, bottom) for the table cells.
String backgroundColor
The background color for the table cells.
Integer height
The height color for the table cells.
GlobalTableBorderOptions border
The borders for the table cells.
TableCellConditionalFormatting cell
The cell conditional formatting option for a table.
TableRowConditionalFormatting row
The row conditional formatting option for a table.
TableFieldWells fieldWells
The field wells of the visual.
TableSortConfiguration sortConfiguration
The sort configuration for a TableVisual
.
TableOptions tableOptions
The table options for a table visual.
TotalOptions totalOptions
The total options for a table visual.
TableFieldOptions fieldOptions
The field options for a table visual.
TablePaginatedReportOptions paginatedReportOptions
The paginated report options for a table visual.
List<E> tableInlineVisualizations
A collection of inline visualizations to display within a chart.
String icon
The icon set type (link) of the custom icon content for table URL link content.
String value
The string value of the custom text content for the table URL link content.
FontConfiguration fontConfiguration
The font configuration of the custom text content for the table URL link content.
TableCellImageSizingConfiguration sizingOptions
The sizing options for the table image configuration.
String target
The URL target (new tab, new window, same tab) for the table link configuration.
TableFieldLinkContentConfiguration content
The URL content (text, icon) for the table link configuration.
TableFieldCustomTextContent customTextContent
The custom text content (value, font configuration) for the table link content configuration.
TableFieldCustomIconContent customIconContent
The custom icon content for the table link content configuration.
String fieldId
The field ID for a table field.
String width
The width for a table field.
String customLabel
The custom label for a table field.
String visibility
The visibility of a table field.
TableFieldURLConfiguration uRLStyling
The URL configuration for a table field.
TableFieldLinkConfiguration linkConfiguration
The link configuration of a table field URL.
TableFieldImageConfiguration imageConfiguration
The image configuration of a table field URL.
TableAggregatedFieldWells tableAggregatedFieldWells
The aggregated field well for the table.
TableUnaggregatedFieldWells tableUnaggregatedFieldWells
The unaggregated field well for the table.
DataBarsOptions dataBars
The configuration of the inline visualization of the data bars within a chart.
String orientation
The orientation (vertical, horizontal) for a table.
TableCellStyle headerStyle
The table cell style of a table header.
TableCellStyle cellStyle
The table cell style of table cells.
RowAlternateColorOptions rowAlternateColorOptions
The row alternate color options (widget status, row alternate colors) for a table.
ConditionalFormattingColor backgroundColor
The conditional formatting color (solid, gradient) of the background for a table row.
ConditionalFormattingColor textColor
The conditional formatting color (solid, gradient) of the text for a table row.
TableBorderOptions innerVertical
The table border options of the inner vertical border.
TableBorderOptions innerHorizontal
The table border options of the inner horizontal border.
TableBorderOptions left
The table border options of the left border.
TableBorderOptions right
The table border options of the right border.
TableBorderOptions top
The table border options of the top border.
TableBorderOptions bottom
The table border options of the bottom border.
List<E> rowSort
The field sort options for rows in the table.
PaginationConfiguration paginationConfiguration
The pagination configuration (page size, page number) for the table.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
TableConfiguration chartConfiguration
The configuration settings of the visual.
TableConditionalFormatting conditionalFormatting
The conditional formatting for a PivotTableVisual
.
List<E> actions
The list of custom actions that are configured for a visual.
String arn
The Amazon Resource Name (ARN) of the template.
String name
The display name of the template.
TemplateVersion version
A structure describing the versions of the template.
String templateId
The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
Date lastUpdatedTime
Time when this was last updated.
Date createdTime
Time when this was created.
TemplateSourceAnalysis sourceAnalysis
The source analysis, if it is based on an analysis.
TemplateSourceTemplate sourceTemplate
The source template, if it is based on an template.
String arn
The Amazon Resource Name (ARN) of the resource.
String arn
A summary of a template.
String templateId
The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
A display name for the template.
Long latestVersionNumber
A structure containing a list of version numbers for the template summary.
Date createdTime
The last time that this template was created.
Date lastUpdatedTime
The last time that this template was updated.
Date createdTime
The time that this template version was created.
List<E> errors
Errors associated with this template version.
Long versionNumber
The version number of the template version.
String status
The status that is associated with the template.
CREATION_IN_PROGRESS
CREATION_SUCCESSFUL
CREATION_FAILED
UPDATE_IN_PROGRESS
UPDATE_SUCCESSFUL
UPDATE_FAILED
DELETED
List<E> dataSetConfigurations
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.
String description
The description of the template.
String sourceEntityArn
The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
String themeArn
The ARN of the theme associated with this version of the template.
List<E> sheets
A list of the associated sheets with the unique identifier and name of each sheet.
List<E> dataSetConfigurations
An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
List<E> sheets
An array of sheet definitions for a template.
List<E> calculatedFields
An array of calculated field definitions for the template.
List<E> parameterDeclarations
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 in the Amazon QuickSight User Guide.
List<E> filterGroups
Filter definitions for a template.
For more information, see Filtering Data in the Amazon QuickSight User Guide.
List<E> columnConfigurations
An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
AnalysisDefaults analysisDefaults
String arn
The Amazon Resource Name (ARN) of the template version.
Long versionNumber
The version number of the template version.
Date createdTime
The time that this template version was created.
String status
The status of the template version.
String description
The description of the template version.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
TextControlPlaceholderOptions placeholderOptions
The configuration of the placeholder options in a text area control.
ConditionalFormattingColor backgroundColor
The conditional formatting for the text background color.
ConditionalFormattingColor textColor
The conditional formatting for the text color.
ConditionalFormattingIcon icon
The conditional formatting for the icon.
String visibility
The visibility configuration of the placeholder options in a text control.
LabelOptions titleOptions
The options to configure the title visibility, name, and font size.
TextControlPlaceholderOptions placeholderOptions
The configuration of the placeholder options in a text field control.
String arn
The Amazon Resource Name (ARN) of the theme.
String name
The name that the user gives to the theme.
String themeId
The identifier that the user gives to the theme.
ThemeVersion version
Date createdTime
The date and time that the theme was created.
Date lastUpdatedTime
The date and time that the theme was last updated.
String type
The type of theme, based on how it was created. Valid values include: QUICKSIGHT
and
CUSTOM
.
DataColorPalette dataColorPalette
Color properties that apply to chart data colors.
UIColorPalette uIColorPalette
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
SheetStyle sheet
Display options related to sheets.
Typography typography
String arn
The Amazon Resource Name (ARN) of the resource.
String name
the display name for the theme.
String themeId
The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Long latestVersionNumber
The latest version number for the theme.
Date createdTime
The date and time that this theme was created.
Date lastUpdatedTime
The last date and time that this theme was updated.
Long versionNumber
The version number of the theme.
String arn
The Amazon Resource Name (ARN) of the resource.
String description
The description of the theme.
String baseThemeId
The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
Date createdTime
The date and time that this theme version was created.
ThemeConfiguration configuration
The theme configuration, which contains all the theme display properties.
List<E> errors
Errors associated with the theme.
String status
The status of the theme version.
Long versionNumber
The version number of the theme version.
String arn
The Amazon Resource Name (ARN) of the theme version.
String description
The description of the theme version.
Date createdTime
The date and time that this theme version was created.
String status
The status of the theme version.
String requestId
The Amazon Web Services request ID for this request.
GutterStyle gutter
The gutter settings that apply between tiles.
MarginStyle margin
The margin settings that apply around the outside edge of sheets.
BorderStyle border
The border around a tile.
Integer periodsForward
The periods forward setup of a forecast computation.
Integer periodsBackward
The periods backward setup of a forecast computation.
Double upperBoundary
The upper boundary setup of a forecast computation.
Double lowerBoundary
The lower boundary setup of a forecast computation.
Integer predictionInterval
The prediction interval setup of a forecast computation.
Integer seasonality
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.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
Date value
The value of a TimeEquality
filter.
This field is mutually exclusive to ParameterName
.
String parameterName
The parameter whose value should be used for the filter value.
This field is mutually exclusive to Value
.
String timeGranularity
The level of time precision that is used to aggregate DateTime
values.
ColumnIdentifier column
The column that the filter is applied to.
Date rangeMinimum
The minimum value for the filter value range.
Date rangeMaximum
The maximum value for the filter value range.
String timeGranularity
The level of time precision that is used to aggregate DateTime
values.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
Boolean includeMinimum
Determines whether the minimum value in the filter value range should be included in the filtered results.
Boolean includeMaximum
Determines whether the maximum value in the filter value range should be included in the filtered results.
TimeRangeFilterValue rangeMinimumValue
The minimum value for the filter value range.
TimeRangeFilterValue rangeMaximumValue
The maximum value for the filter value range.
String nullOption
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.
ExcludePeriodConfiguration excludePeriodConfiguration
The exclude period of the time range filter.
String timeGranularity
The level of time precision that is used to aggregate DateTime
values.
Date staticValue
The static input value.
RollingDateConfiguration rollingDate
The rolling date input value.
String parameter
The parameter type input value.
FieldTooltipItem fieldTooltipItem
The tooltip item for the fields.
ColumnTooltipItem columnTooltipItem
The tooltip item for the columns that are not part of a field well.
String tooltipVisibility
Determines whether or not the tooltip is visible.
String selectedTooltipType
The selected type for the tooltip. Choose one of the following options:
BASIC
: A basic tooltip.
DETAILED
: A detailed tooltip.
FieldBasedTooltip fieldBasedTooltip
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
String filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
ColumnIdentifier column
The column that the filter is applied to.
Integer limit
The number of items to include in the top bottom filter results.
List<E> aggregationSortConfigurations
The aggregation and sort configuration of the top bottom filter.
String timeGranularity
The level of time precision that is used to aggregate DateTime
values.
String parameterName
The parameter whose value should be used for the filter value.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField time
The time field that is used in a computation.
DimensionField category
The category field that is used in a computation.
MeasureField value
The value field that is used in a computation.
Integer moverSize
The mover size setup of the top and bottom movers computation.
String sortOrder
The sort order setup of the top and bottom movers computation.
String type
The computation type. Choose from the following options:
TOP: Top movers computation.
BOTTOM: Bottom movers computation.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField category
The category field that is used in a computation.
MeasureField value
The value field that is used in a computation.
Integer resultSize
The result size of a top and bottom ranked computation.
String type
The computation type. Choose one of the following options:
TOP: A top ranked computation.
BOTTOM: A bottom ranked computation.
String computationId
The ID for a computation.
String name
The name of a computation.
MeasureField value
The value field that is used in a computation.
String totalsVisibility
The visibility configuration for the total cells.
String placement
The placement (start, end) for the total cells.
String scrollStatus
The scroll status (pinned, scrolled) for the total cells.
String customLabel
The custom label string for the total cells.
TableCellStyle totalCellStyle
Cell styling options for the total cells.
ProjectOperation projectOperation
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
FilterOperation filterOperation
An operation that filters rows based on some condition.
CreateColumnsOperation createColumnsOperation
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
RenameColumnOperation renameColumnOperation
An operation that renames a column.
CastColumnTypeOperation castColumnTypeOperation
A transform operation that casts a column to a different type.
TagColumnOperation tagColumnOperation
An operation that tags a column with additional information.
UntagColumnOperation untagColumnOperation
List<E> groups
The group by field well of a tree map. Values are grouped based on group by fields.
List<E> sizes
The size field well of a tree map. Values are aggregated based on group by fields.
List<E> colors
The color field well of a tree map. Values are grouped by aggregations based on group by fields.
TreeMapFieldWells fieldWells
The field wells of the visual.
TreeMapSortConfiguration sortConfiguration
The sort configuration of a tree map.
ChartAxisLabelOptions groupLabelOptions
The label options (label text, label visibility) of the groups that are displayed in a tree map.
ChartAxisLabelOptions sizeLabelOptions
The label options (label text, label visibility) of the sizes that are displayed in a tree map.
ChartAxisLabelOptions colorLabelOptions
The label options (label text, label visibility) for the colors displayed in a tree map.
ColorScale colorScale
The color options (gradient color, point of divergence) of a tree map.
LegendOptions legend
The legend display setup of the visual.
DataLabelOptions dataLabels
The options that determine if visual data labels are displayed.
TooltipOptions tooltip
The tooltip display setup of the visual.
TreeMapAggregatedFieldWells treeMapAggregatedFieldWells
The aggregated field wells of a tree map.
List<E> treeMapSort
The sort configuration of group by fields.
ItemsLimitConfiguration treeMapGroupItemsLimitConfiguration
The limit on the number of groups that are displayed.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
TreeMapConfiguration chartConfiguration
The configuration settings of the visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
String visibility
The visibility of the trend arrows.
String primaryForeground
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.
String primaryBackground
The background color that applies to visuals and other high emphasis UI.
String secondaryForeground
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
String secondaryBackground
The background color that applies to the sheet background and sheet controls.
String accent
This color is that applies to selected states and buttons.
String accentForeground
The foreground color that applies to any text or other elements that appear over the accent color.
String danger
The color that applies to error messages.
String dangerForeground
The foreground color that applies to any text or other elements that appear over the error color.
String warning
This color that applies to warning and informational messages.
String warningForeground
The foreground color that applies to any text or other elements that appear over the warning color.
String success
The color that applies to success messages, for example the check mark for a successful download.
String successForeground
The foreground color that applies to any text or other elements that appear over the success color.
String dimension
The color that applies to the names of fields that are identified as dimensions.
String dimensionForeground
The foreground color that applies to any text or other elements that appear over the dimension color.
String measure
The color that applies to the names of fields that are identified as measures.
String measureForeground
The foreground color that applies to any text or other elements that appear over the measure color.
String fieldId
The custom field ID.
ColumnIdentifier column
The column that is used in the UnaggregatedField
.
FormatConfiguration formatConfiguration
The format configuration of the field.
String computationId
The ID for a computation.
String name
The name of a computation.
DimensionField category
The category field that is used in a computation.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String awsAccountId
The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
String namespace
The namespace that you want to update Amazon QuickSight customizations for.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
String arn
The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.
String awsAccountId
The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
String namespace
The namespace associated with the customization that you're updating.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
String defaultNamespace
The default namespace for this Amazon Web Services account. Currently, the default is default
.
Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an
email address that becomes associated with the default namespace.
String notificationEmail
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
Boolean terminationProtectionEnabled
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
DeleteAccountSubscription
request. A False
value will allow the account to be deleted.
String awsAccountId
The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.
String analysisId
The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
List<E> grantPermissions
A structure that describes the permissions to add and the principal to add them to.
List<E> revokePermissions
A structure that describes the permissions to remove and the principal to remove them from.
String analysisArn
The Amazon Resource Name (ARN) of the analysis that you updated.
String analysisId
The ID of the analysis that you updated permissions for.
List<E> permissions
A structure that describes the principals and the resource-level permissions on an analysis.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the analysis that you're updating.
String analysisId
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
String name
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
Parameters parameters
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
AnalysisSourceEntity sourceEntity
A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
String themeArn
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
AnalysisDefinition definition
The definition of an analysis.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
String arn
The ARN of the analysis that you're updating.
String analysisId
The ID of the analysis.
String updateStatus
The update status of the last update that was made to the analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
String dashboardId
The ID for the dashboard.
List<E> grantPermissions
The permissions that you want to grant on this resource.
List<E> revokePermissions
The permissions that you want to revoke from this resource.
List<E> grantLinkPermissions
Grants link permissions to all users in a defined namespace.
List<E> revokeLinkPermissions
Revokes link permissions from all users in a defined namespace.
String dashboardArn
The Amazon Resource Name (ARN) of the dashboard.
String dashboardId
The ID for the dashboard.
List<E> permissions
Information about the permissions on the dashboard.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
LinkSharingConfiguration linkSharingConfiguration
Updates the permissions of a shared link to an Amazon QuickSight dashboard.
String awsAccountId
The ID of the Amazon Web Services account that contains the dashboard that you're updating.
String dashboardId
The ID for the dashboard.
String name
The display name of the dashboard.
DashboardSourceEntity sourceEntity
The entity that you are using as a source when you update the dashboard. In SourceEntity
, you
specify the type of object you're using as source. You can only update a dashboard from a template, so you use a
SourceTemplate
entity. If you need to update a dashboard from an analysis, first convert the
analysis to a template by using the
CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template.
The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon
QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets
for the placeholders listed in the original. The schema in each dataset must match its placeholder.
Parameters parameters
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
String versionDescription
A description for the first version of the dashboard being created.
DashboardPublishOptions dashboardPublishOptions
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either
ENABLED
or DISABLED
. When this is set to DISABLED
, Amazon QuickSight
disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This
option is ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either
ENABLED
or DISABLED
. The visual option to export data to .CSV format isn't enabled when
this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either
COLLAPSED
or EXPANDED
. This option is COLLAPSED
by default.
String themeArn
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
DashboardVersionDefinition definition
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
String arn
The Amazon Resource Name (ARN) of the resource.
String versionArn
The ARN of the dashboard, including the version number.
String dashboardId
The ID for the dashboard.
String creationStatus
The creation status of the request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
String dataSetId
The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
List<E> grantPermissions
The resource permissions that you want to grant to the dataset.
List<E> revokePermissions
The resource permissions that you want to revoke from the dataset.
String dataSetArn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSetId
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
The display name for the dataset.
Map<K,V> physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Map<K,V> logicalTableMap
Configures the combination and transformation of the data from the physical tables.
String importMode
Indicates whether you want to import the data into SPICE.
List<E> columnGroups
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Map<K,V> fieldFolders
The folder that contains fields and nested subfolders for your dataset.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the data you want to create.
RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
List<E> columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.
DataSetUsageConfiguration dataSetUsageConfiguration
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String ingestionArn
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String ingestionId
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
List<E> grantPermissions
A list of resource permissions that you want to grant on the data source.
List<E> revokePermissions
A list of resource permissions that you want to revoke on the data source.
String dataSourceArn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
A display name for the data source.
DataSourceParameters dataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
DataSourceCredentials credentials
The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
VpcConnectionProperties vpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
String arn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String updateStatus
The update status of the data source's last update.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder to update.
String folderId
The ID of the folder.
List<E> grantPermissions
The permissions that you want to grant on a resource.
List<E> revokePermissions
The permissions that you want to revoke from a resource.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the folder.
String folderId
The ID of the folder.
List<E> permissions
Information about the permissions for the folder.
String requestId
The Amazon Web Services request ID for this operation.
String groupName
The name of the group that you want to update.
String description
The description for the group that you want to update.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want to update.
String awsAccountId
The ID of the Amazon Web Services account that contains the IAM policy assignment.
String assignmentName
The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.
String namespace
The namespace of the assignment.
String assignmentStatus
The status of the assignment. Possible values are as follows:
ENABLED
- Anything specified in this assignment is used when creating the data source.
DISABLED
- This assignment isn't used when creating the data source.
DRAFT
- This assignment is an unfinished draft and isn't used when creating the data source.
String policyArn
The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon QuickSight users, groups, or both that you want to assign the policy to.
String assignmentName
The name of the assignment or rule.
String assignmentId
The ID of the assignment.
String policyArn
The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
String assignmentStatus
The status of the assignment. Possible values are as follows:
ENABLED
- Anything specified in this assignment is used when creating the data source.
DISABLED
- This assignment isn't used when creating the data source.
DRAFT
- This assignment is an unfinished draft and isn't used when creating the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the IP rules.
Map<K,V> ipRestrictionRuleMap
A map that describes the updated IP rules with CIDR ranges and descriptions.
Boolean enabled
A value that specifies whether IP rules are turned on.
String awsAccountId
The ID of the Amazon Web Services account that contains the template alias that you're updating.
String templateId
The ID for the template.
String aliasName
The alias of the template that you want to update. If you name a specific alias, you update the version that the
alias points to. You can specify the latest version of the template by providing the keyword $LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply to templates.
Long templateVersionNumber
The version number of the template.
TemplateAlias templateAlias
The template alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the template.
String templateId
The ID for the template.
List<E> grantPermissions
A list of resource permissions to be granted on the template.
List<E> revokePermissions
A list of resource permissions to be revoked from the template.
String templateId
The ID for the template.
String templateArn
The Amazon Resource Name (ARN) of the template.
List<E> permissions
A list of resource permissions to be set on the template.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the template that you're updating.
String templateId
The ID for the template.
TemplateSourceEntity sourceEntity
The entity that you are using as a source when you update the template. In SourceEntity
, you specify
the type of object you're using as source: SourceTemplate
for a template or
SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For
SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the
ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and
any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must
match its placeholder.
String versionDescription
A description of the current template version that is being updated. Every time you call
UpdateTemplate
, you create a new version of the template. Each version of the template maintains a
description of the version in the VersionDescription
field.
String name
The name for the template.
TemplateVersionDefinition definition
The definition of a template.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
String templateId
The ID for the template.
String arn
The Amazon Resource Name (ARN) for the template.
String versionArn
The ARN for the template, including the version information of the first version.
String creationStatus
The creation status of the template.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme alias that you're updating.
String themeId
The ID for the theme.
String aliasName
The name of the theme alias that you want to update.
Long themeVersionNumber
The version number of the theme that the alias should reference.
ThemeAlias themeAlias
Information about the theme alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme.
String themeId
The ID for the theme.
List<E> grantPermissions
A list of resource permissions to be granted for the theme.
List<E> revokePermissions
A list of resource permissions to be revoked from the theme.
String themeId
The ID for the theme.
String themeArn
The Amazon Resource Name (ARN) of the theme.
List<E> permissions
The resulting list of resource permissions for the theme.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme that you're updating.
String themeId
The ID for the theme.
String name
The name for the theme.
String baseThemeId
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
String versionDescription
A description of the theme version that you're updating Every time that you call UpdateTheme
, you
create a new version of the theme. Each version of the theme maintains a description of the version in
VersionDescription
.
ThemeConfiguration configuration
The theme configuration, which contains the theme display properties.
String themeId
The ID for the theme.
String arn
The Amazon Resource Name (ARN) for the theme.
String versionArn
The Amazon Resource Name (ARN) for the new version of the theme.
String creationStatus
The creation status of the theme.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String userName
The Amazon QuickSight user name that you want to update.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String email
The email address of the user that you want to update.
String role
The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
String customPermissionsName
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the
profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the
RegisterUser
API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
Boolean unapplyCustomPermissions
A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
String externalLoginFederationProviderType
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the
COGNITO
provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed
when the external provider is custom.
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use
the CustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
NONE
: This clears all the previously saved external login information for a user. Use the
DescribeUser
API operation to check the external login information.
String customFederationProviderUrl
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon
QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when
ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
String externalLoginId
The identity ID for a user in the external login provider.
String format
File format.
Integer startFromRow
A row number to start reading data from.
Boolean containsHeader
Whether the file has a header row, or the files each have a header row.
String textQualifier
Text qualifier.
String delimiter
The delimiter between values in the file.
String arn
The Amazon Resource Name (ARN) for the user.
String userName
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.
String email
The user's email address.
String role
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.
String identityType
The type of identity authentication used by the user.
Boolean active
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.
String principalId
The principal ID of the user.
String customPermissionsName
The custom permissions profile associated with this user.
String externalLoginFederationProviderType
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.
String externalLoginFederationProviderUrl
The URL of the external login provider.
String externalLoginId
The identity ID for the user in the external login provider.
PercentVisibleRange percentRange
The percent range in the visible range.
TableVisual tableVisual
A table visual.
For more information, see Using tables as visuals in the Amazon QuickSight User Guide.
PivotTableVisual pivotTableVisual
A pivot table.
For more information, see Using pivot tables in the Amazon QuickSight User Guide.
BarChartVisual barChartVisual
A bar chart.
For more information, see Using bar charts in the Amazon QuickSight User Guide.
KPIVisual kPIVisual
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide.
PieChartVisual pieChartVisual
A pie or donut chart.
For more information, see Using pie charts in the Amazon QuickSight User Guide.
GaugeChartVisual gaugeChartVisual
A gauge chart.
For more information, see Using gauge charts in the Amazon QuickSight User Guide.
LineChartVisual lineChartVisual
A line chart.
For more information, see Using line charts in the Amazon QuickSight User Guide.
HeatMapVisual heatMapVisual
A heat map.
For more information, see Using heat maps in the Amazon QuickSight User Guide.
TreeMapVisual treeMapVisual
A tree map.
For more information, see Using tree maps in the Amazon QuickSight User Guide.
GeospatialMapVisual geospatialMapVisual
A geospatial map or a points on map visual.
For more information, see Creating point maps in the Amazon QuickSight User Guide.
FilledMapVisual filledMapVisual
A filled map.
For more information, see Creating filled maps in the Amazon QuickSight User Guide.
FunnelChartVisual funnelChartVisual
A funnel chart.
For more information, see Using funnel charts in the Amazon QuickSight User Guide.
ScatterPlotVisual scatterPlotVisual
A scatter plot.
For more information, see Using scatter plots in the Amazon QuickSight User Guide.
ComboChartVisual comboChartVisual
A combo chart.
For more information, see Using combo charts in the Amazon QuickSight User Guide.
BoxPlotVisual boxPlotVisual
A box plot.
For more information, see Using box plots in the Amazon QuickSight User Guide.
WaterfallVisual waterfallVisual
A waterfall chart.
For more information, see Using waterfall charts in the Amazon QuickSight User Guide.
HistogramVisual histogramVisual
A histogram.
For more information, see Using histograms in the Amazon QuickSight User Guide.
WordCloudVisual wordCloudVisual
A word cloud.
For more information, see Using word clouds in the Amazon QuickSight User Guide.
InsightVisual insightVisual
An insight visual.
For more information, see Working with insights in the Amazon QuickSight User Guide.
SankeyDiagramVisual sankeyDiagramVisual
A sankey diagram.
For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
CustomContentVisual customContentVisual
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon QuickSight User Guide.
EmptyVisual emptyVisual
An empty visual.
String customActionId
The ID of the VisualCustomAction
.
String name
The name of the VisualCustomAction
.
String status
The status of the VisualCustomAction
.
String trigger
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.
List<E> actionOperations
A list of VisualCustomActionOperations
.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
CustomActionFilterOperation filterOperation
The filter operation that filters data included in a visual or in an entire sheet.
CustomActionNavigationOperation navigationOperation
The navigation operation that navigates between different sheets in the same analysis.
CustomActionURLOperation uRLOperation
The URL operation that opens a link to another webpage.
CustomActionSetParametersOperation setParametersOperation
The set parameter operation that sets parameters in custom action.
String visibility
The visibility of the subtitle label.
LongFormatText formatText
The long text format of the subtitle label, such as plain text or rich text.
String visibility
The visibility of the title label.
ShortFormatText formatText
The short text format of the title label, such as plain text or rich text.
String vpcConnectionArn
The Amazon Resource Name (ARN) for the VPC connection.
WaterfallChartFieldWells fieldWells
The field well configuration of a waterfall visual.
WaterfallChartSortConfiguration sortConfiguration
The sort configuration of a waterfall visual.
WaterfallChartOptions waterfallChartOptions
The options that determine the presentation of a waterfall visual.
ChartAxisLabelOptions categoryAxisLabelOptions
The options that determine the presentation of the category axis label.
AxisDisplayOptions categoryAxisDisplayOptions
The options that determine the presentation of the category axis.
ChartAxisLabelOptions primaryYAxisLabelOptions
The options that determine the presentation of the y-axis label.
AxisDisplayOptions primaryYAxisDisplayOptions
The options that determine the presentation of the y-axis.
LegendOptions legend
The legend configuration of a waterfall visual.
DataLabelOptions dataLabels
The data label configuration of a waterfall visual.
VisualPalette visualPalette
The visual palette configuration of a waterfall visual.
WaterfallChartAggregatedFieldWells waterfallChartAggregatedFieldWells
The field well configuration of a waterfall visual.
String totalBarLabel
This option determines the total bar label of a waterfall visual.
List<E> categorySort
The sort configuration of the category fields.
ItemsLimitConfiguration breakdownItemsLimit
The limit on the number of bar groups that are displayed.
String visualId
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.
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
WaterfallChartConfiguration chartConfiguration
The configuration for a waterfall visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
WordCloudFieldWells fieldWells
The field wells of the visual.
WordCloudSortConfiguration sortConfiguration
The sort configuration of a word cloud visual.
ChartAxisLabelOptions categoryLabelOptions
The label options (label text, label visibility, and sort icon visibility) for the word cloud category.
WordCloudOptions wordCloudOptions
The options for a word cloud visual.
WordCloudAggregatedFieldWells wordCloudAggregatedFieldWells
The aggregated field wells of a word cloud.
String wordOrientation
The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
String wordScaling
The word scaling options (emphasize, normal) for the words in a word cloud.
String cloudLayout
The cloud layout options (fluid, normal) of a word cloud.
String wordCasing
The word casing options (lower_case, existing_case) for the words in a word cloud.
String wordPadding
The word padding options (none, small, medium, large) for the words in a word cloud.
Integer maximumStringLength
The length limit of each word from 1-100.
ItemsLimitConfiguration categoryItemsLimit
The limit on the number of groups that are displayed in a word cloud.
List<E> categorySort
The sort configuration of group by fields.
String visualId
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..
VisualTitleLabelOptions title
The title that is displayed on the visual.
VisualSubtitleLabelOptions subtitle
The subtitle that is displayed on the visual.
WordCloudChartConfiguration chartConfiguration
The configuration settings of the visual.
List<E> actions
The list of custom actions that are configured for a visual.
List<E> columnHierarchies
The column hierarchy that is used during drill-downs and drill-ups.
Copyright © 2023. All rights reserved.