2023/10/19 - Amazon QuickSight - 20 updated api methods
Changes This release adds the following: 1) Trino and Starburst Database Connectors 2) Custom total for tables and pivot tables 3) Enable restricted folders 4) Add rolling dates for time equality filters 5) Refine DataPathValue and introduce DataPathType 6) Add SeriesType to ReferenceLineDataConfiguration
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}},
'FolderArns': ['string']}
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition .
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}},
'FolderArns': ['string']}
Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'FolderArns': ['string']}
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
See also: AWS API Documentation
Request Syntax
client.create_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
FieldFolders={
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
RowLevelPermissionTagConfiguration={
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
DatasetParameters=[
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
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
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) -- [REQUIRED]
A physical table type for an S3 data source.
Note
For files that aren't JSON, only STRING data types are supported in input columns.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
dict
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) -- [REQUIRED]
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
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.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging.
Note
This is not tags for the Amazon Web Services tagging feature.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
TagNames (list) -- [REQUIRED]
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) -- [REQUIRED]
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
The operand on the left side of a join.
RightOperand (string) -- [REQUIRED]
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
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.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
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.
Type (string) -- [REQUIRED]
The type of join that it is.
OnClause (string) -- [REQUIRED]
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
list
A list of resource permissions on the dataset.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
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.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
The row-level security configuration for the data that you want to create.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
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.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
dict
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED . If disabled, the status is DISABLED .
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
list
A set of one or more definitions of a ColumnLevelPermissionRule .
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
list
The parameter declarations of the dataset.
(dict) --
A dataset parameter.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the string parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the string parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the decimal parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the decimal parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the integer parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the integer parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the date time parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value .
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
list
When you create the dataset, Amazon QuickSight adds the dataset to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
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.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}},
'DataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY | '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}},
'FolderArns': ['string']}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources .
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
dict
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see CredentialPair .
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
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.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
CopySourceArn (string) --
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.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
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.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
list
When you create the data source, Amazon QuickSight adds the data source to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'FolderType': {'RESTRICTED'}}
Creates an empty shared folder.
See also: AWS API Documentation
Request Syntax
client.create_folder(
AwsAccountId='string',
FolderId='string',
Name='string',
FolderType='SHARED'|'RESTRICTED',
ParentFolderArn='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SharingModel='ACCOUNT'|'NAMESPACE'
)
string
[REQUIRED]
The ID for the Amazon Web Services account where you want to create the folder.
string
[REQUIRED]
The ID of the folder.
string
The name of the folder.
string
The type of folder. By default, folderType is SHARED .
string
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
list
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions .
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
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.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
list
Tags for the folder.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
string
An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT .
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'FolderId': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) for the newly created folder.
FolderId (string) --
The folder ID for the newly created folder.
RequestId (string) --
The request ID for the newly created folder.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Provides a detailed description of the definition of an analysis.
Note
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}}}
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the import job was executed in.
string
[REQUIRED]
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'RollbackErrors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleImportJobId': 'string',
'AwsAccountId': 'string',
'AssetBundleImportSource': {
'Body': 'string',
'S3Uri': 'string'
},
'OverrideParameters': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string'
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
]
},
'FailureAction': 'DO_NOTHING'|'ROLLBACK',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:
SUCCESSFUL
FAILED
FAILED_ROLLBACK_COMPLETED
FAILED_ROLLBACK_ERROR
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
RollbackErrors (list) --
An array of error records that describes any failures that occurred while an import job was attempting a rollback.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
CreatedTime (datetime) --
The time that the import job was created.
AssetBundleImportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account the import job was executed in.
AssetBundleImportSource (dict) --
The source of the asset bundle zip file that contains the data that is imported by the job.
Body (string) --
An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
S3Uri (string) --
The Amazon S3 URI that you provided at the start of the import job.
OverrideParameters (dict) --
Optional overrides to be applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) --
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) --
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) --
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule . Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) --
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) --
The username for the data source connection.
Password (string) --
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) --
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) --
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) --
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) --
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
FailureAction (string) --
The failure action for the import job.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Provides a detailed description of the definition of a dashboard.
Note
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'DataSource': {'AlternateDataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}},
'DataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'DataSource': {
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSource (dict) --
The information on the data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
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.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
AlternateDataSourceParameters (list) --
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.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
VpcConnectionProperties (dict) --
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.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Folder': {'FolderType': {'RESTRICTED'}}}
Describes a folder.
See also: AWS API Documentation
Request Syntax
client.describe_folder(
AwsAccountId='string',
FolderId='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
string
[REQUIRED]
The ID of the folder.
dict
Response Syntax
{
'Status': 123,
'Folder': {
'FolderId': 'string',
'Arn': 'string',
'Name': 'string',
'FolderType': 'SHARED'|'RESTRICTED',
'FolderPath': [
'string',
],
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'SharingModel': 'ACCOUNT'|'NAMESPACE'
},
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Folder (dict) --
Information about the folder.
FolderId (string) --
The ID of the folder.
Arn (string) --
The Amazon Resource Name (ARN) for the folder.
Name (string) --
A display name for the folder.
FolderType (string) --
The type of folder it is.
FolderPath (list) --
An array of ancestor ARN strings for the folder.
(string) --
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
SharingModel (string) --
The sharing scope of the folder.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Provides a detailed description of the definition of a template.
Note
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
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
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
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.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'DataSources': {'AlternateDataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}},
'DataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}}
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSources': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSources (list) --
A list of data sources.
(dict) --
The structure of a data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
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.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
AlternateDataSourceParameters (list) --
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.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
VpcConnectionProperties (dict) --
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.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'FolderSummaryList': {'FolderType': {'RESTRICTED'}}}
Lists all folders in an account.
See also: AWS API Documentation
Request Syntax
client.list_folders(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED'|'RESTRICTED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'SharingModel': 'ACCOUNT'|'NAMESPACE'
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderSummaryList (list) --
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
(dict) --
A summary of information about an existing Amazon QuickSight folder.
Arn (string) --
The Amazon Resource Name (ARN) of the folder.
FolderId (string) --
The ID of the folder.
Name (string) --
The display name of the folder.
FolderType (string) --
The type of folder.
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
SharingModel (string) --
The sharing scope of the folder.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'FolderSummaryList': {'FolderType': {'RESTRICTED'}}}
Searches the subfolders in a folder.
See also: AWS API Documentation
Request Syntax
client.search_folders(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'PARENT_FOLDER_ARN'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'FOLDER_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
list
[REQUIRED]
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" } ] .
(dict) --
A filter to use to search an Amazon QuickSight folder.
Operator (string) --
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 .
Name (string) --
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.
Value (string) --
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
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED'|'RESTRICTED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'SharingModel': 'ACCOUNT'|'NAMESPACE'
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderSummaryList (list) --
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
(dict) --
A summary of information about an existing Amazon QuickSight folder.
Arn (string) --
The Amazon Resource Name (ARN) of the folder.
FolderId (string) --
The ID of the folder.
Name (string) --
The display name of the folder.
FolderType (string) --
The type of folder.
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
SharingModel (string) --
The sharing scope of the folder.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create" , "describe" , and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string',
AssetBundleImportSource={
'Body': b'bytes',
'S3Uri': 'string'
},
OverrideParameters={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string'
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
]
},
FailureAction='DO_NOTHING'|'ROLLBACK'
)
string
[REQUIRED]
The ID of the Amazon Web Services account to import assets into.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
dict
[REQUIRED]
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
Body (bytes) --
The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.
S3Uri (string) --
The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20 MB.
dict
Optional overrides to be applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) -- [REQUIRED]
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule . Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) -- [REQUIRED]
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) -- [REQUIRED]
The username for the data source connection.
Password (string) -- [REQUIRED]
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) -- [REQUIRED]
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) -- [REQUIRED]
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) -- [REQUIRED]
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
string
The failure action for the import job.
If you choose ROLLBACK , failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING , failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleImportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
AssetBundleImportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Updates a dashboard in an Amazon Web Services account.
Note
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY '
'| '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}},
'DataSourceParameters': {'StarburstParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer',
'ProductType': 'GALAXY | '
'ENTERPRISE'},
'TrinoParameters': {'Catalog': 'string',
'Host': 'string',
'Port': 'integer'}}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string'
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string'
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE'
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string'
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that Amazon QuickSight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
dict
The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see CredentialPair .
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
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.
(dict) --
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
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.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
DatabaseUser (string) -- [REQUIRED]
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
CopySourceArn (string) --
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.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
dict
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'FilterGroups': {'Filters': {'TimeEqualityFilter': {'RollingDate': {'DataSetIdentifier': 'string',
'Expression': 'string'}}}},
'Sheets': {'Visuals': {'BarChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'BoxPlotVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ComboChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'FunnelChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GaugeChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'GeospatialMapVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'HistogramVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'LineChartVisual': {'ChartConfiguration': {'ReferenceLines': {'DataConfiguration': {'SeriesType': 'BAR '
'| '
'LINE'}},
'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PieChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'PivotTableVisual': {'ChartConfiguration': {'FieldOptions': {'CollapseStateOptions': {'Target': {'FieldDataPathValues': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'DataPathOptions': {'DataPathList': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}},
'SortConfiguration': {'FieldSortOptions': {'SortBy': {'DataPath': {'SortPaths': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TotalOptions': {'ColumnTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]},
'RowTotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}}},
'RadarChartVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}},
'TableVisual': {'ChartConfiguration': {'TotalOptions': {'TotalAggregationOptions': [{'FieldId': 'string',
'TotalAggregationFunction': {'SimpleTotalAggregationFunction': 'DEFAULT '
'| '
'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'NONE'}}]}}},
'WaterfallVisual': {'ChartConfiguration': {'VisualPalette': {'ColorMap': {'Element': {'DataPathType': {'PivotTableDataPathType': 'HIERARCHY_ROWS_LAYOUT_COLUMN '
'| '
'MULTIPLE_ROW_METRICS_COLUMN '
'| '
'EMPTY_COLUMN_HEADER '
'| '
'COUNT_METRIC_COLUMN'}}}}}}}}}}
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateId (string) --
The ID for the template.
Arn (string) --
The Amazon Resource Name (ARN) for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
CreationStatus (string) --
The creation status of the template.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.